關於laravel5.5控制器方法參數依賴注入原理深度解析及問題修復

　　在laravel5.5中，可以根據控制器方法的參數類型，自動注入一個實例化對象，極大提升了編程的效率，但是相比較與Java的SpringMVC框架，功能還是有所欠缺，使用起來還是不太方便，主要體現在方法參數的注入不完全是按照參數名稱進行的，如果改變了傳入參數的順序會導致類型不匹配的錯誤。

一、控制器方法參數注入步驟設計

1、在/routes/web.php中添加路由

Route::get('/diary/show/{diary}/{page?}','Diary\DiaryController@list');

2、編寫控制器文件DiaryController.php放到/app/Http/Controllers/Diary/路徑下面

<?php
namespace App\Http\Controllers\Diary;
use App\Http\Controllers\Controller;
class DiaryController extends Controller
{
    public function show(\App\Diary $diary,$page=11){
        var_dump($diary->title,$page); 
　　} 
}

3、構建模型\App\Diary並安裝到數據庫（略）

<?php
namespace App;
use Illuminate\Database\Eloquent\Model;
class Diary extends Model
{
    protected $table='diary';
    public $timestamps = false;
}

 

4、訪問控制器方法

打開瀏覽器輸入：“http://127.0.0.1//diary/show/4/12”

此時輸出數據表diary中id=4的title字段值和12

 

二、注入參數類型說明

說明：laravel會根據請求路由中匹配的{diary}和{page}變量和控制器方法中需要的方法參數類型，生成實例對象並注入到控制器方法中，

針對不同的參數類型分三種情況：

1、如果參數類型實現了UrlRoutable接口（即繼承自Illuminate\Database\Eloquent\Model），則在模型對象對應的表中查找id值為路由中匹配參數值的那條記錄，並構建模型對象；

2、如果參數類型為自定義類型（沒有實現UrlRoutable接口），則laravel會構建一個對象后注入；

3、如果參數類型為基礎數據類型，並且名稱為路由參數中定義的名稱，則從路由參數中獲取值；

4、如果參數類型為基礎數據類型，但名稱未在路由參數中定義，如果有默認值則使用默認值，否則系統提示錯誤。

 

三、目前注入參數存在的問題分析

參考java的Spring MVC框架，laravel的參數類型注入還存在缺陷，主要體現在不完全是按照參數名稱進行注入。

1、如果改變控制器參數的順序，會出現參數類型傳遞錯誤，如將DiaryController控制的show方法的參數改變順序，則會導致錯誤發生：

<?php
namespace App\Http\Controllers\Diary;
use App\Http\Controllers\Controller;
class DiaryController extends Controller
{
    public function show($page,\App\Diary $diary){
        var_dump($diary->title,$page); 
　　} 
}

2、由於參數類型為基礎數據類型（參見二（3）），並不是按照名稱來注入的參數，因此將代碼改為如下，同樣會運行正常

<?php
namespace App\Http\Controllers\Diary;
use App\Http\Controllers\Controller;
class DiaryController extends Controller
{
    public function show(\App\Diary $diary,$pag){
        var_dump($diary->title,$pag); 
　　} 
}

 

四、laravel5.5控制器方法參數注入源碼剖析

1、實現了UrlRoutable接口的參數類型由路由中間件Illuminate\Routing\Middleware\SubstituteBinding實現構建

    public function handle($request, Closure $next)
    {
        $this->router->substituteBindings($route = $request->route());
        $this->router->substituteImplicitBindings($route);

        return $next($request);
    }

Illuminate\Routing\Router的substituteImplicitBindings方法

    public function substituteImplicitBindings($route)
    {
        ImplicitRouteBinding::resolveForRoute($this->container, $route);
    }

