addとeditのコードは分けるべき？統一するべき？

Tweet

質問1

CakePHP4でbakeコマンドを使うとadd,edit,delete,indexのテンプレートが作成されます。
addとeditは大抵が類似した処理であるため、一つのファイルにまとめたほうが良いのではないかという意見があります。
とはいえ、bakeコマンドがわざわざaddとeditで分けるにはそれなりに理由があると思います。
どう考えたらよいですか？

質問1への回答

CakePHP4のbakeコマンドがaddとeditのテンプレートを分けて生成する理由には、いくつかの重要な要素があります。それぞれの操作には異なる要件やユースケースがあるため、分けておくことでコードの可読性や保守性が向上することが考えられます。

addとeditを分ける理由

1. 異なるバリデーションやロジック

   • 新規追加（add）と編集（edit）では、バリデーションルールやビジネスロジックが異なることがよくあります。例えば、IDの自動生成や初期値の設定など、新規作成時にのみ必要な処理があります。

2. ユーザーインターフェースの違い

   • 新規作成フォームと編集フォームでは、ユーザーが期待するインターフェースが異なる場合があります。例えば、編集フォームでは既存のデータが表示される必要がありますが、新規作成フォームではそうではありません。

3. URLやルーティングの違い

   • 通常、addとeditは異なるURLやルートを持つため、それぞれの操作に対して異なるコントローラーアクションを持つのが自然です。これにより、URL構造が明確になり、SEOやアクセス管理がしやすくなります。

まとめる場合の利点と注意点

利点:
- コードの重複を減らすことができる。
- 一つのテンプレートで両方の操作をカバーするため、コードの統一性が保たれる。

注意点:
- ロジックが複雑化する可能性がある。addとeditの処理を一つのファイルにまとめると、それぞれの操作に応じた条件分岐や追加のロジックが必要になるため、コードが見づらくなる恐れがあります。
- バリデーションやフォームの違いを適切にハンドリングする必要がある。例えば、既存データのロードやバリデーションルールの適用が複雑になることがあります。

考え方の提案

1. 再利用可能なコンポーネントの作成

   • 共通のロジックやバリデーションを再利用可能なメソッドやコンポーネントとして切り出すことで、コードの重複を減らしながら、addとeditを分けて管理することができます。

2. 状況に応じたアプローチの選択

   • プロジェクトの規模や要件に応じて、どちらのアプローチが適しているかを判断します。小規模なプロジェクトやシンプルなCRUD操作ではまとめることが有効かもしれませんが、大規模なプロジェクトや複雑なビジネスロジックが必要な場合は、分けて管理する方が適しています。

以上の点を考慮し、プロジェクトの特性や要件に応じた最適なアプローチを選択することをお勧めします。

質問2

コーディング規約に、addとeditは分けるような記載はありますか？

質問2への回答

CakePHP自体の公式コーディング規約には、addとeditのテンプレートを分けることに関する具体的な記載はありませんが、CakePHPの一般的な慣習やベストプラクティスに従うことが推奨されています。以下は、CakePHPの公式コーディング規約や一般的なベストプラクティスに関する情報です。

CakePHP公式コーディング規約

CakePHPの公式ドキュメントには、特定のコーディング規約やベストプラクティスが記載されていますが、テンプレートの分割に関する明確なガイドラインはありません。しかし、一般的には以下のようなポイントが重要視されています。

1. 可読性と保守性の確保

   • コードの可読性を高め、保守しやすい構造にすることが推奨されています。これには、各機能ごとにテンプレートやコントローラーを分けることも含まれます。

2. シングルレスポンシビリティ原則の遵守

   • 各アクションやテンプレートが単一の責任を持つようにすることで、コードの複雑性を減らし、バグを防ぐことができます。addとeditは異なる操作であり、異なる責任を持つため、分けることが理にかなっています。

3. コードの再利用

   • 共通のコードは再利用可能なコンポーネントやメソッドとして抽出することが推奨されています。addとeditに共通する部分は、別のメソッドやコンポーネントとして分離することができます。

ベストプラクティス

CakePHPやその他のMVCフレームワークにおける一般的なベストプラクティスとして、以下の点が挙げられます。

• 各アクションに対する専用のテンプレート

  • 各アクション（add、edit、view、delete）に対して専用のテンプレートを用意することで、各操作に対するUIやロジックの違いを明確にすることができます。

• コードの分割と再利用

  • 共通のロジックはヘルパーやコンポーネントとして分割し、再利用することが推奨されます。これにより、コードの重複を減らし、メンテナンス性を向上させることができます。

• 適切な命名とフォルダ構造

  • ファイルやフォルダの命名規則を統一し、わかりやすい構造にすることで、プロジェクト全体の可読性と保守性が向上します。

まとめ

CakePHPの公式コーディング規約において、addとeditを分けることに関する明確な記載はないものの、一般的なベストプラクティスに基づくと、分けることが推奨されます。これは、コードの可読性、保守性、責任の明確化に寄与するためです。一方で、プロジェクトの要件や規模に応じて、適切な方法を選択することが重要です。

感想

修正するときに、addを修正したら、気づかない所でeditにも影響が出ていた、なんてことはありそうですね。
つまり、デグレードしやすいコードになってしまう。
役割によってコードは分けておくべきですね。