深入解析Laravel的中間件

2020 年 8 月 11 日
筆記
php

Laravel 中間件是什麼？

簡而言之，中間件在 laravel 中的作用就是過濾 HTTP 請求，根據不同的請求來執行不同的邏輯操作。

我們可以通過中間件實現以下功能：

指定某些路由
設置 HTTP 響應頭
記錄請求
過濾請求的參數
決定是否啟用站點維護模式
響應前後做一些必要的操作

自定義中間件

命令行執行下面的簡單命令，就可以輕鬆創建一個新的中間件

php artisan make:middleware <MiddlewareName>
//MiddlewareName 就是你要創建的中間件的名字

執行上面的命令，Laravel 會在app/Http/Middleware目錄下自動創建一個只包含handle方法的中間件。

<?php
namespace App\Http\Middleware;
use Closure;
class RedirectIfSuperAdmin
{
    /**
     * Handle an incoming request.
     *
     * @param  \Illuminate\Http\Request  $request
     * @param  \Closure  $next
     * @return mixed
     */
    public function handle($request, Closure $next)
    {
        return $next($request);
    }
}

在中間件被調用的時候，handle方法就會執行。這裡需要注意的是 handle 方法默認有兩個參數$request和$next。$request用來接受應用的請求組求，$next將請求傳遞給應用程式。這兩個參數是handle必不可少的！中間件也包括前置中間件和後置中間件。

「前置中間件」顧名思義在將請求轉發到應用程式之前處理一些邏輯。另一方面，在中間件之後，在應用程式處理了請求並生成響應之後運行。

前置中間件:

<?php
namespace App\Http\Middleware;
use Closure;
class RedirectIfSuperAdmin
{
    /**
     * Handle an incoming request.
     *
     * @param  \Illuminate\Http\Request  $request
     * @param  \Closure  $next
     * @return mixed
     */
    public function handle($request, Closure $next)
    {
        //你的邏輯就在這裡
        return $next($request);
    }
}

後置中間件:

<?php
namespace App\Http\Middleware;
use Closure;
class RedirectIfSuperAdmin
{
    /**
     * Handle an incoming request.
     *
     * @param  \Illuminate\Http\Request  $request
     * @param  \Closure  $next
     * @return mixed
     */
    public function handle($request, Closure $next)
    {
        $response = $next($request);
        //你的邏輯就在這裡 例如 重定向到  `/`

        return $response;
    }
}

中間件的類別

全局中間件
路由中間件

全局中間件針對命中應用程式的每個請求運行。 Laravel 自帶了大多數這些中間件例如ValidatePostSize, TrimStrings,CheckForMaintenanceMode等等.

路由中間件僅在它們所連接的路由上運行
例如redirectIfAuthenticated.

註冊中間件

創建的任何中間件都必須註冊，因為這是 Laravel 知道存在的唯一方式。要註冊中間件，只需打開名為kernel.php的文件，該文件位於 Http 文件夾中，如下所示：

此文件包含默認 Laravel 提供的所有已註冊中間件的列表。它包含三個主要的中間件組$middleware, $middlewareGroups和 $routeMiddleware

<?php
namespace App\Http;
use Illuminate\Foundation\Http\Kernel as HttpKernel;
class Kernel extends HttpKernel
{
    /**
     * 應用程式的全局HTTP中間件。
     *
     * 這些中間件在應用程式的每個請求期間運行。
     *
     * @var array
     */
    protected $middleware = [
        \Illuminate\Foundation\Http\Middleware\CheckForMaintenanceMode::class,
        \Illuminate\Foundation\Http\Middleware\ValidatePostSize::class,
        \App\Http\Middleware\TrimStrings::class,
        \Illuminate\Foundation\Http\Middleware\ConvertEmptyStringsToNull::class,
        \App\Http\Middleware\TrustProxies::class,
    ];
    /**
     * 應用程式的路由中間件組.
     *
     * @var array
     */
    protected $middlewareGroups = [
        'web' => [
            \App\Http\Middleware\EncryptCookies::class,
            \Illuminate\Cookie\Middleware\AddQueuedCookiesToResponse::class,
            \Illuminate\Session\Middleware\StartSession::class,
            // \Illuminate\Session\Middleware\AuthenticateSession::class,
            \Illuminate\View\Middleware\ShareErrorsFromSession::class,
            \App\Http\Middleware\VerifyCsrfToken::class,
            \Illuminate\Routing\Middleware\SubstituteBindings::class,
        ],
        'api' => [
            'throttle:60,1',
            'bindings',
        ],
    ];
    /**
     * 應用程式的路由中間件.
     *
     * 可以將這些中間件分配給組或單獨使用。
     *
     * @var array
     */
    protected $routeMiddleware = [
        'auth' => \Illuminate\Auth\Middleware\Authenticate::class,
        'auth.basic' => \Illuminate\Auth\Middleware\AuthenticateWithBasicAuth::class,
        'bindings' => \Illuminate\Routing\Middleware\SubstituteBindings::class,
        'can' => \Illuminate\Auth\Middleware\Authorize::class,
        'guest' => \App\Http\Middleware\RedirectIfAuthenticated::class,
        'throttle' => \Illuminate\Routing\Middleware\ThrottleRequests::class,
        //the just created middlware
        'superadmin' => \App\Http\Middleware\RedirectIfSuperAdmin::class, 
    ];
}

