基於laravel10
分析
這裡不分析是怎麼走到路由的,只分析路由是怎麼匹配的
直接看Illuminate\Routing\Router
類的findRoute
方法
這裡是去查詢對應的路由
看一下這個方法做了什麼處理
$this->routes = new RouteCollection;
protected function findRoute($request)
{
$this->events->dispatch(new Routing($request));
//這裡是去匹配路由
$this->current = $route = ①$this->routes->match($request);
$route->setContainer($this->container);
$this->container->instance(Route::class, $route);
return $route;
}
①看一下Illuminate\Routing\RouteCollection
類的match
方法做了什麼處理
public function match(Request $request)
{
//前面的文章分析了路由是怎麼註冊的,每個請求方法都對應一個路由陣列
//這裡就是去獲取當前請求對應的路由陣列
$routes = $this->get($request->getMethod());
//這裡是去看路由陣列中是否存在匹配的路由
$route = ②$this->matchAgainstRoutes($routes, $request);
//這裡是處理匹配到的路由 最後面再來分析這個
return $this->handleMatchedRoute($request, $route);
}
②看一下Illuminate\Routing\RouteCollection
類的matchAgainstRoutes
方法做了什麼處理
protected function matchAgainstRoutes(array $routes, $request, $includingMethod = true)
{
//這裡是把回退路由和普通理由分離
[$fallbacks, $routes] = collect($routes)->partition(function ($route) {
return $route->isFallback;
});
//把回退路由放到最後面去防止干擾路由匹配
return $routes->merge($fallbacks)->first(
fn (Route $route) => ③$route->matches($request, $includingMethod)
);
}
③看一下Illuminate\Routing\Route
類的matches
方法做了什麼處理
public function matches(Request $request, $includingMethod = true)
{
//這裡是重點
//編譯路由
④$this->compileRoute();
//這裡就是去匹配規則
foreach (self::getValidators() as $validator) {
//!$includingMethod 這個是用於沒有在對應的請求方法中找到路由的時候 查詢其他方式中是否存在 存在就丟擲一個405的異常
if (! $includingMethod && $validator instanceof MethodValidator) {
continue;
}
//這裡就是去呼叫對應類的matches方法 看是否能匹配
if (! $validator->matches($this, $request)) {
return false;
}
}
}
public static function getValidators()
{
if (isset(static::$validators)) {
return static::$validators;
}
return static::$validators = [
//驗證路徑
new UriValidator,
//驗證方法
new MethodValidator,
//驗證協議
new SchemeValidator,
//驗證域名
new HostValidator,
];
}
④看一下Illuminate\Routing\Route
類的compileRoute
方法做了什麼處理
protected function compileRoute()
{
if (! $this->compiled) {
//這裡是交給了Symfony的路由元件去做處理了
$this->compiled = ⑤$this->toSymfonyRoute()->compile();
}
return $this->compiled;
}
④看一下Illuminate\Routing\Route
類的toSymfonyRoute
方法做了什麼處理
use Symfony\Component\Routing\Route as SymfonyRoute;
public function toSymfonyRoute()
{
//這裡是例項化Symfony的路由元件
return new ⑤SymfonyRoute(
//去掉引數可選(路徑去掉引數問號)
preg_replace('/\{(\w+?)\?\}/', '{$1}', $this->uri()),
//獲取可選引數
$this->getOptionalParameterNames(),
//正規表示式陣列
$this->wheres,
//選項引數 固定傳入這個
['utf8' => true],
//獲取domain
$this->getDomain() ?: '',
//協議http/https
[],
//路由請求方法
$this->methods
);
}
protected function getOptionalParameterNames()
{
//匹配可選引數
preg_match_all('/\{(\w+?)\?\}/', $this->uri(), $matches);
//用引數名稱為key 值填充null
return isset($matches[1]) ? array_fill_keys($matches[1], null) : [];
}
⑤看一下Symfony\Component\Routing\Route
類的__construct
建構函式做了什麼處理
public function __construct(string $path, array $defaults = [], array $requirements = [], array $options = [], ?string $host = '', string|array $schemes = [], string|array $methods = [], ?string $condition = '')
{
$this->setPath($path);
$this->addDefaults($defaults);
$this->addRequirements($requirements);
$this->setOptions($options);
$this->setHost($host);
$this->setSchemes($schemes);
$this->setMethods($methods);
$this->setCondition($condition);
}
public function setPath(string $pattern): static
{
//這個在下面有說明
$pattern = $this->extractInlineDefaultsAndRequirements($pattern);
$this->path = '/'.ltrim(trim($pattern), '/');
$this->compiled = null;
return $this;
}
public function addDefaults(array $defaults): static
{
//這裡先不用看 這個是Symfony 路由元件的特殊路由引數
if (isset($defaults['_locale']) && $this->isLocalized()) {
unset($defaults['_locale']);
}
foreach ($defaults as $name => $default) {
$this->defaults[$name] = $default;
}
$this->compiled = null;
return $this;
}
public function addRequirements(array $requirements): static
{
//這裡先不用看 這個是Symfony 路由元件的特殊路由引數
if (isset($requirements['_locale']) && $this->isLocalized()) {
unset($requirements['_locale']);
}
foreach ($requirements as $key => $regex) {
$this->requirements[$key] = $this->sanitizeRequirement($key, $regex);
}
$this->compiled = null;
return $this;
}
public function setOptions(array $options): static
{
$this->options = [
'compiler_class' => \Symfony\Component\Routing\RouteCompiler::class,
];
return $this->addOptions($options);
}
public function setHost(?string $pattern): static
{
//這裡和setPath方法中的方法相同 下面有說明
$this->host = $this->extractInlineDefaultsAndRequirements((string) $pattern);
$this->compiled = null;
return $this;
}
public function setSchemes(string|array $schemes): static
{
$this->schemes = array_map('strtolower', (array) $schemes);
$this->compiled = null;
return $this;
}
public function setMethods(string|array $methods): static
{
$this->methods = array_map('strtoupper', (array) $methods);
$this->compiled = null;
return $this;
}
public function setCondition(?string $condition): static
{
$this->condition = (string) $condition;
$this->compiled = null;
return $this;
}
private function extractInlineDefaultsAndRequirements(string $pattern): string
{
if (false === strpbrk($pattern, '?<')) {
return $pattern;
}
//這裡是路由引數是否有預設值和正則驗證
//例如 'a.b.{ccc<[a-z]+>?dasd}'
return preg_replace_callback('#\{(!?)([\w\x80-\xFF]++)(<.*?>)?(\?[^\}]*+)?\}#', function ($m) {
//以上面例子說明
//$m[4]是第四個捕獲組中的值(這裡是?dasd) (字串可以用陣列的方式去下標 就是對應的第幾位字元)
if (isset($m[4][0])) {
//設定預設值 $m[2]就是第二個捕獲組中的值(這裡是ccc)
//如果只有問號 那預設值就是null 否則就是問號後面的值為預設值(這裡是dasd)
$this->setDefault($m[2], '?' !== $m[4] ? substr($m[4], 1) : null);
}
///$m[3]是第三個捕獲組中的值(這裡是<[a-z]+>)
if (isset($m[3][0])) {
//設定正則驗證
//substr($m[3], 1, -1) 這裡就是過濾兩邊的"<>"得到裡面的正規表示式
$this->setRequirement($m[2], substr($m[3], 1, -1));
}
return '{'.$m[1].$m[2].'}';
}, $pattern);
}
⑤初始化完Symfony路由元件後,會呼叫Symfony路由元件的compile
方法
看一下這個方法做了什麼處理
public function compile(): CompiledRoute
{
if (null !== $this->compiled) {
return $this->compiled;
}
//這裡就是拿setOption方法中設定的compiler_class
//對應Symfony\Component\Routing\RouteCompiler類
$class = $this->getOption('compiler_class');
return $this->compiled = ⑥$class::compile($this);
}
⑥看一下Symfony\Component\Routing\RouteCompiler
類的compile
方法做了什麼處理
public static function compile(Route $route): CompiledRoute
{
$hostVariables = [];
$variables = [];
$hostRegex = null;
$hostTokens = [];
//是否設定了host(對應laravel中的domain)
if ('' !== $host = $route->getHost()) {
//編譯匹配
$result = ⑦self::compilePattern($route, $host, true);
$hostVariables = $result['variables'];
$variables = $hostVariables;
$hostTokens = $result['tokens'];
$hostRegex = $result['regex'];
}
//這裡是symfony路由元件的特殊路由引數 這裡先不分析這個
$locale = $route->getDefault('_locale');
if (null !== $locale && null !== $route->getDefault('_canonical_route') && preg_quote($locale) === $route->getRequirement('_locale')) {
unset($requirements['_locale']);
$route->setRequirements($requirements);
$route->setPath(str_replace('{_locale}', $locale, $route->getPath()));
}
$path = $route->getPath();
//這裡和host一樣 也是編譯匹配
$result = self::compilePattern($route, $path, false);
$staticPrefix = $result['staticPrefix'];
$pathVariables = $result['variables'];
foreach ($pathVariables as $pathParam) {
//這裡也是symfony路由元件的特殊路由引數 這裡先不分析這個
if ('_fragment' === $pathParam) {
throw new \InvalidArgumentException(sprintf('Route pattern "%s" cannot contain "_fragment" as a path parameter.', $route->getPath()));
}
}
$variables = array_merge($variables, $pathVariables);
$tokens = $result['tokens'];
$regex = $result['regex'];
return new CompiledRoute(
$staticPrefix,
$regex,
$tokens,
$pathVariables,
$hostRegex,
$hostTokens,
$hostVariables,
array_unique($variables)
);
}
⑦看一下Symfony\Component\Routing\RouteCompiler
類的compilePattern
方法做了什麼處理
private static function compilePattern(Route $route, string $pattern, bool $isHost): array
{
$tokens = [];
$variables = [];
$matches = [];
$pos = 0;
//因為host和path都會來這裡 如果是host 預設分隔符是"." 反之 預設分隔符是"/"
$defaultSeparator = $isHost ? '.' : '/';
//這裡是驗證host和path 是否是utf8編碼字元
$useUtf8 = preg_match('//u', $pattern);
//這裡是字元是否必須是utf8編碼字元
$needsUtf8 = $route->getOption('utf8');
//英文字元的編碼在\x01-\x79(1-127)之間,[\x80-\xff]表示非ASCII碼字元,匹配中文字元
//如果字元不需要是utf8編碼字元 且 使用了utf8字元 且是存在中文字元 就丟擲異常
if (!$needsUtf8 && $useUtf8 && preg_match('/[\x80-\xFF]/', $pattern)) {
throw new \LogicException(sprintf('Cannot use UTF-8 route patterns without setting the "utf8" option for route "%s".', $route->getPath()));
}
//使用了不是utf8編碼字元 且 字元是否必須是utf8編碼字元 就丟擲異常
if (!$useUtf8 && $needsUtf8) {
throw new \LogicException(sprintf('Cannot mix UTF-8 requirements with non-UTF-8 pattern "%s".', $pattern));
}
//這裡是匹配路由引數
//\PREG_OFFSET_CAPTURE 匹配返回時會增加它相對目標字串的位元組偏移量
//\PREG_SET_ORDER 結果排序為$matches[0]包含第一次匹配得到的所有匹配(包含子組), $matches[1]是包含第二次匹配到的所有匹配(包含子組)的陣列,以此類推。
preg_match_all('#\{(!)?([\w\x80-\xFF]+)\}#', $pattern, $matches, \PREG_OFFSET_CAPTURE | \PREG_SET_ORDER);
foreach ($matches as $match) {
//這裡就是檢測是否存在"!" 後面會說這個的作用
$important = $match[1][1] >= 0;
//拿到路由引數名
$varName = $match[2][0];
//這裡是獲取當前路由引數前的靜態文字
//例如 /a/b.{num1}/c/{num2}
//靜態文字就是/a/b. 和 /c/
$precedingText = substr($pattern, $pos, $match[0][1] - $pos);
//這裡是把下標移到當前路由引數的最後一位字元後一位
$pos = $match[0][1] + \strlen($match[0][0]);
//如果前面的靜態文字為空
if (!\strlen($precedingText)) {
//前面一位字元設定為空
$precedingChar = '';
} elseif ($useUtf8) {
//匹配當前靜態文字的最後一位字元
preg_match('/.$/u', $precedingText, $precedingChar);
//獲取到最後一位字元
$precedingChar = $precedingChar[0];
} else {
//獲取到最後一位字元
$precedingChar = substr($precedingText, -1);
}
//是否為分隔符
//public const SEPARATORS = '/,;.:-_~+*=@|'; 這些字元都是分隔符
$isSeparator = '' !== $precedingChar && str_contains(static::SEPARATORS, $precedingChar);
//變數不能是以數字開頭
if (preg_match('/^\d/', $varName)) {
throw new \DomainException(sprintf('Variable name "%s" cannot start with a digit in route pattern "%s". Please use a different name.', $varName, $pattern));
}
//路由引數名不能一樣
if (\in_array($varName, $variables)) {
throw new \LogicException(sprintf('Route pattern "%s" cannot reference variable name "%s" more than once.', $pattern, $varName));
}
///路由引數名超過設定的最大長度
if (\strlen($varName) > self::VARIABLE_MAXIMUM_LENGTH) {
throw new \DomainException(sprintf('Variable name "%s" cannot be longer than %d characters in route pattern "%s". Please use a shorter name.', $varName, self::VARIABLE_MAXIMUM_LENGTH, $pattern));
}
//如果是分隔符 且 文字不等於分隔符 證明前面有靜態文字
if ($isSeparator && $precedingText !== $precedingChar) {
//當前這個token就被標記為text 去掉最後的分隔符
$tokens[] = ['text', substr($precedingText, 0, -\strlen($precedingChar))];
}
//如果不是分隔符 且 靜態文字不是空
elseif (!$isSeparator && '' !== $precedingText) {
//當前這個token就被標記為text 因為沒有分隔符 所以不用去掉最後的分隔符
$tokens[] = ['text', $precedingText];
}
//獲取路由引數的正規表示式
$regexp = $route->getRequirement($varName);
if (null === $regexp) {
//如果沒有正規表示式 建立一個正規表示式
//這裡是拿到當前路由引數的後面的字串
$followingPattern = (string) substr($pattern, $pos);
//這裡是拿到後一個分隔符 禁止使用者輸入這個符號
$nextSeparator = self::findNextSeparator($followingPattern, $useUtf8);
//這個正規表示式就是排除/和下一個分隔符
//例如 [^/@]+ [^/]+
$regexp = sprintf(
'[^%s%s]+',
preg_quote($defaultSeparator),
$defaultSeparator !== $nextSeparator && '' !== $nextSeparator ? preg_quote($nextSeparator) : ''
);
//如果(沒有下一個分隔符 且 不是以路由引數開頭) 或者 當前路由引數的後面的字串為空
if (('' !== $nextSeparator && !preg_match('#^\{[\w\x80-\xFF]+\}#', $followingPattern)) || '' === $followingPattern) {
//這裡是最佳化正則 防止無用的正則回溯
$regexp .= '+';
}
} else {
// 存在正規表示式
//如果正規表示式存在不是utf8編碼字元
if (!preg_match('//u', $regexp)) {
$useUtf8 = false;
}
//如果不需要utf8編碼 但是這個正則存在utf8編碼字元 (這個正規表示式的後半部分我沒怎麼看懂,整體意思應該是存在utf8編碼字元)
elseif (!$needsUtf8 && preg_match('/[\x80-\xFF]|(?<!\\\\)\\\\(?:\\\\\\\\)*+(?-i:X|[pP][\{CLMNPSZ]|x\{[A-Fa-f0-9]{3})/', $regexp)) {
throw new \LogicException(sprintf('Cannot use UTF-8 route requirements without setting the "utf8" option for variable "%s" in pattern "%s".', $varName, $pattern));
}
if (!$useUtf8 && $needsUtf8) {
throw new \LogicException(sprintf('Cannot mix UTF-8 requirement with non-UTF-8 charset for variable "%s" in pattern "%s".', $varName, $pattern));
}
//這裡是給有括號的地方在(後面加一個 ?: 不捕獲這個 這裡就不貼這個程式碼了
$regexp = self::transformCapturingGroupsToNonCapturings($regexp);
}
//這裡就是上面那個"!"
if ($important) {
//最後一位元素標記為true 後面還會說明
//當前token 標記為variable 第二個元素是 前面一位是否是分隔符
$token = ['variable', $isSeparator ? $precedingChar : '', $regexp, $varName, false, true];
} else {
$token = ['variable', $isSeparator ? $precedingChar : '', $regexp, $varName];
}
$tokens[] = $token;
$variables[] = $varName;
}
//這裡的意思是最後一段是靜態文字
if ($pos < \strlen($pattern)) {
$tokens[] = ['text', substr($pattern, $pos)];
}
//第一個可選的路由引數 先初始化一個值
$firstOptional = \PHP_INT_MAX;
//這裡是隻處理path
//應該是host上的引數都是必填的吧 不然host就不是正常的host了
if (!$isHost) {
//從後往前面處理 因為如果一個引數後面存在靜態文字 就算設定了可選 也是不生效的 也是需要必填的
for ($i = \count($tokens) - 1; $i >= 0; --$i) {
$token = $tokens[$i];
// variable is optional when it is not important and has a default value
//!($token[5] ?? false) 這個就是那個"!"的作用 如果設定了"!" 那前面的引數就算有"?"也會不生效了 感嘆號感覺就是必填的意思(如果沒有感嘆號和問號都沒有 也是必填)
if ('variable' === $token[0] && !($token[5] ?? false) && $route->hasDefault($token[3])) {
$firstOptional = $i;
} else {
break;
}
}
}
//這裡就是去組裝正規表示式
$regexp = '';
for ($i = 0, $nbToken = \count($tokens); $i < $nbToken; ++$i) {
//編譯正則 下面有說明
$regexp .= self::computeRegexp($tokens, $i, $firstOptional);
}
$regexp = '{^'.$regexp.'$}sD'.($isHost ? 'i' : '');
// enable Utf8 matching if really required
if ($needsUtf8) {
$regexp .= 'u';
for ($i = 0, $nbToken = \count($tokens); $i < $nbToken; ++$i) {
if ('variable' === $tokens[$i][0]) {
$tokens[$i][4] = true;
}
}
}
return [
//這裡是確定路由可能的最長靜態字首
'staticPrefix' => self::determineStaticPrefix($route, $tokens),
'regex' => $regexp,
'tokens' => array_reverse($tokens),
'variables' => $variables,
];
}
private static function computeRegexp(array $tokens, int $index, int $firstOptional): string
{
$token = $tokens[$index];
if ('text' === $token[0]) {
//如果是文字 就直接轉義返回
return preg_quote($token[1]);
} else {
// 如果是變數
//這裡表示整個path都是路由引數 不然$firstOptional不為0 中間有任何靜態文字都不會為0
//我感覺這個if 和直接和else合併 直接使用else中的程式碼 (不清楚這裡有什麼特殊含義)
if (0 === $index && 0 === $firstOptional) {
//所以這裡是可選 最後一位是?
return sprintf('%s(?P<%s>%s)?', preg_quote($token[1]), $token[3], $token[2]);
} else {
$regexp = sprintf('%s(?P<%s>%s)', preg_quote($token[1]), $token[3], $token[2]);
//如果下標大於等於第一個可選 證明後面的都是可選
if ($index >= $firstOptional) {
//?:不捕獲組
$regexp = "(?:$regexp";
$nbTokens = \count($tokens);
if ($nbTokens - 1 == $index) {
//舉例 ((()?)?)? 就是前面加了多少個括號 後面就補多少個")?"
$regexp .= str_repeat(')?', $nbTokens - $firstOptional - (0 === $firstOptional ? 1 : 0));
}
}
return $regexp;
}
}
}
在Laravel框架中,只用到了regex這個key,其他key好像沒有用到,好了,Symfony路由元件編譯就分析完了
回到Illuminate\Routing\RouteCollection
類的match
方法,在這個方法最後還有呼叫了一個方法,在上面說到最後來分析這個方法
看一下Illuminate\Routing\RouteCollection
類的handleMatchedRoute
方法做了什麼處理
protected function handleMatchedRoute(Request $request, $route)
{
if (! is_null($route)) {
return ⑧$route->bind($request);
}
//後續操作就是沒有匹配到路由的時候
...
}
⑧看一下Illuminate\Routing\Route
類的bind
方法做了什麼處理
public function bind(Request $request)
{
//這裡是編譯路由 上面已經分析了
$this->compileRoute();
//這裡是解析路由引數
$this->parameters = ⑨(new RouteParameterBinder($this))
->parameters($request);
//這裡是原始引數 因為parameters有的引數會轉化為模型
$this->originalParameters = $this->parameters;
return $this;
}
⑨看一下Illuminate\Routing\RouteParameterBinder
類的parameters
方法做了什麼處理
public function parameters($request)
{
//繫結路徑引數
$parameters = $this->bindPathParameters($request);
if (! is_null($this->route->compiled->getHostRegex())) {
//繫結host引數
$parameters = $this->bindHostParameters(
$request, $parameters
);
}
//將null引數替換為其預設值
return $this->replaceDefaults($parameters);
}
protected function bindPathParameters($request)
{
$path = '/'.ltrim($request->decodedPath(), '/');
//這裡就是獲取捕獲組的引數
preg_match($this->route->compiled->getRegex(), $path, $matches);
//匹配key
return $this->matchToKeys(array_slice($matches, 1));
}
protected function bindHostParameters($request, $parameters)
{
//這裡就是獲取捕獲組的引數
preg_match($this->route->compiled->getHostRegex(), $request->getHost(), $matches);
//匹配合並
return array_merge($this->matchToKeys(array_slice($matches, 1)), $parameters);
}
protected function matchToKeys(array $matches)
{
if (empty($parameterNames = $this->route->parameterNames())) {
return [];
}
//取交集
$parameters = array_intersect_key($matches, array_flip($parameterNames));
//過濾空的
return array_filter($parameters, function ($value) {
return is_string($value) && strlen($value) > 0;
});
}
protected function replaceDefaults(array $parameters)
{
foreach ($parameters as $key => $value) {
$parameters[$key] = $value ?? Arr::get($this->route->defaults, $key);
}
//迴圈預設值陣列
foreach ($this->route->defaults as $key => $value) {
if (! isset($parameters[$key])) {
$parameters[$key] = $value;
}
}
return $parameters;
}
看一下Illuminate\Routing\RouteCollection
類的handleMatchedRoute
方法後續做了什麼處理
protected function handleMatchedRoute(Request $request, $route)
{
...
//後續操作就是沒有匹配到路由的時候
//這裡是去獲取除了當前請求方法外的剩餘的方法 去裡面找看能否找到匹配的
$others = $this->checkForAlternateVerbs($request);
if (count($others) > 0) {
return $this->getRouteForMethods($request, $others);
}
throw new NotFoundHttpException(sprintf(
'The route %s could not be found.',
$request->path()
));
}
protected function getRouteForMethods($request, array $methods)
{
//這裡是OPTIONS請求
if ($request->isMethod('OPTIONS')) {
return (new Route('OPTIONS', $request->path(), function () use ($methods) {
return new Response('', 200, ['Allow' => implode(',', $methods)]);
}))->bind($request);
}
//這裡就是丟擲方法不被允許的異常
$this->requestMethodNotAllowed($request, $methods, $request->method());
}
protected function requestMethodNotAllowed($request, array $others, $method)
{
throw new MethodNotAllowedHttpException(
$others,
sprintf(
'The %s method is not supported for route %s. Supported methods: %s.',
$method,
$request->path(),
implode(', ', $others)
)
);
}
以上就是路由匹配大概流程了,如果有寫的有誤的地方,請大佬們指正
本作品採用《CC 協議》,轉載必須註明作者和本文連結