質問をすることでしか得られない、回答やアドバイスがある。

15分調べてもわからないことは、質問しよう!

ただいまの
回答率

88.58%

フレームワーク controllerの単位について

解決済

回答 2

投稿 編集

  • 評価
  • クリップ 0
  • VIEW 876
退会済みユーザー

退会済みユーザー

phpをメインにfuelphp,cakephp,laravelなどいくつかフレームワークを使った開発経験があるのですが
controllerの単位について悩んでいます。

プロジェクトや設計思想によってその定義はバラバラだと思いますが
例えばUserController1つに取って考えてみてもかなり吟味するパターンがいくつかあります。

例えば以下の行動(アクション)です。

  • システム利用のために会員登録する
  • システム利用のためにメール認証して本人確認を済ませる
  • ログインする
  • ユーザー名を変える
  • メールアドレスを変更する
  • パスワードを変更する

これらはUserに関する行動なので個人的にはUserControllerに対応するアクションを定義すべきかと思っています。

ログインするはユーザーが行なっているのではなくシステムが行なっているからLoginControllerとずべきだ、という人もいるかもしれません。

Laravelの場合だと、ログインとログアウト ユーザー登録 パスワードの再発行 パスワードリセットの4コントローラーがAuthで束ねられていますが、私はこれを全部分解し、UserControllerに移行しました。

次は以下です。(laravelを扱いなれています、、、)

  • 掲示板に求人の募集を投稿する(create, store)
  • 管理している求人の一覧を見る(index)
  • 管理している求人の詳細を見る(show)
  • 管理しているの内容を修正する(edit, update)
  • 管理しているを削除する(destroy)

これらはUserが行なっていることに間違いはありませんが、求人に関する操作を行なっているので
JobController とか WorkController などが望ましいと思っています。

URLとROUTE的には

Route::resource('job/', 'Publish\JobController', ['only' => ['index', 'show']]);
Route::group(['middleware' => ['auth']], function () {
  Route::resource('my_page/job/', 'Client\JobController');  
});

が望ましいかと思っています。

controllerの単位の決め方は同時に考えることが多すぎて数時間数日はまってしまうことがあります。
少なくとも私は以下のことを気にしながら開発しています。

  1. SEOを意識した親和性のあるURLである、かつ、
  2. Routeの記述がシンプルであり1アクションにおけるURLは同じだがGET/POSTで分けられメソッド名も違和感がない、かつ
  3. {controller名}.{メソッド名}のビューで違和感がない、かつ
  4. どこに何があるのかそれとなく分かってしまいそうなアーキテクチャ構造である

個人的には2番目と3番目に悩まされることが多いですが私は
Controller名を軸にURLを決めルーティング設定し
Controller名を軸に違和感がなければ {controller名}.{メソッド名}でビューを作るようにしています。

1つわかりやすい例をあげると以下です。

// ログインフォーム
Route::get('sign_in', 'Client\UserController@signInForm')->name('sign_in');
// ログイン実行
Route::post('sign_in', 'Client\UserController@signIn');

これはclient.user.sign_in_formというビューを作ればいいですし、ビューの命名的にも不自然はないどころかかなりマッチしているのではと個人的に思っています。

また、要件2の
Routeの記述がシンプルであり1アクションにおけるURLは同じだがGET/POSTで分けられメソッド名も違和感がない
もクリアしています。

最終的にはどれだけ整理整頓するのが上手いかどうかって話になってきますが、私もいろんなプロジェクトに参画して見てきていますが例えばpasswordResetControllerというcontrollerもあったりしたことがあります。

個人的にはこのconrtoller名を見て真っ先に思うのは、何のパスワードをリセットするのだろうか?

と思います。(passwordResetっていったらたいていユーザー絡みなので予想はできますが、ユーザーのパスワードであるとは100%言い切れません。)
でも、これはどちらかというとアクションだと思うので自分ならこういったcontrollerは作りません。

と、ここまで話た上で、UserContorollerに戻ります。
ユーザーが〜〜〜をする、というアクションをこのUserControllerに定義していくとは肥大化していしまいます。

Service層とRepository層いれているのでそこの問題は心配していませんが、メソッド名の数です。

システムによってはユーザーがやることなんて結構な数があると思います。

この結構な数のアクションをUserControllerという1ファイルに収めるのを良しとするか不合理とするかで悩んでいます。

結構な数のアクションはざっくりですが、今作っているサービスでは普通に40以上はあると思っています。

そのことを考えるとuserPasswordResetControllerなどというcontrollerの利用も考え出しているところですが、やはりパスワードリセットとかはアクションなのでそれをcontrollerとするのは個人的にはものすごく違和感があります。

なので現状こういったルーティングにしています。(ちょっとだけ公開)

