laravel中間件的創建思路分析
- 2020 年 3 月 30 日
- 筆記
網上有很多解析laravel中間件的實現原理，但是不知道有沒有讀者在讀的時候不明白，作者是怎麼想到要用array_reduce函數的？
本文從自己的角度出發，模擬了如果我是作者，我是怎麼實現這個中間件功能，又是怎麼找到並使用對應的函數。
什麼是laravel中間件
Laravel 中間件提供了一種機制在不修改邏輯代碼的情況下，中斷原本程序流程，通過中間件來處理一些事件，或者擴展一些功能。比如日誌中間件可以方便的記錄請求和響應日誌，而不需要去更改邏輯代碼。
那麼我們簡化一下軟件執行過程，現在有一個核心類kernel，下面是它的laravel代碼
#捕獲請求 $request = IlluminateHttpRequest::capture() #處理請求 $response = $kernel->handle($request);
代碼的作用是 捕獲一個 Request ，返回一個 Response。這裏面就是後續分發到具體執行邏輯的代碼段並返回結果。
那麼如果想在執行這個$kernel->handle()方法之前或者之後，增加一段邏輯一般會怎麼寫呢。大概如下：
$request = IlluminateHttpRequest::capture() function midware(){ before()#在之前執行的語句集合 ##### $response = $kernel->handle($request); ##### after()#在之後執行的語句集合 }
顯然這樣寫沒有問題，但是毫無拓展性可言，想執行什麼東西都要更改這個方法，這種是不可能封裝成框架核心內容的。怎麼改進呢
定義一個要執行的中間件類叫middleware，類實現兩個方法，before()和after()然後代碼如下。
#配置項中有一項配置中間件： middleware = ''; $request = IlluminateHttpRequest::capture() function midware(){ middleware.before() ##### $response = $kernel->handle($request); ##### middleware.after() }
是否解決了問題呢，是解決了不用更改的問題，但是我們如果需要多個中間件怎麼辦呢，最容易想到的就是：定義一個中間件數組middleware_arr,每一個middleware類都含有before和after方法，代碼如下：
#配置項中有middleware_arr middleware_arr=array(); $request = IlluminateHttpRequest::capture() function midware(){ foreach(middleware_arr as middleware){ middleware.before() } ##### $response = $kernel->handle($request); ##### foreach(middleware_arr as middleware){ middleware.after() } }
雖然有點老土，但是的確解決了問題。但是這個還存在一個問題，就是我們怎麼向中間件傳遞參數的問題，那麼如下可以嗎：
$request = IlluminateHttpRequest::capture() function midware(){ foreach(middleware_arr as middleware){ middleware.before($request) } ##### $response = $kernel->handle($request); ##### foreach(middleware_arr as middleware){ middleware.after($response) } }
看似是解決了問題，但是仔細分析，就會發現，這裏面每次給中間件的都是最初的$request，這顯然不行，修改成如下：
$request = IlluminateHttpRequest::capture() function midware(){ foreach(middleware_arr as middleware){ $request = middleware.before($request) } ##### $response = $kernel->handle($request); ##### foreach(middleware_arr as middleware){ $response = middleware.after($response) } }
還有一個問題就是，假設有兩個中間件A和B，那麼執行順序應該是怎麼樣呢：
$request = IlluminateHttpRequest::capture() $request = A.before($request); $request = B.before($request); $response = $kernel->handle($request); $response = A.after(); $response = B.after();
這樣合理嗎?不太好分辨，我們假設有一個記錄請求和響應日誌的中間件，這個時候，不論你把它放在什麼位置，都不能完美的記錄最初請求和最終日誌。難道類似情況要寫兩個類，一個記錄請求放在中間件數組第一個，一個處理響應，放在數組最後一位嗎？不如在執行後面的foreach之前把middleware_arr數組給反轉一下，這樣就符合了要求：
$request = IlluminateHttpRequest::capture() $request = A.before($request); $request = B.before($request); $response = $kernel->handle($request); $response = B.after(); $response = A.after();
但是我也開始懷疑這個老土且不靈活的方案是否有更好的解決辦法，在觀察這個執行順序的時候，發現是一個包裹樣式（洋蔥式）的。那個接下來的問題就能不能找到更靈活精美的解決方案,看上面這種結構，總感覺有點熟悉，他很像是A的函數包裹B的函數，B的函數包括了最初的執行代碼。函數內部調用函數容易，但是咱們這裡每一個中間件之間是不知道對方存在的，所以要把其他中間件要執行的函數傳遞到上一級，這裡就用到了閉包函數還有一個php函數array_reduce()，
array_reduce函數定義：mixed array_reduce ( array $input , callable $function [, mixed $initial = NULL ] )
<?php function rsum ( $v , $w ) { $v += $w ; return $v ; } function rmul ( $v , $w ) { $v *= $w ; return $v ; } $a = array( 1 , 2 , 3 , 4 , 5 ); $x = array(); $b = array_reduce ( $a , "rsum" ); $c = array_reduce ( $a , "rmul" , 10 ); ?> #輸出： 這將使 $b 的值為 15， $c 的值為 1200（= 10*1*2*3*4*5）
array_reduce() 將回調函數 function 迭代地作用到 input 數組中的每一個單元中，從而將數組簡化為單一的值。咱們是把多個函數包裹成最終調用一個函數。
#我們先假設只有一個middleware,叫log來簡化情況,這裡的類應該是一個類全路徑，我這裡就簡單的寫一下，要不然太長了。 $middleware_arr = ['log']; #最終要執行的代碼先封裝成一個閉包，要不然沒有辦法傳遞到內層,如果用函數名傳遞函數的話，是沒有辦法傳遞參數的。 $default = function() use($request){ return $kernel->handle($request); } $callback = array_reduce($middleware_arr,function($stack,$pipe) { return function() use($stack,$pipe){ return $pipe::handle($stack); }; },$default); # 這裡 callback最終是 這樣一個函數： function() use($default,$log){ return $log::handle($default); }; #所以每一個中間件都需要有一個方法handle方法,方法中要對傳輸的函數進行運行，類似如下，這裡我類名就不大寫了 class log implements Milldeware { public static function handle(Closure $func) { $func(); } } #這裡不難看出可以加入中間件自身邏輯如下： class log implements Milldeware { public static function handle(Closure $func) { #這裡可以運行邏輯塊before() $func(); #這裡可以運行邏輯塊after() } }
這樣在執行callback函數的時候，執行順序如下：
先運行log::haddle()方法，
執行了log::before()方法
運行default方法，執行$kernel->handle($request)
運行log::after()方法
然後模擬多個的情況如下：
$middleware_arr = ['csrf','log']; #最終要執行的代碼先封裝成一個閉包，要不然沒有辦法傳遞到內層,如果用函數名傳遞函數的話，是沒有辦法傳遞參數的。 $default = function() use($request){ return $kernel->handle($request); } $callback = array_reduce($middleware_arr,function($stack,$pipe) { return function() use($stack,$pipe){ return $pipe::handle($stack); }; },$default); # 這裡 callback最終是 執行這樣： $log::handle(function() use($default,$csrf){ return $csrf::handle($default); });
執行順序如下：
1.先運行log::haddle(包含csrf::handle閉包函數)方法，
2.執行了log::before()方法
3.運行閉包也就是運行了$csrf::handle($default)
4.執行了csrf::before()方法
5.運行default方法，執行$kernel->handle($request)
6.執行了csrf::after()方法
7.運行log::after()方法
注意這裡還有一個問題就是中間件產生的結果，並沒有進行傳遞，可以通過修改共有資源的方式來達到相同的目的，並非需要真的傳值到下一個中間件。
到此這篇文件就結束了，其實其中很多關節都是我寫這篇文章的時候才想明白的。尤其是對閉包函數的運用和理解更深了，閉包函數可以延遲利用資源，比如當前不適合執行的語句，又要傳遞到後面，利用閉包可以封裝起來傳遞出去，這是傳統函數做不到的。
以上就是laravel中間件的創建思路分析的詳細內容
