Laravelを使用した開発においてこれは心掛けたい、というガイドがあったらいいなあと、思っていたら、ありました。
オリジナルは英語ですが、日本語訳あります。
https://github.com/alexeymezenin/laravel-best-practices/blob/master/japanese.md
- 単一責任の原則
- ファットモデル, スキニーコントローラ
- バリデーション
- ビジネスロジックはサービスクラスの中に書く
- 繰り返し書かない (DRY)
- クエリビルダや生のSQLクエリよりもEloquentを優先して使い、配列よりもコレクションを優先する
- マスアサインメント
- Bladeテンプレート内でクエリを実行しない。Eager Lodingを使う(N + 1問題)
- コメントを書く。ただしコメントよりも説明的なメソッド名と変数名を付けるほうが良い
- JSとCSSをBladeテンプレートの中に入れない、PHPクラスの中にHTMLを入れない
- コード内の文字列の代わりにconfigファイルとlanguageのファイル、定数を使う
- コミュニティに受け入れられた標準のLaravelツールを使う
- Laravelの命名規則に従う
- できるだけ短く読みやすい構文で書く
- newの代わりにIoCコンテナもしくはファサードを使う
- .envファイルのデータを直接参照しない
- 日付を標準フォーマットで保存する。アクセサとミューテータを使って日付フォーマットを変更する
- その他 グッドプラクティス
新年を迎えて、できるだけ実行したいと思っています。