// ログインフォーム
Route::get('sign_in', 'Client\UserController@signInForm')->name('sign_in');
// ログイン実行
Route::post('sign_in', 'Client\UserController@signIn');
// ログアウト実行
Route::post('sign_out', 'Client\UserController@signOut')->name('sign_out');


// パスワード再設定メール送信フォーム
Route::get('password/reset_link', 'Client\UserController@passwordResetLinkForm')->name('password.reset_link');
// パスワード再設定メール送信実行
Route::post('password/reset_link', 'Client\UserController@passwordResetLink');
// パスワード再設定フォーム
Route::get('password/reset/{token?}', 'Client\UserController@passwordResetForm')->name('password.reset');
//パスワード再設定実行
Route::post('password/reset', 'Client\UserController@passwordReset');

ミドルウェアがwebについては、get通信に対するメソッド名は末尾にFormをつけるということを自分の中でルール化しています。

何かベストプラティクスがありましたらご教示いただけますと助かります。

  • 気になる質問をクリップする

    クリップした質問は、後からいつでもマイページで確認できます。

    またクリップした質問に回答があった際、通知やメールを受け取ることができます。

    クリップを取り消します

  • 良い質問の評価を上げる

    以下のような質問は評価を上げましょう

    • 質問内容が明確
    • 自分も答えを知りたい
    • 質問者以外のユーザにも役立つ

    評価が高い質問は、TOPページの「注目」タブのフィードに表示されやすくなります。

    質問の評価を上げたことを取り消します

  • 評価を下げられる数の上限に達しました

    評価を下げることができません

    • 1日5回まで評価を下げられます
    • 1日に1ユーザに対して2回まで評価を下げられます

    質問の評価を下げる

    teratailでは下記のような質問を「具体的に困っていることがない質問」、「サイトポリシーに違反する質問」と定義し、推奨していません。

    • プログラミングに関係のない質問
    • やってほしいことだけを記載した丸投げの質問
    • 問題・課題が含まれていない質問
    • 意図的に内容が抹消された質問
    • 過去に投稿した質問と同じ内容の質問
    • 広告と受け取られるような投稿

    評価が下がると、TOPページの「アクティブ」「注目」タブのフィードに表示されにくくなります。

    質問の評価を下げたことを取り消します

    この機能は開放されていません

    評価を下げる条件を満たしてません

    評価を下げる理由を選択してください

    詳細な説明はこちら

    上記に当てはまらず、質問内容が明確になっていない質問には「情報の追加・修正依頼」機能からコメントをしてください。

    質問の評価を下げる機能の利用条件

    この機能を利用するためには、以下の事項を行う必要があります。

回答 2

checkベストアンサー

0

質問者が挙げていないフレームワークですが、Railsでは創始者のDHH氏が、「resources(というRails標準で使えるメソッド)でセットできるnewcreateshowupdateeditindexdestroyの7つ以外のアクションは作らずに、増やしたいときはリソースを分ける」というのを提唱していて(参考)、Rails界では実践者も多いようです。

投稿

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

  • 2018/10/16 23:24

    ありがとうございます。
    laravelにもresorceありますね。

    >7つ以外のアクションは作らず

    これを原則とするならどうしてもcontrollerがアクション単位で作られてしまいますね。
    でも1classが1000ステップ以上になるくらいならまだましですね。
    気持ちの問題ですかね...

    「controller 単位 決め方」などで調べているのですが、案外検索結果が出てこなくて困っていました。

    キャンセル

  • 2018/10/16 23:30

    CRUDはresorceで定義されるセットメソッドで良いと思っているので上記ルーティングの下にこういうのを記述しています。

    // ユーザー一覧
    Route::resource('user', 'Client\UserController', ['only' => ['show']]);

    どうでなければCRUD以外の処理に対応するメソッドがないからですが、この問題に対してはどう考えられていますか?

    キャンセル

0

URLの分離ケース

  1. データベース分離型(crud):cakephpの基本思想
  2. URL分離型(1url/1controler)
  3. 機能分離型 (入力~完了画面)
    がわりかしおおいですが

cakephpの場合、認証が必要な範囲で記載することになります。
(ルートは基本オートマッピングのため)

/users ユーザー情報以下 だけの場合は
/users/login UsersController ですし

上記に加え /orders 注文情報以下 もいるよなら
/login LoginContller です

なのでベストは要件によりけりとなります。

要約すれば
誰が操作するかは間違えで
何を操作するかがコントローラーの分離の目安になります。

投稿

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

15分調べてもわからないことは、teratailで質問しよう!

  • ただいまの回答率 88.58%
  • 質問をまとめることで、思考を整理して素早く解決
  • テンプレート機能で、簡単に質問をまとめられる

関連した質問

同じタグがついた質問を見る