Laravel學習筆記之Route,Middleware和Controller參數傳遞

本文主要學習總結下Route,Middleware,Controller間參數傳遞。開發時常常碰到相似場景：有時須要在Middleware中讀取Route中設置的middleware parameter和route parameter，有時也須要在Controller@Action中讀取Middleware中設置的參數。

先假設路由是：

Route::group(['prefix' => 'route', 'namespace' => 'RouteParameter'], function () {

    // route/user/{user}/role/{role}, route parameter是{user}, {role}
    Route::group(['middleware' => 'route.parameter'], function () {
        Route::resource('user.role', 'RouteParameterToMiddlewareController');
    });

    // route/advisor, middleware parameter是 'advisor', 'show', 'comment'
    Route::group(['middleware' => 'middleware.parameter:advisor,show,comment'], function () {
        Route::resource('advisor', 'MiddlewareParameterToMiddlewareController');
    });
    
    // /route/controller, middleware parameter是 'client'
    Route::group(['middleware' => 'middleware.controller:client'], function () {
        Route::resource('controller', 'MiddlewareToController');
    });
});

路由對應的控制器是：

namespace App\Http\Controllers\RouteParameter;

use Illuminate\Http\Request;
use App\Http\Controllers\Controller;

class RouteParameterToMiddlewareController extends Controller
{
    public function show($user, $role)
    {
        
    }
}


namespace App\Http\Controllers\RouteParameter;

use Illuminate\Http\Request;
use App\Http\Controllers\Controller;

class MiddlewareParameterToMiddlewareController extends Controller
{
    public function index()
    {
        return 'All';
    }
}

而且在Kernel.php中註冊中間件：

$routeMiddlewares = []
    ...
    
    'route.parameter'       => \App\Http\Middleware\RouteParameter::class,
    'middleware.parameter'  => \App\Http\Middleware\MiddlewareParameter::class,
    'middleware.controller' => \App\Http\Middleware\ControllerParameter::class,
;

Passing Route Parameters to Middleware

在中間件route.parameter中讀取路由參數有三種方式：$request->route($parameter_name);$request->route()->parameter($parameter_name);$request->route()->parameters()，代碼以下：

<?php

namespace App\Http\Middleware;

use Closure;

class RouteParameter
{
    /**
     * Handle an incoming request.
     *
     * @param  \Illuminate\Http\Request  $request
     * @param  \Closure  $next
     * @return mixed
     */
    public function handle($request, Closure $next)
    {
        // or $user = $request->route('user');
        $user = $request->route()->parameter('user'); // {user}
        $role = $request->route()->parameter('role'); // {role}
        dd($user, $role);
        $parameters = $request->route()->parameters(); // ['user' => {user}, 'role' => {role}]
        dd($parameters['user'], $parameters['role']);

        return $next($request);
    }
}

Passing Middleware Parameters to Middleware

在中間件middleware.parameter中讀取中間件參數只須要在handle()中映射上對應的參數變量就行，就和在Controller@Action中獲取路由參數同樣：

namespace App\Http\Middleware;

use Auth;
use Closure;
use Illuminate\Http\Response;

class MiddlewareParameter
{
    /**
     * Handle an incoming request.
     *
     * @param  \Illuminate\Http\Request $request
     * @param  \Closure                 $next
     * @param                           $role
     * @param                           $action
     * @param                           $data
     *
     * @return mixed
     */
    public function handle($request, Closure $next, $role, $action, $data)
    {
        dd($role, $action, $data); // 'advisor', 'show', 'comment'

        if (Auth::check() && (Auth::user()->type === $role)) {
            return $next($request);
        }

        return abort(Response::HTTP_UNAUTHORIZED, 'You must log in to access the resource.', [
            'Set-Cookie' => 'Laravel=0; path=/; Expires=Thu, 01-Jan-1970 00:00:00 GMT; Secure',
        ]);
    }
}

Passing Parameters in Middleware to Controller

有時須要在中間中把參數傳遞到控制器中，則能夠經過Request對象做爲傳輸管道，代碼如：

namespace App\Http\Middleware;

use Closure;

class ControllerParameter
{
    /**
     * Handle an incoming request.
     *
     * @param  \Illuminate\Http\Request  $request
     * @param  \Closure  $next
     * @return mixed
     */
    public function handle($request, Closure $next, $role)
    {
        $request->attributes->add(compact('role')); // 'client'
        return $next($request);
    }
}

控制器中使用Request對象獲取$role參數：

namespace App\Http\Controllers\RouteParameter;

use Illuminate\Http\Request;
use App\Http\Controllers\Controller;

class MiddlewareToController extends Controller
{
    public function index(Request $request)
    {
        dd($request->get('role'));
    }
}

總結：Route,Middleware,Controller之間傳遞參數這個知識點會常常在設計代碼時用到，還有從Route中傳遞參數到Controller中，這個就更是常常要用到的，也簡單。總結下這幾個知識點，便於查閱。

RightCapital招聘Laravel DevOps