今年会社でのレビューで話した事

今年会社でのレビ今年会社でのレビューで話した事ューで話した事銀座 Rails #16 Dec
13, 2019

⾃⼰紹介⾃⼰紹介

@ryosuke_sato

サトウリョウスケサトウリョウスケ株式会社フィードフォースソーシャル PLUS バックエンドエンジニア開発リーダー

今年の振り返り今年の振り返り

銀座 RAILS に 3 回登壇しました銀座 RAILS に 3 回登壇しました
銀座 Rails #07, Mar. 26 rubocop_challenger という gem を作った銀座 Rails #10, June 21 My API Client 銀座 Rails #16, Dec. 13 今年会社でのレビューで話した事 ← New!!!

RUBOCOP_CHALLENGER という GEM を RUBOCOP_CHALLENGER という GEM を作った (#07)
作った (#07) https://github.com/ryz310/rubocop_challenger

MY API CLIENT (#10) MY API CLIENT (#10) class ExampleApiClient
< MyApiClient::Base endpoint 'https://example.com/v1' error_handling status_code: 200, json: { '$.errors.code': 10 }, raise: MyApiClient::ClientError attr_reader :access_token def initialize(access_token:) @access_token = access_token end # GET https://example.com/v1/users def get_users(condition:) https://github.com/ryz310/my_api_client

来年も登壇がんばりたい

今⽇話すこと今⽇話すこと

今年会社でのレビューで話した事今年会社でのレビューで話した事

クラスの設計がムズいという声を受けて会社の勉強会では 45 分 x 2 回話した今⽇はその中から⼀部を抜粋して持ってきました

1. 抽象度を揃える 2. 継承について考える 3. 現実から学ぶ

1. 抽象度を揃える 1. 抽象度を揃える

Q. これは何でしょう？トマトとモッツアレラチーズのサラダ娼婦⾵スパゲティ⼦⽺背⾁のリンゴソースかけプリン

A. トニオさんのレストランのメニュー

例えばこの美味しそうなスパゲティを

仗助に材料別のところまでもどされると

いきなり違和感が出てきたトマトとモッツアレラチーズのサラダスパゲティ茹でてニンニクと唐⾟⼦とプチトマトを良い感じに炒めて絡める ← ⼦⽺背⾁のリンゴソースかけプリン

▶ 抽象度を揃えよう材料と調理⽅法について知っているのはトニオさん（シェフ）だけで良いはずこのクラスを扱う⼈はどのようなレベル感で対象を知っているべきなのかを考えよう ※ 抽象化の⽅法はクラス化する、メソッド化する、とかです。

抽象度が揃わないよくあるケースワンライナーだからメソッド化しなかったの条件式だから ( 略 ) 単純な処理だから ( 略 )

処理が短くても抽象化すると⾒えてくる事があります。

イタリアンの中に唐揚げ？？？トマトとモッツアレラチーズのサラダ娼婦⾵スパゲティ若鶏の唐揚げ ← プリン

抽象化されてないとちょっと気付きづらいかもトマトとモッツアレラチーズをスライスして特製ドレッシングをかけるスパゲティ茹でてニンニクと唐⾟⼦とプチトマトを良い感じに炒めて絡めるチキンに下味をつけて油で揚げるプッチンする

抽象度を揃えるメリットクラスが単⼀責任の原則に従っているかどうかを確認しやすくなる可読性が上がるリファクタリングしやすくなる

レビュー依頼に出す前に抽象度が揃っているか確認しよう

抽象度の揃ってないコードでレビュー依頼に出してきたら …

2. 継承について考える 2. 継承について考える

クラスの継承にはいくつかのパターンがあると思います。

Interface Pattern Layer Pattern DSL Pattern and so on.

それっぽい名前つけましたが僕が勝⼿に呼んでるだけです

結論から先に⾔うと

⾊んな継承パターン混ぜて使うのはやめた⽅が良いです

INTERFACE PATTERN INTERFACE PATTERN

クラスの使い⽅を規格化するための継承。⾝近な例だと Ruby webserver interface の。 Rack

def call(env) [ 200, # (Integer) { 'Content-Type' => 'text/plain'
}, # (Hash) ['Hello World'] # (String ] end

Rack の規格（簡略版）メソッドを定義すること引数を受け取ること戻り値は

楽器やってない⼈にはさっぱりかもですが、エレキギターのエフェクターは分かりやすい例だと思います

規格が揃っているから⾊んなメーカーのエフェクターを同じように組み合わせられる

LAYER PATTERN LAYER PATTERN

OSI 参照モデルと同じような考え⽅。継承の階層ごとに扱う問題を分ける。

例えば JWT で認証するような API を作っている時。

ヘッダから JWT を検証する処理はで実装する。 class ApplicationController < ActionController::API before_action :verify_authentication_header
def verify_authentication_header decode_authentication_header rescue InvalidAuthenticationScheme render status: :bad_request rescue VerificationFailed, Expired render status: :unauthorized end end

継承先の⼦クラスでは JWT 認証の事は考えずに済む。 class SomeController < ApplicationController def index end
def show end end

DSL PATTERN DSL PATTERN

⾝近な例だと ActiveRecord とか。 class Company < ApplicationRecord has_many :employees validates
:name, presence: true scope :xxx end

親クラスを継承することで DSL ( ドメイン固有⾔語 ) が使えるようになる、というパターン。

拙作のも DSL Pattern です（宣伝） class ExampleApiClient < MyApiClient::Base endpoint
'https://example.com/v1' error_handling status_code: 200, json: { '$.errors.code': 10 }, raise: MyApiClient::ClientError https://github.com/ryz310/my_api_client

3 つのパターンをご紹介しましたが、親クラスに複数のパターンが適⽤されている場合は責務を負い過ぎている可能性があります。

特に DSL パターンはみんな (?) やりたがりますが、プロダクトのコードではやらない⽅が良いと思います。

どうしてもやりたい場合は gem にしましょう

3. 現実から学ぶ 3. 現実から学ぶ

世の中の事象は設計に役⽴つ事が多い世の中の事象は設計に役⽴つ事が多い

⽔道は蛇⼝を右にひねれば⽔が⽌まる

右利きの⼈間の割合が世の中的に多い右腕は右にひねる⽅が得意⽔を⽌める事の⽅がやりやすい UI の⽅が安全

▶ 突き詰めて考えれば、⾃ずと仕様が決定される

時計は少しずつ早い時間にずれていく⏳

時計の誤差は少しずつ蓄積されていく早まる⽅向に誤差を貯めた⽅が事故を防ぐことに繋がりやすい（電波時計が無かった頃の話ね）

▶ どうやってもズレる事を防げないのであれば、安全な⽅向に倒す

普段から⽇常を観察しておくとこういう知識が仕様決める時に役に⽴つ（かも）

他にも話したい事はたくさんありますが、時間がないのでブログに書きます

ちなみにブログはまだ開設すらしてません（来年の⽬標です）

今年も⼀年お世話に今年も⼀年お世話になりましたなりました

来年も宜しくお願い来年も宜しくお願い致します致します END

今年 会社でのレビューで話した事

今年 会社でのレビューで話した事

More Decks by Ryz310

Other Decks in Programming

Featured

Transcript

今年会社でのレビューで話した事

今年会社でのレビューで話した事