控制器


##########

控制器

  • 簡介
  • 基礎控制器
    • #基礎控制器
    控制器& 命名空間
  • 單一行為控制器
    • ##控制器中間件
    • 資源控制器
    • 部分資源路由
    • 命名資源路由
    • 命名資源路由參數
    • 本機資源化URIs
  • 補充資源控制器
##依賴注入& 控制器

#路由快取

簡介

為了取代在路由檔案中以閉包形式定義的所有的請求處理邏輯, 你也許想使用控制類別來組織這些行為。控制器能將相關的請求處理邏輯組成一個單獨的類別。控制器被存放在
app/Http/Controllers
目錄中。

#基礎控制器

定義控制器以下是一個基礎控制器類別的範例。需要注意的是,該控制器繼承了 Laravel 內建的基底類別控制器。這個基底類別控制器提供了一些便利的方法,例如 middleware 方法,該方法可以為控制器行為添加中間件:

    <?php  
      namespace App\Http\Controllers;   
      use App\User;    
      use App\Http\Controllers\Controller;    
      class UserController extends Controller   
       {       
        /**
         * 显示给定用户的概要文件.
         *
         * @param  int  $id
         * @return View
         */        
       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   
        {        
        /**
         * 展示给定用户的资料.
         *
         * @param  int  $id
         * @return View
         */      
        public function __invoke($id)      
          {          
            return view('user.profile', ['user' => User::findOrFail($id)]);      
           }   
         }

當註冊單一行為控制器的路由時,無需指明方法:

    Route::get('user/{id}', 'ShowProfile');

你可以透過Artisan 指令工具裡的 make:controller 指令中的--invokable 選項來產生一個可呼叫的控制器:

    php artisan make:controller ShowProfile --invokable

控制器中間件

Middleware 可以在路由檔案中指派給控制器的路由。

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 資源路由將典型的「CURD (增刪改查)」路由指派給具有單行程式碼的控制器。例如,你希望建立一個控制器來處理應用已儲存的  "照片" 的所有 HTTP 請求。使用Artisan 指令make:controller , 我們可以快速建立這樣一個控制器:

php artisan make:controller PhotoController --resource

這個指令會產生一個控制器app/Http/Controllers/PhotoController.php。其中包括每個可用資源操作的方法。

接下來,你可以為控制器註冊一個資源路由:

Route::resource('photos', 'PhotoController');

這個單一的路由宣告會建立多個路由來處理資源上的各種行為。生成的控制器為每個行為保留了方法,包括了關於處理 HTTP 動詞和 URLs 的聲明註釋。

你可以透過將陣列傳參到 resources  方法中的方式來一次的建立多個資源控制器:

Route::resources([  
  'photos' => 'PhotoController',    
  'posts' => 'PostController'
  ]);

資源控制器操作處理

##路由名稱GETindexphotos.indexGET#createphotos.createPOSTstore#photos.storeGETshow#photos.showGETedit#photos.editPUT/PATCH
HTTP 方法#URI動作
/photos
/photos/create
/photos
/photos/{photo}
/photos/{photo}/edit
############################################################ ####/photos/{photo}更新photos.update
#刪除/photos/{photo} 銷毀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('users', 'AdminUserController')->parameters([  
  'users' => 'admin_user'
]);

上列將會為資源的 

show 路由產生如下的URl :

/users/{admin_user}

在地化資源 URIs

預設情況下, Route::resource 將會使用英文動詞來建立資源 URI 。如果你需要在地化create  和 edit  行為動作名,你可以在AppServiceProviderboot 方法中使用Route: :resourceVerbs 方法實作。

use Illuminate\Support\Facades\Route;
/**
 * 初始化任何应用服务
 *
 * @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  服務容器解析所有的控制器。因此,你可以在控制器的建構函式中使用型別提示可能需要的依賴項。依賴宣告會被自動解析並注入到控制器實例:

<?php
   namespace App\Http\Controllers;
   use App\Repositories\UserRepository;
   class UserController extends Controller{    
      /**
     * The user repository instance.
     */    
     protected $users;    
     /**
     * Create a new controller instance.
     *
     * @param  UserRepository  $users
     * @return void
     */    
    public function __construct(UserRepository $users)  
      {       
       $this->users = $users;   
      }
    }

當然,你可以輸入任何的 Laravel 契約. 只要容器可以解析它。根據你的應用,注入你的類型提示到控制器會提供更好可測試性。

方法注入

處理建構函式註入,你也可以在控制器方法中輸入型別提示依賴項。方法注入最常見的用例是在控制器方法中註入Illuminate\Http\Request 的實例:

<?php
  namespace App\Http\Controllers;
  use Illuminate\Http\Request;
  class UserController extends Controller{    
     /**
     * Store a new user.
     *
     * @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{    
     /**
     * Update the given user.
     *
     * @param  Request  $request
     * @param  string  $id
     * @return Response
     */    
   public function update(Request $request, $id)   
    {       
     //   
     }
 }

#

路由快取

{note} 基於閉包的路由無法被快取。要使用路由快取。你需要將任何閉包路由轉換成控制器路由。

如果你的應用程式只使用了基於控制器的路由,那麼你應該利用路由快取。使用路由快取將大大減少註冊所有應用程式路由所需的時間。某些情況下,路由註冊的速度甚至會快 100 倍。要產生路由緩存,只需要執行 route:cache

php artisan route:cache

運行此命令之後,每個請求都會載入快取的路由檔案。記住,如果你新增了任何的新路由,則需要產生新的路由快取。因此,你只應在專案部署期間執行 route:cache 指令。

你可以使用  route:clear  指令來清除路由快取:

php artisan route:clear
這篇文章首發在 LearnKu.com 網站上。