ThinkPHP6 原始碼閱讀（六）：Url 解析

說明

接上篇，多應用解析之後（如果開啟的話），Http類的run方法裡面呼叫的runWithRequest方法還有以下事情要做（見程式碼註釋）：

protected function runWithRequest(Request $request)
{
    .
    .
    .
    // 設定開啟事件機制
    $this->app->event->withEvent($this->app->config->get('app.with_event', true));

    // 監聽HttpRun
    $this->app->event->trigger('HttpRun');
    // 是否開啟路由
    // 開啟的話將一個閉包賦值給$withRoute變數
    $withRoute = $this->app->config->get('app.with_route', true) ? function () {
        //載入路由檔案
        $this->loadRoutes();
    } : null;
    // 路由排程
    return $this->app->route->dispatch($request, $withRoute);
}

這裡先不分析路由解析和事件機制，在配置檔案中關閉路由解析，即在config/app.php中將 with_route設定為false。以下分析假設訪問的URL為www.tp6.com/demo/hello，並建立好了Demo控制器和hello操作——其程式碼如下：

<?php
namespace app\controller;

use app\BaseController;

class Demo extends BaseController
{
    public function hello($name = 'ThinkPHP6')
    {
        return 'hello,' . $name;
    }

}

Url解析

runWithRequest方法最後呼叫think\Route類的dispatch方法，該方法程式碼如下：

public function dispatch(Request $request, $withRoute = null)
{
    $this->request = $request;
    $this->host    = $this->request->host(true);
    //載入路由配置、快取等
    $this->init();

    if ($withRoute) {
        //儲存一個閉包
        $checkCallback = function () use ($request, $withRoute) {
            //載入路由
            //執行閉包，該閉包將會載入路由檔案
            $withRoute();
            return $this->check();
        };
        //如果開啟了路由快取
        if ($this->config['route_check_cache']) {
            $dispatch = $this->cache
                ->tag('route_cache')
                ->remember($this->getRouteCacheKey($request), $checkCallback);
        } else {
            $dispatch = $checkCallback();
        }
    } else {
        //如果沒有開啟路由，將執行這裡的語句
        //$this->path()得到PATHINFO，比如/demo/hello
        $dispatch = $this->url($this->path());
    }
    // $dispatch是think\route\dispatch\Url的例項，該類繼承了Controller類
    // 且該類中沒有init方法，所以這裡執行的是其父類的init方法
    $dispatch->init($this->app);

    $this->app->middleware->add(function () use ($dispatch) {
        try {
            $response = $dispatch->run();
        } catch (HttpResponseException $exception) {
            $response = $exception->getResponse();
        }
        return $response;
    });

    return $this->app->middleware->dispatch($request);
}

因為前面設定關閉了路由解析，所以這裡執行到else的語句：$dispatch = $this->url($this->path());，解析Url。Url方法如下：

public function url(string $url): UrlDispatch
{
    // 第三個引數為PATHINFO
    return new UrlDispatch($this->request, $this->group, $url);
}

該方法新建並返回一個think\route\dispatch\Url類的例項。我們來看看這個例項化都做了些什麼。think\route\dispatch\Url類的建構函式：

public function __construct(Request $request, Rule $rule, $dispatch, array $param = [], int $code = null)
{
    $this->request = $request;
    $this->rule    = $rule;
    // 解析預設的URL規則
    $dispatch = $this->parseUrl($dispatch);

    parent::__construct($request, $rule, $dispatch, $this->param, $code);
}

最主要的邏輯是在parseUrl方法：

protected function parseUrl(string $url): array
{
    // 獲取URL分隔符
    $depr = $this->rule->config('pathinfo_depr');
    // $this->rule->getRouter() 獲取路由物件
    // 獲取路由繫結
    $bind = $this->rule->getRouter()->getDomainBind();

    if ($bind && preg_match('/^[a-z]/is', $bind)) {
        $bind = str_replace('/', $depr, $bind);
        // 如果有模組/控制器繫結
        $url = $bind . ('.' != substr($bind, -1) ? $depr : '') . ltrim($url, $depr);
    }
    // $path為[控制器，操作]這樣組成的陣列，如["demo", "hello"]
    $path = $this->rule->parseUrlPath($url);
    if (empty($path)) {
        return [null, null];
    }

    // 解析控制器
    // 獲取控制器名
    $controller = !empty($path) ? array_shift($path) : null;
    // 檢查控制器是否合法
    // 正則匹配：開頭是字母，後面是0個到多個字母、下劃線或者點
    if ($controller && !preg_match('/^[A-Za-z][\w|\.]*$/', $controller)) {
        throw new HttpException(404, 'controller not exists:' . $controller);
    }

    // 解析操作
    $action = !empty($path) ? array_shift($path) : null;
    $var    = [];

    // 解析額外引數
    if ($path) {
        // 正則匹配：一個至多個字母，下劃線，中間是‘|’，結尾是非‘|’的任意字元，比如 hello|123
        preg_replace_callback('/(\w+)\|([^\|]+)/', function ($match) use (&$var) {
            $var[$match[1]] = strip_tags($match[2]);
        }, implode('|', $path));
    }

    $panDomain = $this->request->panDomain();
    if ($panDomain && $key = array_search('*', $var)) {
        // 泛域名賦值
        $var[$key] = $panDomain;
    }

    // 設定當前請求的引數
    $this->param = $var;

    // 封裝路由
    $route = [$controller, $action];
    // 如果路由被定義過
    if ($this->hasDefinedRoute($route)) {
        throw new HttpException(404, 'invalid request:' . str_replace('|', $depr, $url));
    }

    return $route;
}

整個過程有點繁瑣，分析見註釋，該方法最後返回一個控制器和操作組成的陣列，大概類似這樣：[$controller, $action]。

最終，dispatch方法的$dispatch = $this->url($this->path());語句得到一個think\route\dispatch\Url類的例項。該例項大概長這樣：