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

  在laravel5.5中,可以根据控制器方法的参数类型,自动注入一个实例化对象,极大提升了编程的效率,但是相比较与Java的SpringMVC框架,功能还是有所欠缺,使用起来还是不太方便,主要体现在方法参数的注入不完全是按照参数名称进行的,如果改变了传入参数的顺序会导致类型不匹配的错误。

一、控制器方法参数注入步骤设计

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

Route::get(‘/diary/show/{diary}/{page?}‘,‘Diary\[email protected]‘);

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

时间: 2024-10-20 05:26:30

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

Angularjs MVC 以及 $scope 作用域 Angularjs 模块 的 run 方法 以及依赖注入中代码压缩问题

Angularjs MVC 以及 $scope 作用域 Angularjs 模块的 run 方法 以及依赖注入中代码压缩问题 1. Angularjs MVCModel:数据模型层View:视图层,负责展示Controller:业务逻辑和控制逻辑优点: 代码模块化 代码逻辑比较清晰.可移值性高,后期维护方便.代码复用,代码规模越来越大的时候,切分职责是大势所趋缺点:运行效率稍微低一些2. Angularjs $scope 作用域1. $scope 多控制器单独作用域<!DOCTYPE html>

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

spring泛型依赖注入原理 不管三七二十一 servlet :加注解@servlet service:加注解@service dao:加注解@Repository 这相当于在容器中注册这些个类 原文地址:https://www.cnblogs.com/yanl55555/p/11744077.html

2.Angular框架-$watch,创建控制器的方式,依赖注入原理,ng-repeat,ng-class

1.1. 在Angular中使用"jQuery" 语法:angular.element Angular中操作的功能称为:jqLite(轻量级jQuery) 1.1.1. 示例 // 获取 jqLite 对象 var $ = angular.element; $(document).ready(function() { }); 1.1.2. 注意点 1 jqLite 中只实现了jQuery的部分功能 2 jqLite中选择器只能是DOM对象 3 尽量使用ng中提供的功能 1.2. Ang

基于反射的通过set方法的依赖注入,可以看成一种设计模式,自己来用

非常好用,在properties文件中配置字符串和类名之间的对应,在程序里读取文件,找到类名,通过反射,达到调用set方法的目的,然后直接将自己的指向其他类的对象的引用赋值,指向实体对象. 比如userservice类,(当然spring用这个方法依赖注入好了,但是会这个原理,可以在某些时候方便自己用) 有一个userDao要注入,可以让userservice继承一个baseService类,在baseService类的构造方法中,定义一个反射方法,这样每次实例化userService的时候,它

spring 配置bean的方法及依赖注入发方式

Bean 的配置方式:通过全类名(反射).通过工厂方法(静态工厂方法 & 实例工厂方法).FactoryBean 这里依据全类名配置bean <bean id="helloWord" class="com.spring.HelloWord"> <property name="userName" value="springsss"></property> </bean> 依

.NET 用 Unity 依赖注入&mdash;&mdash;注册和解析类型

Unity Unity Application Block (Unity)是一个轻量级的,可扩展的依赖注入容器,它支持构造函数注入,属性注入和方法调用注入.它为开发人员提供了以下优点: 提供简化的对象创建,特别是层级对象结构和依赖,简化应用程序代码: 支持需求抽象:这可以让开发者在运行时或是配置文件指定依赖,简化横切关注点(crosscutting concerns)的管理: 通过延迟组件配置到容器,增加了灵活性: 具有服务定位器功能:这可以让客户存储或缓存容器.对 ASP.NET Web 应用

Spring学习笔记——Spring依赖注入原理分析

我们知道Spring的依赖注入有四种方式,分别是get/set方法注入.构造器注入.静态工厂方法注入.实例工厂方法注入 下面我们先分析下这几种注入方式 1.get/set方法注入 public class SpringAction { //注入对象springDao private SpringDao springDao; //一定要写被注入对象的set方法 public void setSpringDao(SpringDao springDao) { this.springDao = spri

【架构师之路】依赖注入原理---IoC框架

1 IoC理论的背景    我们都知道,在采用面向对象方法设计的软件系统中,它的底层实现都是由N个对象组成的,所有的对象通过彼此的合作,最终实现系统的业务逻辑.  图1:软件系统中耦合的对象 如果我们打开机械式手表的后盖,就会看到与上面类似的情形,各个齿轮分别带动时针.分针和秒针顺时针旋转,从而在表盘上产生正确的时间.图1中描述的就是这样的一个齿轮组,它拥有多个独立的齿轮,这些齿轮相互啮合在一起,协同工作,共同完成某项任务.我们可以看到,在这样的齿轮组中,如果有一个齿轮出了问题,就可能会影响到整

Spring MVC控制器方法参数类型

HttpServletRequest Spring会自动将 Servlet API 作为参数传过来 HttpServletResponse InputStream 相当于request,getInputStream() 获取请求区内容字节流 OutputStream 相当于request.getOutputStream() 获取响应区内容字节流 Reader request.getReader() Writer request.getWriter() 注意InputStream/OutputSt