插件窝 干货文章 ThinkPHP检测URL变量和规则路由是否匹配

ThinkPHP检测URL变量和规则路由是否匹配

margin bottom padding 编辑器 546    来源:    2024-10-27

本文接着上文继续来解读路由源码,如果你看到本文可以先看一下之前写的路由文章,共计俩篇。

前言

经过前俩篇路由源码的解读,相信大家对路由已经有了一定了了解了。

本文会接着ThinkPHP路由源码解析继续讲解,也是路由这块内容的收尾了,后面会在有一篇关于路由调度这块的内容就结束了,希望大家对路由有一个好的认识吧!

关于路由,咔咔感觉是整个框架中源码阅读最吃力的一个核心点,也耗费了很多时间。

因为在其中有很多类的嵌套,何不按照常理出牌,例如$this->group的这个点。

虽然就是一个简单的调用关系,但是在源码中执行的功能也是很多很多。

一般源码都会认为这个group就是简单的一个类,其实不然,最终返回的结果令人有点匪夷所思返回的是Domain这个类。

所以说对于框架的一切都需要认真的去理解,阅读源码主要是为了提升自己对框架的认识和框架的设计思想。

还是按照步骤来,先看矿机的执行流程图,然后大家就可以根据流程图进行清晰的阅读文章了。

后期的所有源码阅读都会直接添加到这里,进行补充。

框架执行流程

一、检测路由-合并分组参数、检查分组路由

上一篇的最后是讲的下图的位置,这个位置暂时还是空的,这个空的位置就是接下来要讲的合并分组参数。

参数合并其实就是将路由参数和默认的参数进行合并。

image.png
执行位置

为了能给大家清晰的展示出来执行流程,咔咔将执行流程圈了出来。

执行文件:

  1. thinkphp/library/think/App.php -> $dispatch = $this->route->check($path, $must);
  2. thinkphp/library/think/Route.php -> $result = $domain->check($this->request, $url, $completeMatch);
  3. thinkphp/library/think/route/Domain.php -> $result = $this->checkRouteAlias($request, $url); -> return parent::check($request, $url, $completeMatch);
  4. thinkphp/library/think/route/RuleGroup.php -> $this->mergeGroupOptions();

对应执行关系:

  1. 路由检测 返回一个Dispatch对象
  2. 检测域名路由
  3. 检测别名路由 -> 检测分组路由
  4. 合并分组参数
image.png
路由检测执行流程

可以看这一小节的标题为检测路由之路由参数、检查分组路由,那么在检测路由这里还是有很多的内容的。

只不过咔咔只是针对于合并分组参数、检查分组路由进行重点的讲解,终于其它的内容是没有贯穿到整条线的,就不去做过深的探讨了。

下一篇文章在控制器中会聊到一部分,但也不是全部都会写的哈!

合并分组参数

接下来先说这块的内容。

image.png
合并分组参数

在看这一块内容之前需要对$this->parent这个属性进行查看,看这个值是设置成了什么。

通过debug_backtrace()对其打印可以得知为Domain的实例化类。

image.png
打印结果

接下来就进入到mergeGroupOptions方法进行详解。

  • 执行的文件:thinkphp/library/think/route/RuleGroup.php  164行
  • $this->parent:class think\route\Domain
  • 获取路由参数定义,如果不存在路由参数为'merge_rule_regex' => bool(false),反正会在后边追加上路由参数
  • 合并分组参数:$this->mergeOptions : 需要和分组合并的路由参数'after', 'model', 'header', 'response', 'append', 'middleware'
  • 通过array_merge进行合并参数
  • 并将lockOption参数进行锁定
  • 并将合并的结果返回,最终返回结果$this->option

返回结果看下图image.png

最终返回结果

image.png
返回结果

说到底就是将路由参数进行合并,路由参数官方支持的请看下图,注意一下支持版本号。

一般情况下路由参数我们是不使用的,这里提出来就让大家知道有这个东西即可,如果坚持要用的话可以一定要把版本号看清楚,要不你会遇到很多麻烦。

image.png
支持的路由参数

检查分组路由

文件:thinkphp/library/think/route/RuleGroup.php  183行。

在这里首先需要明确一下关于$rules这个变量的值是什么。

image.png
检测分组路由

打印出$rules的值可以看出来有俩种情况。

第一种情况为不是资源路由。

第二种情况为资源路由。

image.png
$rules的值

这是因为咔咔在路由文件只设置了俩个路由,一个资源路由,一个非资源路由。

image.png
路由配置文件

根据上图圈出来的数据就可以知道当执行循环时$item这个值分为俩种情况。

  • 执行think\route\Resource Object中的check方法
  • 执行think\route\RuleItem Object中的check方法

根据神器的打印结果可以看到当为资源路由时 也是执行的thinkphp/library/think/route/RuleGroup.php类的check方法。

image.png
神器打印

为什么资源路由会执行thinkphp/library/think/route/RuleGroup.php的check

因为在resource类中继承的是RuleGroup类。

并且$item的值是Resource类的实例,所以会进行执行check方法。

所以说拥有神器是多么的重要,关于这个神器在之前的文章进行过深入的讲解如何使用,如果你还不会,或者不知道这个用法赶紧去看看哈!神器是可以直接打印出代码的执行流程,在调试源码的过程中是非常有用的。

image.png
继承关系

经过再一次的执行check方法,最终结果的返回是在下图咔咔圈的地方。