在Illuminate\Routing\ImplicitRouteBinding的resolveForRoute方法中實現

    public static function resolveForRoute($container, $route)
    {
        //從路由參數中獲取參數值,$parameters為 ['diary':'4','page':'12']
        $parameters = $route->parameters();
        //獲取控制器的函數參數列表，此處傳入UrlRoutable::class，只返回實現UrlRoutable接口的參數
        $signatureParameters = $route->signatureParameters(UrlRoutable::class);
        foreach ($signatureParameters as $parameter) {
            if (! $parameterName = static::getParameterName($parameter->name, $parameters)) {
                continue;
            }

            $parameterValue = $parameters[$parameterName];
            if ($parameterValue instanceof UrlRoutable) {
                continue;
            }
            //構建模型的實例（基礎自Illuminate\Database\Eloquent\Model），此處為App\Diary
            $instance = $container->make($parameter->getClass()->name);
            //將參數值綁定到模型，參加Illuminate\Database\Eloquent\Model的resolveRouteBinding方法
            if (! $model = $instance->resolveRouteBinding($parameterValue)) {
                throw (new ModelNotFoundException)->setModel(get_class($instance));
            }
　　　　　　　//根據參數名稱注入模型實例 $route->setParameter($parameterName, $model);
        }
    }

附加說明：

此處調用$route對象（Illuminate\Routing\Route類型）setParameter方法，說明模型參數類型（見二（1））正是通過參數類型和參數名稱同時匹配才注入模型實例

2、其它類型的控制器參數在運行路由控制器時綁定

關鍵部分在Illuminate\Routing\ControllerDispatcher的dispatch方法中實現：

    public function dispatch(Route $route, $controller, $method)
    {
        //解析控制器方法的參數
        $parameters = $this->resolveClassMethodDependencies(
            $route->parametersWithoutNulls(), $controller, $method
        );
        if (method_exists($controller, 'callAction')) {
            //通過Illuminate\Routing\Controller的callAction調用控制器方法
            return $controller->callAction($method, $parameters);
        }
        //直接調用控制器方法
        return $controller->{$method}(...array_values($parameters));
    }

調用resolveClassMethodDependencies方法

  public function resolveMethodDependencies(array $parameters, ReflectionFunctionAbstract $reflector)
    {
        $instanceCount = 0;
        $values = array_values($parameters);
        //通過方法反射獲取方法參數
        foreach ($reflector->getParameters() as $key => $parameter) {
        //如果有默認值則返回默認值，如果是自定義方法則構建實例返回
            $instance = $this->transformDependency(
                $parameter, $parameters
            );

            if (! is_null($instance)) {
                $instanceCount++;
                //自定義類型（未實現UrlRoutable接口）的實例注入
                $this->spliceIntoParameters($parameters, $key, $instance);
            } elseif (! isset($values[$key - $instanceCount]) &&
                      $parameter->isDefaultValueAvailable()) {
                //未在路由參數中定義，但有默認值的參數注入
                $this->spliceIntoParameters($parameters, $key, $parameter->getDefaultValue());
            }
        }
        return $parameters;
    }

 

問題總結說明：

1、模型參數（見二（1））和名稱在路由參數中定義的基礎類型（見二（3））必須按照在路由中定義的順序首先傳入控制器方法，否則會出現類型不匹配的錯誤；

 

2、自定義類型（見二（2））和名稱未在路由參數中定義的基礎類型參數（見二（4）），在控制器方法中按出現的順序依次傳入。

 

五、問題修復

打開/vendor/laravel/framework/src/Illuminate/Routing/RouteDependencyResolverTrait.php文件，

將resolveMethodDependencies方法修改為如下代碼

    public function resolveMethodDependencies(array $parameters,ReflectionFunctionAbstract $reflector){
        $methodParameters=[];
        foreach($reflector->getParameters() as $key=>$parameter){
            $name=$parameter->getName();
            $instance=$this->transformDependency($parameter, $parameters);
            if(!is_null($instance)){
                $methodParameters[]=$instance;
            }elseif(!isset($parameters[$name]) && $parameter->isDefaultValueAvailable()){
                $methodParameters[]=$parameter->getDefaultValue();
            }else{
                $methodParameters[]=isset($parameters[$name]) ? $parameters[$name] : null;
            }
        }
        return $methodParameters;
    }

修改之后完全按照名稱和類型注入控制器方法參數，代碼變得更簡潔，功能也更強大了！

如果參數沒有在路由中定義並且未提供默認值，那么將以null注入。

本文為原創文章，版權歸作者所有，轉載請注明來源