控制器 · Laravel 5.6 中文文檔

* * * * * [TOC] ## 簡介為了代替在路由文件中以閉包的形式定義所有的請求處理邏輯，你也許想使用控制類來組織這些行為。控制器能夠將相關的請求處理邏輯組成一個單獨的類，控制器被存放在?`app/Http/Controllers`?目錄下。 ## 基礎控制器 ### 定義控制器下面是一個基礎控制器類的例子。需要注意的是，該控制器繼承了一個Laravel內置的基礎控制器類。該基礎控制器提供了一些編輯的方法，比如?`middleware`?方法，該方法可以為控制器行為添加中間件： ~~~ <?php namespace App\Http\Controllers; use App\User; use App\Http\Controllers\Controller; class UserController extends Controller { /** * Show the profile for the given user. * * @param int $id * @return Response */ public function show($id) { return view('user.profile', ['user' => User::findOrFail($id)]); } } ~~~ 你可以這樣定義一個指向控制器行為的路由: ~~~ Route::get('user/{id}', 'UserController@show'); ~~~ 現在, 當一個請求與此指定的路由的URI匹配時，?`UserController`類的`show`方法就會被執行。當然，路由參數也會傳遞至該方法。 > {tip} 控制器并**不是強制要求**?繼承基礎類。但是，如果控制器沒有繼承基礎類，你將無法使用一些便捷的功能，比如`middleware`,?`validate`和?`dispatch`?。 ### 控制器和命名空間需要注意的是，在定義控制器路由時，我們不需要指定完整的控制器命名空間。因為?`RouteServiceProvider`?會在一個包含命名空間的路由器組中加載路由文件，所以我們只需指定類名中?`App\Http\Controllers`?命名空間之后的部分就可以了。如果你選擇將控制器存放在?`App\Http\Controllers`?目錄下，只需要簡單的使用相對于?`App\Http\Controllers`?根命名空間的特定類名。也就是說，如果完整的控制器類是?`App\Http\Controllers\Photos\AdminController`，那你應該用以下這種方式向控制器注冊路由： ~~~ Route::get('foo', 'Photos\AdminController@method'); ~~~ ### 單個行為控制器如果你想定義一個只處理單個行為的控制器，你可以在這個控制器中放置一個?`__invoke`?方法： ~~~ <?php namespace App\Http\Controllers; use App\User; use App\Http\Controllers\Controller; class ShowProfile extends Controller { /** * Show the profile for the given user. * * @param int $id * @return Response */ public function __invoke($id) { return view('user.profile', ['user' => User::findOrFail($id)]); } } ~~~ 注冊單個行為控制器的路由時，不需要指定方法： ~~~ Route::get('user/{id}', 'ShowProfile'); ~~~ ## 控制器中間件 [Middleware](http://www.hmoore.net/tonyyu/laravel_5_6/786089)?可以在路由文件中被分配給控制器路由： ~~~ Route::get('profile', 'UserController@show')->middleware('auth'); ~~~ 但是，在控制器的構造方法中指定中間件會更方便。使用控制器構造函數中的?`middleware`?方法，你可以很容易地將中間件分配給控制器的行為。你甚至可以約束中間件只對控制器類中的某些特定方法生效： ~~~ class UserController extends Controller { /** * Instantiate a new controller instance. * * @return void */ public function __construct() { $this->middleware('auth'); $this->middleware('log')->only('index'); $this->middleware('subscribed')->except('store'); } } ~~~ 還能使用閉包來為控制器注冊中間件。閉包的方便之處在于，你無需特地創建一個中間件類來為某一個特殊的控制器注冊中間件： ~~~ $this->middleware(function ($request, $next) { // ... return $next($request); }); ~~~ > {tip} 你可以將中間件分配給控制器的部分行為上；然而這樣可能意味著你的控制器正在變得很大。這里建議你將控制器分成多個更小的控制器。 ## 資源控制器 Laravel 資源路由將典型的「CRUD」路由分配給具有單行代碼的控制器。比如，你希望創建一個控制器來處理應用保存的「照片」的所有 HTTP 請求。使用Artisan命令?`make:controller`?，我們可以快速創建這樣一個控制器： ~~~ php artisan make:controller PhotoController --resource ~~~ 這個命令會生成一個控制器?`app/Http/Controllers/PhotoController.php`?。其中包含了每個可用資源的操作方法。接下來，你可以給控制器注冊一個資源路由： ~~~ Route::resource('photos', 'PhotoController'); ~~~ 這個單一路由聲明創建多個路由來處理資源上的各種行為。生成的控制器為每個行為保留了方法，包括了關于處理 HTTP 動作和 URIs 的聲明注釋。你可以通過將一個數組傳入到`resources`方法中的方式來一次性的創建多個資源控制器： ~~~ Route::resources([ 'photos' => 'PhotoController', 'posts' => 'PostController' ]); ~~~ #### 資源控制器操作處理 | 動作 | URI | 行為 | 路由名稱 | | --- | --- | --- | --- | | GET | `/photos` | index | photos.index | | GET | `/photos/create` | create | photos.create | | POST | `/photos` | store | photos.store | | GET | `/photos/{photo}` | show | photos.show | | GET | `/photos/{photo}/edit` | edit | photos.edit | | PUT/PATCH | `/photos/{photo}` | update | photos.update | | DELETE | `/photos/{photo}` | destroy | photos.destroy | #### 指定資源模型如果你使用了路由模型綁定，并且想在資源控制器的方法中使用類型提示，你可以在生成控制器的時候使用`--model`?選項： ~~~ php artisan make:controller PhotoController --resource --model=Photo ~~~ #### 偽造表單方法因為 HTML 表單不能生成`PUT`，`PATCH`和?`DELETE`?請求，所以你需要添加一個隱藏的`_method`?字段來偽造這些 HTTP 動作。這個Blade指令?`@method`?可以為你創建這個字段： ~~~ <form action="/foo/bar" method="POST"> @method('PUT') </form> ~~~ ### 部分資源路由聲明資源路由時，你可以指定控制器應該處理的部分行為，而不是所有默認的行為： ~~~ Route::resource('photos', 'PhotoController', ['only' => [ 'index', 'show' ]]); Route::resource('photos', 'PhotoController', ['except' => [ 'create', 'store', 'update', 'destroy' ]]); ~~~ #### API 資源路由當聲明用于 APIs 的資源路由時，通常需要排除顯示 HTML 模板的路由，如?`create`?和?`edit`。為了方便起見，你可以使用?`apiResource`?方法自動排除這兩個路由： ~~~ Route::apiResource('photos', 'PhotoController'); ~~~ 你可以通過傳遞一個數組給?`apiResources`?方法的方式來一次性注冊多個API資源控制器： ~~~ Route::apiResources([ 'photos' => 'PhotoController', 'posts' => 'PostController' ]); ~~~ 為了快速生成一個不包含`create`?和?`edit`方法的API資源控制器，可以在執行?`make:controller`命令時加上?`--api`?選項： ~~~ php artisan make:controller API/PhotoController --api ~~~ ### 命名資源路由默認情況下，所有的資源控制器行為都有一個路由名稱。但是，你可以傳入一個?`names`?數組來覆蓋這些名稱： ~~~ Route::resource('photos', 'PhotoController', ['names' => [ 'create' => 'photos.build' ]]); ~~~ ### 命名資源路由參數默認情況下，?`Route::resource`?會根據資源名稱的「單數」形式創建資源路由的路由參數。你可以在選項數組中傳入?`parameters`參數來輕松地覆蓋每個資源。?`parameters`?數組應當是一個資源名稱和參數名稱的關聯數組： ~~~ Route::resource('user', 'AdminUserController', ['parameters' => [ 'user' => 'admin_user' ]]); ~~~ 上例將會為資源的?`show`?路由生成如下的 URI ： ~~~ /user/{admin_user} ~~~ ### 本地化資源 URIs 默認情況下，`Route::resource`?將會使用英文動詞來創建資源 URI。如果你需要本地化?`create`?和?`edit`?行為動作名，你可以在`AppServiceProvider`的?`boot`?方法中使用?`Route::resourceVerbs`?方法實現： ~~~ use Illuminate\Support\Facades\Route; /** * Bootstrap any application services. * * @return void */ public function boot() { Route::resourceVerbs([ 'create' => 'crear', 'edit' => 'editar', ]); } ~~~ 一旦動作被自定義后，像?`Route::resource('fotos', 'PhotoController')`?這樣注冊的資源路由將會產生如下的 URI： ~~~ /fotos/crear /fotos/{foto}/editar ~~~ ### 補充資源控制器如果你想為一個資源控制器在默認的資源路由之外增加額外的路由，你應該在調用`Route::resource`之前定義這些路由。否則由?`resource`?方法定義的路由可能會無意中優先于你補充的路由： ~~~ Route::get('photos/popular', 'PhotoController@method'); Route::resource('photos', 'PhotoController'); ~~~ > {tip} 記住保持控制器的專一性。如果你發現需要典型的資源操作之外的方法，可以考慮將你的控制器分成兩個更小的控制器。 ## 依賴注入 & 控制器 #### 構造函數注入 Laravel 使用?[服務容器](http://www.hmoore.net/tonyyu/laravel_5_6/786056)?來解析所有的控制器。因此，你可以在控制器的構造函數中使用類型提示需要的依賴項，而聲明的依賴項會自動解析并注入控制器實例中： ~~~ <?php namespace App\Http\Controllers; use App\Repositories\UserRepository; class UserController extends Controller { /** * 用戶 repository 實例。 */ protected $users; /** * 創建一個新的控制器實例。 * * @param UserRepository $users * @return void */ public function __construct(UserRepository $users) { $this->users = $users; } } ~~~ 當然，你也可以類型提示任何?[Laravel 契約](http://www.hmoore.net/tonyyu/laravel_5_6/786059)，只要它能被解析。根據你的應用，將你的依賴項注入控制器能提供更好的可測試性。 #### 方法注入除了構造函數注入之外，你還可以在控制器方法中類型提示依賴項。最常見的用法就是將?`Illuminate\Http\Request`實例注入到控制器方法中： ~~~ <?php namespace App\Http\Controllers; use Illuminate\Http\Request; class UserController extends Controller { /** * 保存一個新用戶 * * @param Request $request * @return Response */ public function store(Request $request) { $name = $request->name; // } } ~~~ 如果你的控制器方法還需要從路由參數中獲取輸入內容，只需要在其他依賴項后列出路由參數即可。比如，如果你的路由是這樣定義的： ~~~ Route::put('user/{id}', 'UserController@update'); ~~~ 你還可以類型提示?`Illuminate\Http\Request`?并通過定義控制器方法獲取?`id`?參數，如下所示： ~~~ <?php namespace App\Http\Controllers; use Illuminate\Http\Request; class UserController extends Controller { /** * 更新給定用戶的信息。 * * @param Request $request * @param string $id * @return Response */ public function update(Request $request, $id) { // } } ~~~ ## 路由緩存 > {note} 基于閉包的路由不能被緩存。如果要使用路由緩存，你必須將所有的閉包路由轉換成控制器類路由。如果你的應用只使用了基于控制器的路由，那么你應該充分利用 Laravel 的路由緩存的優勢。使用路由緩存將極大地減少注冊所有應用路由所需的時間。某些情況下，路由注冊的速度甚至可以快一百倍。要生成路由緩存，只需執行 Artisan 命令?`route:cache`?： ~~~ php artisan route:cache ~~~ 運行這個命令之后，每一次請求的時候都將會加載緩存的路由文件。如果你添加了新的路由，記得你需要生成一個新的路由緩存。因此，你應該只在生產環境運行?`route:cache`命令：你可以使用?`route:clear`?命令清除路由緩存： ~~~ php artisan route:clear ~~~