ThinkPHP6 源码分析之中间件分析

中间件

从请求过程中可以看出,第一步就是加载的中间件。那么如何加载的呢?看下面这段代码

$this->app->middleware

让 app 实例访问属性 middleware?你会发现实例中并没有这个属性,那么访问一个不存在的属性会发生什么呢?它会去访问 __get 魔术方法,你有这个想法之后会在 Container 中发现这个魔术方法,最终它会去 make 创建对象,对于 make 的过程请到 解析 Request 章节查看。
创建 middleware 的过程中有一个细节,就是加载配置文件 middleware.php,进入到 think\Middleware 文件之后,你会发现这么一段代码。

public static function __make(App $app, Config $config)
{
    return (new static($config->get('middleware')))->setApp($app);
}

正如之前所提到的那样,使用 make 方法创建对象会执行默认方法 __make,所以这个时候就会将 config 中的 middleware.php 加载进来。目前这个版本似乎没有加入这个配置文件,你可以手动添加。

来看下面一段代码,从这段代码引出中间件的加载过程。

$this->app->middleware->import(include $this->app->getBasePath() . 'middleware.php');

在整个请求过程,首先加载的是 app/middleware.php 文件中的中间件,默认提供了四个中间件。但是这些都是不加载,你可自行选择打开。然后来看看 import 如何加载的。

public function import(array $middlewares = [], string $type = 'route'): void
{
    foreach ($middlewares as $middleware) {
        $this->add($middleware, $type);
    }
}

$type 参数标记了路由的类型,目前只看到 routecontroller 两种类型。默认全局中间件是 route 类型的。add 方法才是实实在在的导入。来看看的这个方法做了哪些事儿。

public function add($middleware, string $type = 'route'): void
{
    // null 直接返回
    if (is_null($middleware)) {
        return;
    }
    // 创建中间件
    $middleware = $this->buildMiddleware($middleware, $type);
    // 加入到中间件队列,队列也是分类型的
    if ($middleware) {
        $this->queue[$type][] = $middleware;
    }
}

buildMiddleware 方法用来创建中间件,做一些解析的工作。来看看代码的过程,直接在注释中解释

protected function buildMiddleware($middleware, string $type = 'route'): array
{
    // 数组类型的 第一个参数必须是中间件,第二个是传入的参数
    if (is_array($middleware)) {
        list($middleware, $param) = $middleware;
    }
    // 如果是 middleware 是闭包, 直接返回
    if ($middleware instanceof \Closure) {
        return [$middleware, $param ?? null];
    }
    // 不支持非字符串的类型
    if (!is_string($middleware)) {
        throw new InvalidArgumentException('The middleware is invalid');
    }
    // 支持键值对,正如官方手册中提到,例如这样 [ 'hello' => middleware ]
    if (isset($this->config[$middleware])) {
        $middleware = $this->config[$middleware];
    }
    // 当你从配置文件解析出来是数组格式,就递归调用
    if (is_array($middleware)) {
        $this->import($middleware, $type);
        return [];
    }
    // 最后返回一个 middware 的类名和默认方法 'handle'
   // handle 方法对中间件而言是必须的,不然无法执行
    return [[$middleware, 'handle'], $param ?? null];
}

然后返回会加入到 Queue 队列中,这个时候你打开全局中间件的其中一个话,队列中将会是这样的内容。

array(1) {
  ["route"]=>
  array(1) {
    [0]=>
    array(2) {
      [0]=>
      array(2) {
        [0]=>
        string(34) "think\middleware\CheckRequestCache"
        [1]=>
        string(6) "handle"
      }
      [1]=>
      NULL
    }
  }
}

这个和我们预期是一样的,在代码解释过程也没有遇到任何阻碍。我们继续往下看,这里仅仅是加入的过程,在后面请求执行的时候来看看如何执行的这些中间件的。

中间件执行

中间件的是由 Diapatch 方法执行,而核心在 resolve 方法,来看一下这个方法做了什么。

protected function resolve(string $type = 'route')
{
    return function (Request $request) use ($type) {
        $middleware = array_shift($this->queue[$type]);

        if (null === $middleware) {
            throw new InvalidArgumentException('The queue was exhausted, with no response returned');
        }
        // 1
        list($call, $param) = $middleware;
        // 2
        if (is_array($call) && is_string($call[0])) {
            $call = [$this->app->make($call[0]), $call[1]];
        }

        try {
             // 3
            $response = $this->app->invoke($call, [$request, $this->resolve($type), $param]);
        } catch (HttpResponseException $exception) {
            $response = $exception->getResponse();
        }

        if (!$response instanceof Response) {
            throw new LogicException('The middleware must return Response instance');
        }

        return $response;
    };
}

按照 1,2,3 的步骤进行说明。
队列使用了 array_shift 来进行,说明会执行先进来的中间件。所以你可以在到达控制器之前做很多业务应用初始化的事情。

  • 从上面可以知道中间件队列的数据结构,所以步骤以就是解析出来 middleware 中间件类和参数。
  • 如果是数组结构直接解析出对象
  • 最重要的就是第三步了,利用反射来执行中间件类,注意在这个执行过程中递归调用了,而且记住 resolve 返回的始终是闭包,然后在中间件之间传递,你可以观察中间件的 handle 方法的参数,Request 对象,第二个闭包,第三个可选参数,正好对上了这个数组参数接口,所以 handle 方法的 $next() 就是在消费队列。

所以简单来说,中间件的过程就是利用队列在执行消费。保证了中间件的顺序执行。

文章转载于 thinkphp6源码分析之中间件分析

讨论数量: 0
(= ̄ω ̄=)··· 暂无内容!

请勿发布不友善或者负能量的内容。与人为善,比聪明更重要!