What we learned from code review

Transcript

1. 永和のコードレビューから学んだ新人が語る Railsアプリケーションで押さえるべきポイント （株）永和システムマネジメント 亀澤 尚志 (@hisas) / 沼田 周(@swamp09) Rails Developers Meetup 2018: Day 1 2018/03/24(土)
2. 永和のコードレビューから学んだ新人が語る Railsアプリケーションで押さえるべきポイント （株）永和システムマネジメント 亀澤 尚志 (@hisas) / 沼田 周(@swamp09) Rails Developers Meetup 2018: Day 1 2018/03/24(土)
3. 会社紹介
4. イベントへの参加補助
6. https://www.wantedly.com/companies/esminc
7. 永和のコードレビューから学んだ新人が語る Railsアプリケーションで押さえるべきポイント （株）永和システムマネジメント 亀澤 尚志 (@hisas) / 沼田 周(@swamp09) Rails Developers Meetup 2018: Day 1 2018/03/24(土)
8. 自己紹介 名前: 亀澤 尚志 GitHub: hisas Rails歴 1年半 名前: 沼田 周 GitHub: swamp09 Rails歴 1年
9. 永和のコードレビューから学んだ新人が語る Railsアプリケーションで押さえるべきポイント （株）永和システムマネジメント 亀澤 尚志 (@hisas) / 沼田 周(@swamp09) Rails Developers Meetup 2018: Day 1 2018/03/24(土)
10. 諸注意 - 実際のプロジェクトであったレビューですが、一部改変しています。 - 解釈など間違っている部分があればご指摘ください。 - 永和の1プロジェクトのお話です。
12. 目次 - パフォーマンス改善 - リーダブルコード - メンテナンス - エラーハンドリング
13. パフォーマンス改善
14. N+1 - eager_loading を使ってクエリ回数を最小限にする - rails server のログをチェックする習慣を付ける
15. 余計なインスタンス生成 - データ有無の確認は余計なインスタンスを生成しない exists? を使う
16. ループ中のDBアクセス - ループ中で何度もDBにアクセスするとかなり重くなる - Oracle の場合、SQLのIN句に入れられるのは一度に1000件
17. count, length, size の使い分け - count はSQLを発行して数え上げるのでレコード取得時は length, size を使う - count はレコード取得は不要で、件数のみの場合に使う
18. any? と empty? - AR の empty? はレコード取得前ではCOUNT方式のSQLを発 行する - 気になったら Rails の中のコードを読んでみる
19. 遅延評価 - lazy メソッドにより遅延評価して無駄な処理を避ける https://github.com/holiday-jp/holiday_jp-ruby
20. インデックス - データ量が多く、よく検索が行われる箇所はインデックスを貼 るとよい - インデックスの書き込みに時間がかかるので注意
21. リーダブルコード
22. 命名規則 - 省略した名前は読み手に負荷がかかるので絶対に使わない - 下手に抽象化するとメソッド名と中身が乖離してしまう
23. コーディング規約 - メンテナンスする上でスタイルが統一されていることは大切 - PRの本質ではない細かい所で指摘を受けないようにする
24. 条件式 - unless で複数条件は読みにくく頭を使うので避ける
25. DRY - 二カ所以上で重複しているものを一つにまとめることで変更漏 れを無くす
26. メンテナンス
27. データ変更処理をmigrationに書かない - マイグレーションでモデルを使用するのは危険
28. ロールバック - change だと、rollback できないものもある - up、downと使い分ける必要がある
29. OSS へのモンキーパッチ - モンキーパッチを当てるより、本家リポジトリにPRを送ってそ のブランチを使用した方が良い - 将来マージされる可能性があり、メンテナンスしやすい - 特定の言語のライブラリに限らない
30. エラーハンドリング
31. updateとupdate! - update! は内部でsave!を呼び出している - update! は例外を投げるため。失敗時に気づける
32. コールバックがスキップされる - コールバックされないメソッドがある - されないことを理解した上で十分気をつけて使用する - updated_at が更新されないので、更新したい場合は自分で 書く必要がある
33. 良いエラーメッセージ - エラーメッセージは、あとで追跡調査をしやすいように
34. https://www.wantedly.com/companies/esminc