image.png
检测路由分组

非资源路由执行check

文件:thinkphp/library/think/route/RuleItem.php  行号231  此处就是非资源路由执行的方法。

image.png
非资源路由执行的方法

进到检测路由规则方法后,还是会合并路由参数。

image.png
检测路由

关于合并路由参数的方法,在上边已经说过了, 在这里就不多说了。

image.png
合并路由参数

直到这里关于检测路由下的合并分组参数和检查分组路由就说完了,思路不清晰的可以看思维导图。

二、检测URL变量和规则路由是否匹配

以下案例使用的正常路由,没有使用资源路由做的案例,走的是文件thinkphp/library/think/route/RuleItem.php

使用神器来打印一下数据。

image.png
执行流程
image.png
执行流程

以上就是全部的执行过程,接下来就需要解析检测URL和规则路由是否匹配的内容。

image.png
检测URL和规则路由是否匹配

在开始这里的内容之前先跟咔咔一起来解决一个问题。

来到上图代码的上层进行打印一下返回结果。

image.png
打印内容
image.png
打印结果

然后在来看一下路由配置文件route.php。

在这个文件中咔咔只配置了俩个路由地址,只有一个是资源路由,并且设置有变量规则。

image.png
路由配置文件

此时在给路由配置文件在加上一条路由地址。

image.png
路由配置文件

接着在文章开头的位置进行打印结果。

这里有没有一个疑问,就是为什么会返回false呢!

image.png
检测URL和规则路由是否匹配打印结果

解决为什么检测URL和规则路由是否匹配会返回false

那就需要来到源点进行查看了。

这块的内容咔咔在上文已经解释完了,这里的item会存在俩种情况,第一种为执行think\route\Resource Object,第二种为执行think\route\RuleItem Object。

都会去执行check的那个方法。

image.png
执行流程的源点

很清晰的就是会知道肯定是在执行文件thinkphp/library/think/route/RuleItem.php中的check给予返回的。

image.png
检测路由

根据这俩行代码就能明白肯定就是$match这个变量有关系。

这个变量是执行的检测URL和规则路由是否匹配方法,这又回到开始的咱们说的内容了。

所以说源码就是这样一环套一环,慢慢看就行了,看的多了就会融会贯通了。

image.png
根据代码找关系

正式开始解析代码

参数说明

  • $url : 访问地址
  • $option : 合并分组参数
  • $completeMatch : 路由是否完全匹配

执行文件:文件:thinkphp/library/think/route/RuleItem.php

具体都执行了些神马让我们细细道来。

image.png
解析的源代码

首先会进一次路由是否完全匹配的判断,在解读路由的过程中出现了很多这样的判断,后期咔咔会单独出一篇文章来进行解读为什么需要进行判断。

接着代码会执行到合并路由规则,这个过程是把路由规则进行了合并。

来到方法getPattern,由于路由规则没有设置所以直接返回,路由规则的这个变量的初始值就是空数组,所以合并之后还是一个空数组。

第二行代码不知道大家会不会有疑问,到底是什么执行的。

在这个类的构造函数中进行了依赖注入将// 路由实例:think\Route注入了进来。

根据代码追踪就是从配置信息中获取配置信息,返回结果为string(1) "/"

image.png
合并路由规则

在接着对路由规则进行处理,将所有的|改为/

image.png
对路由规则进行处理

根据上图给返回的$rule可以明确的一件事就是下边的判断不会执行。

image.png
判断不会执行

在这里需要了解一个方法就是preg_quote:函数用于转义正则表达式字符

所以最后这个slash这个变量会返回为string(6) "\/\-\/",其中的反斜杠全是转义符。

preg_replace 函数通过一个正则表达式分隔字符串。

strncasecmp() 函数比较两个字符串(不区分大小写)。

preg_match_all 函数用于执行一个全局正则表达式匹配。

preg_match_all 函数用于执行一个全局正则表达式匹配。

在这个方法中有几个函数对于大部分来说都是很陌生的,只能自己去进行查资料了,咔咔也不会进行解释这几个方法的使用。

总结

以上就是检测URl变量和规则路由是否匹配的内容,这块的功能主要为一下几个方面。

  • 检测路由是否完全匹配,使用的参数为complete_match。
  • 合并路由规则,也就是pattern这个的使用。
  • 最重要的就是下部分对地址进行各种函数处理。
  • 最终返回的是路由参数数组形式。
  • 以上是存在路由参数的情况下,如果没有路由参数会直接返回false。
  • 然后回去执行解析匹配到的规则路由这里。

关于这里的流程图咔咔就不放了,可以根据咔咔提供的代码调试神器进行调试即可,也可以看上文咔咔给的导图。

路由马上就进入结尾了,在剩下最后一点点内容就是路由调度,路由如何进行调度,最终路由执行的结果返回给了谁,这都是一些困扰的问题,接下来咔咔将对路由调度进行详细解析。

本文还是主要针对的是检测路由参数和路由变量、规则进行说明,这块的内容需要配合之前的文章一起阅读,在PHP中文网页有连载的文章,如果你感兴趣可以返回查看哈!

坚持学习、坚持写博、坚持分享是咔咔从业以来一直所秉持的信念。希望在偌大互联网中咔咔的文章能带给你一丝丝帮助。我是咔咔,下期见。

            前言一、检测路由-合并分组参数、检查分组路由二、检测URL变量和规则路由是否匹配总结