在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注入。

本文为原创文章,版权归作者所有,转载请注明来源




关于laravel5.5控制器方法参数依赖注入原理深度解析及问题修复的更多相关文章

  1. SQL注入原理深度解析

    本文转自:http://www.iii-soft.com/forum.php?mod=viewthread&tid=1613&extra=page%3D1 对于Web应用来说,注射式攻 ...

  2. 第1课:SQL注入原理深度解析

    对于Web应用来说,注射式攻击由来已久,攻击方式也五花八门,常见的攻击方式有SQL注射.命令注射以及新近才出现的XPath注射等等.本文将以SQL注射为例,在源码级对其攻击原理进行深入的讲解. 一.注 ...

  3. @Bean修饰的方法参数的注入方式

    @Bean修饰的方法参数的注入方式: 方法参数默认注入方式为Autowired,即先根据类型匹配,若有多个在根据名称进行匹配. 1:复杂类型可以通过@Qualifier(value=“XXX”)限定; ...

  4. PHP依赖注入原理与用法分析

    https://www.jb51.net/article/146025.htm 本文实例讲述了PHP依赖注入原理与用法.分享给大家供大家参考,具体如下: 引言 依然是来自到喜啦的一道面试题,你知道什么 ...

  5. Spring依赖注入原理分析

    在分析原理之前我们先回顾下依赖注入的概念: 我们常提起的依赖注入(Dependency Injection)和控制反转(Inversion of Control)是同一个概念.具体含义是:当某个角色( ...

  6. 【串线篇】spring泛型依赖注入原理

    spring泛型依赖注入原理 不管三七二十一 servlet :加注解@servlet service:加注解@service dao:加注解@Repository 这相当于在容器中注册这些个类

  7. ASP.NET Core MVC 控制器创建与依赖注入

    本文翻译自<Controller activation and dependency injection in ASP.NET Core MVC>,由于水平有限,故无法保证翻译完全准确,欢 ...

  8. Spring-Context之六:基于Setter方法进行依赖注入

    上文讲了基于构造器进行依赖注入,这里讲解基于Setter方法进行注入.在Java世界中有个约定(Convention),那就是属性的设置和获取的方法名一般是:set+属性名(参数)及get+属性名() ...

  9. laravel5.2总结--服务容器(依赖注入,控制反转)

    1.依赖 我们定义两个类:class Supperman 和 class Power,现在我们要使用Supperman ,而Supperman 依赖了Power class Supperman { p ...

随机推荐

  1. StringBuffer类的构造方法

    public StringBuffer():无参构造方法 public StringBuffer(int capacity):指定容量的字符串缓冲区对象(默认是16个字符) public String ...

  2. linux文件权限解析(摘)

    用户组 在linux中的每个用户必须属于一个组,不能独立于组外.在linux中每个文件有所有者.所在组.其它组的概念 - 所有者 - 所在组 - 其它组 - 改变用户所在的组 所有者 一般为文件的创建 ...

  3. Happy 2006 poj2773

    Happy 2006 Time Limit: 3000MS   Memory Limit: 65536K Total Submissions: 9049   Accepted: 3031 Descri ...

  4. 用python爬虫爬取去哪儿4500个热门景点,看看国庆不能去哪儿

    前言:本文建议有一定Python基础和前端(html,js)基础的盆友阅读. 金秋九月,丹桂飘香,在这秋高气爽,阳光灿烂的收获季节里,我们送走了一个个暑假余额耗尽哭着走向校园的孩籽们,又即将迎来一年一 ...

  5. Django进阶篇【1】

    注:本篇是Django进阶篇章,适合人群:有Django基础,关于Django基础篇,将在下一章节中补充! 首先我们一起了解下Django整个请求生命周期: Django 请求流程,生命周期: 路由部 ...

  6. php根据ip段以及子网掩码,判断某ip是否处于某子网下

        为了检测客户端ip是否位于指定的网络里(如防火墙过滤有时候需要用到这个技术),有如下方法: 1.第一种 public function netMatch($client_ip, $server ...

  7. C#分布式事务解决方案-TransactionScope

    引用一下别人的导读:在实际开发工作中,执行一个事件,然后调用另一接口插入数据,如果处理逻辑出现异常,那么之前插入的数据将成为垃圾数据,我们所希望的是能够在整个这个方法定义为一个事务,Transacti ...

  8. mysq参数sql_safe_updates限制范围

    在mysql运维中出现过不少因为update/delete条件错误导致数据被误更新或者删除的case,为避免类似问题的发生,可以用sql_safe_updates参数来对update/delete做限 ...

  9. 使用Entify Framework 6.x的事务操作

    public void TransactionsTest() { using (var context = new testContext()) { //使用EF事务 在vs2013中先升级Entit ...

  10. [C#]Winform后台提交数据且获取远程接口返回的XML数据,转换成DataSet

    #region 接口返回的Xml转换成DataSet /// <summary> /// 返回的Xml转换成DataSet /// </summary> /// <par ...