laravel5.5的控制器提供了根據方法參數類型,自動注入的能力。但是有時會略有不便,體現在方法參數的注入不完全是按照參數名稱進行的,如果改變了傳入參數的順序會導致類型不匹配的錯誤。本文從其註入的原理深度解析進行解決。
一、控制器方法參數注入步驟設計
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注入。
相關推薦:
#以上是laravel5.5控制器傳參順序問題及解決方案的詳細內容。更多資訊請關注PHP中文網其他相關文章!