簡介
Laravel 中間件提供了一種方便的機制來過濾進入應用的 HTTP 請求, 如
ValidatePostSize
用來驗證POST
請求體大小、ThrottleRequests
用于限制請求頻率等。
那Laravel的中間件是怎樣工作的呢?
啟動流程
再說Laravel
中間件前,我們先來理一理laravel
的啟動流程
首先,入口文件index.php
加載了autoload
和引導文件bootstrap
require __DIR__.'/../bootstrap/autoload.php';
$app = require_once __DIR__.'/../bootstrap/app.php';
并在引導文件bootstrap/app.php
中初始化了Application
實例
$app = new Illuminate\Foundation\Application(
realpath(__DIR__.'/../')
);
我們先跳過如何初始化Application(后面會有簡單介紹),再回到入口文件(index.php)中,通過從Application
實例$app
中獲取Http Kernel
對象來執行handle
方法,換取response
。
$kernel = $app->make(Illuminate\Contracts\Http\Kernel::class);
$response = $kernel->handle(
$request = Illuminate\Http\Request::capture()
);
$response->send();
$kernel->terminate($request, $response);
換取響應后,把響應內容返回給Client
,并執行后續操作(terminate,如關閉session等)。
實例化Application
:
Laravel的容器并不是我這次說的重點,這里簡單介紹下
在初始化Application
(啟動容器)時,Laravel
主要做了三件事情
- 注冊基礎綁定
- 注冊基礎服務提供者
- 注冊容器核心別名
注冊完成以后,我們就能直接從容器中獲取需要的對象(如Illuminate\\Contracts\\Http\\Kernel
),即使它是一個Interface
。
獲取Illuminate\Contracts\Http\Kernel類時,我們得到的真正實例是 App\Http\Kernel
// bootstrap/app.php
$app->singleton(
Illuminate\Contracts\Http\Kernel::class,
App\Http\Kernel::class
);
Laravel容器請參考
Handle
從容器中獲得Http Kernel
對象后,Laravel
通過執行kernel->handle
來換取response
對象。
//Illuminate\Foundation\Http\Kernel.php
public function handle($request)
{
$request->enableHttpMethodParameterOverride();
$response = $this->sendRequestThroughRouter($request);
//......
}
enableHttpMethodParameterOverride
方法開啟方法參數覆蓋,即可以在POST
請求中添加_method
參數來偽造HTTP
方法(如post中添加_method=DELETE來構造HTTP DELETE
請求)。
然后Laravel
把請求對象(request
)通過管道流操作。
protected function sendRequestThroughRouter($request)
{
return (new Pipeline($this->app))
->send($request)
->through($this->app->shouldSkipMiddleware() ? [] : $this->middleware)
->then($this->dispatchToRouter());
}
/**
* Get the route dispatcher callback.
*
* @return \Closure
*/
protected function dispatchToRouter()
{
return function ($request) {
$this->app->instance('request', $request);
return $this->router->dispatch($request);
};
}
Pipeline
是laravel的管道操作類。在這個方法中,我的理解是:發送一個$request
對象通過middleware
中間件數組,最后在執行dispatchToRouter
方法。注意,這里的中間件只是全局中間件。即首先讓Request
通過全局中間件,然后在路由轉發中($this->dispatchToRouter()
),再通過路由中間件
及中間件group
。
所以,到這里為止,Laravel
的請求交給了Pipeline
管理,讓我們來看看這個Pipeline
究竟是怎樣處理的。
//Illuminate\Pipeline\Pipeline.php
public function then(Closure $destination)
{
$pipeline = array_reduce(
array_reverse($this->pipes), $this->carry(), $this->prepareDestination($destination)
);
return $pipeline($this->passable);
}
protected function prepareDestination(Closure $destination)
{
return function ($passable) use ($destination) {
return $destination($passable);
};
}
protected function carry()
{
return function ($stack, $pipe) {
return function ($passable) use ($stack, $pipe) {
if ($pipe instanceof Closure) {
return $pipe($passable, $stack);
} elseif (! is_object($pipe)) {
list($name, $parameters) = $this->parsePipeString($pipe);
$pipe = $this->getContainer()->make($name);
$parameters = array_merge([$passable, $stack], $parameters);
} else {
$parameters = [$passable, $stack];
}
return $pipe->{$this->method}(...$parameters);
};
};
}
我們來看看最重要的then
方法, 在這方法中$destination
表示通過該管道最后要執行的Closure
(即上述的dispatchToRouter
方法)。passable
表示被通過管道的對象Request
。
php
內置方法array_reduce
把所有要通過的中間件($this->pipes
)都通過carry
方法($this->pipes
不為空時)并壓縮為一個Closure
。最后在執行prepareDestination
。
array_reduce($pipes, callback($stack, $pipe), $destination), 當pipes為空時,直接執行destination,否則將所有
$pipes
壓縮為一個Closure
,最后在執行destination
。
列如我有兩個中間件
Illuminate\Foundation\Http\Middleware\CheckForMaintenanceMode::class,
App\Http\Middleware\AllowOrigin::class,//自定義中間件
將這兩個中間件通過array_reduce
方法時,返回壓縮后的Closure
如:
該Closure
共有三個層, 前面兩個為兩個中間件,后面個位最后要執行的Closure
(即上述的dispatchToRouter
方法)。
//中間件handle
public function handle($request, Closure $next)
{
}
在第一個通過的中間件(此處是CheckForMaintenanceMode
)handle
方法中,dump($next)
如下
在第二個通過的中間件(共兩個,此處是AllowOrigin
)handle
方法中,dump($next)
如下
由此可知,中間件在執行$next($request)
時,表示該中間件已正常通過,并期待繼續執行下一個中間件。直到所有中間件都執行完畢,最后在執行最后的destination
(即上述的dispatchToRouter
方法)
以上是Laravel
在通過全局中間件時的大致流程,通過中間件group和路由中間件
也是一樣的, 都是采用管道流操作,詳情可翻閱源碼
Illuminate\Routing\Router->runRouteWithinStack