$middleware數組包含全局中間件，它運行應用程式的每個 HTTP 請求，所以如果你想為每個請求運行一個中間件，你應該在這裡註冊它。$middlewareGroups使得可以在組中註冊中間件，從而更容易通過使用組名將大量中間件附加到路由。$routeMiddleware 數組包含各個註冊的路由中間件。

分配中間件

有兩個主要方法可以把註冊好的中間件應用到路由中。

通過控制器的構造方法
通過路由

通過構造方法分配中間件

通過構造方法分配中間有很大的靈活性，它提供了兩個重要的方法except($parameters)和only($parameters)，這兩個方法可以允許或阻止中間件應用到控制器中的輔助方法。不使用這兩個方法，中間件將使用與控制器的每個方法。

<?php
use Illuminate\Http\Request;

class ForumController extends Controller
{

    public function __construct(){
      /**in this case the middleware named auth is applied
       to every single function within this controller
       */
        $this->middleware('auth');
    }

    public function viewForum(){

      return view('index');
    }

    public function edit($id){

    }

    public function delete($id){

    }

}

使用except和only方法我們可以選擇把中間件應用到指定方法。如下所示：

<?php
use Illuminate\Http\Request;

class ForumController extends Controller
{

    public function __construct(){
      /**the authentication middleware here applies to all functions but
       viewForums() and viewForumDetails() and the opposite of this happens
       when you use only()
       */
        $this->middleware('auth')->except(['viewForums', 'viewForumDetails']);
    }

    public function viewForums(){

      return view('index');
    }

    public function edit($id){

    }

    public function delete($id){

    }

    public function viewForumDetails(){

    }
}

通過路由分配中間件

如果註冊的中間件可以直接附加到路由，如下所示:

<?php
//方法 1
Route::get('admin/profile', function () {
  //action
})->middleware('auth');

/**方法 2
或者像這樣使用完全限定的類名:
*/
use App\Http\Middleware\CheckAge;

Route::get('admin/profile', function () {
    // action
})->middleware(CheckAge::class);

//方法 3
Route::group(['middleware' => ['web']], function () {
    //action
});

N:B 中間件組可以像單個中間件一樣分配給路由

中間件參數

其他參數可以傳遞給中間件。典型示例是將每個用戶 ID 分配給角色，中間件檢查用戶的角色以確定是否有權訪問所請求的 URI。參數可以傳遞給中間件，如下所示：

<?php
//方法1 (Through route)
Route::get('admin/profile', function () {
  //action
})->middleware('auth:<role>'); //<role> 這裡應該被用戶想要傳遞的任何參數替換。

//方法2 (Through a controller)
use Illuminate\Http\Request;

class ForumController extends Controller
{

    public function __construct(){
        $this->middleware('auth:<role>');
    }
  }

通過用逗號分隔每個參數，可以將多個參數傳遞給中間件。

<?php
Route::get('admin/profile', function () {
  //action
})->middleware('auth:<role>,<age>,<country>'); //<role>, <age>, <country> 這裡應該被用戶想要傳遞的任何參數替換。

這些參數在$next變數之後傳遞給中間件的 handle 函數

<?php
class RedirectIfSuperAdmin
{
    /**
     * Handle an incoming request.
     *
     * @param  \Illuminate\Http\Request  $request
     * @param  \Closure  $next
     * @return mixed
     */
    public function handle($request, Closure $next, $role, $age, $country)
    {   
        //使用解析參數的中間件邏輯
        return $next($request);
    }
}

摘要

要創建中間件，請執行以下過程

使用 artisan 命令創建中間件 php artisan make:middleware 中間件名.
在 app→Http 文件夾中的 kernel.php 中註冊中間件
在創建的中間件中編寫邏輯
將中間件分配給路由或控制器

結論

Laravel 中間件可以更輕鬆地保護我們的路由，過濾輸入並完成許多其他工作，而無需編寫如此多的邏輯。查看官方 Laravel 文檔這裡了解中間件的更多功能，最重要的是練習。

還有更多進階學習資料可以免費領取進階PHP月薪30k>>>架構師成長路線【影片、面試文檔免費獲取】

Tags: php