Laravel 路由匹配的过程都做了些什么呢?

  • 2019 年 10 月 10 日
  • 筆記

Laravel 的路由配置有很多,可以设置域名,设置请求协议,设置请求方式,请求路径。那么,Laravel在获取到请求之后,去匹配路由都做了些什么呢?

Laravel 默认路由的验证器有四个,UriValidator,MethodValidator,SchemeValidator,HostValidator分别处理uri的匹配,请求方法的匹配,协议的匹配,域名的匹配。

举几个例子:

1HostValidator验证域名是符合domain的配置

Route::domain('{account}.blog.dev')->function({      return 'Hello';  });  

2UriValidator验证请求的uri是否符合路由配置,MethodValidator验证当前请求方法是否是get方法

Route::get('/home/posts/{id?}',function($id=null){      return 'get post '.$id;  })  

3SchemeValidator验证访问协议,主要用于验证安全路由。只能验证是http,或者https

  Route::get('foo', array('https', function(){}));  

只有当四个验证器都通过才认为当前请求匹配路由成功。

那这四个验证器都是怎么验证的呢?

请求方法验证

请求方式的验证最简单,就是验证当前请求方式是否是当前路由允许的请求方式。而路由的允许的请求方式在路由实例化的时候就创建好了。

请求协议验证

通过获取当前请求的Request,判断是否是https,与当前路由的配置进行比较

域名验证以及uri的验证

这两种验证本质上都是一样的。通过对路由的配置进行编译分解,获取uri获取域名匹配的正则表达式,然后通过正则表达式进行匹配。如果匹配成功,则验证通过。

这里以UriValidator为例说明

这里的关键是getCompiled返回的这个对象。getCompiled返回的是SymfonyComponentRoutingCompiledRoute这个对象包含了当前路由编译之后的uri匹配正则表达式,域名匹配正则表达式等信息。

CompiledRoute是谁返回的?

在每个路由获取验证器进行验证之前,都会执行compileRoute方法创建CompiledRoute对象。

IlluminateRoutingRouteCompilercompile方法如下:

可以看出,最终是由SymfonyComponentRoutingRouteCompilercompile返回最终的compileRoute对象。

路由编译都干了些什么?

RouteCompiler::compile输入参数是当前需要匹配的路由。首先判断路由是否有域名配置,如果有域名配置则对域名配置进行正则表达式编译,获取域名的匹配正则表达式,已经匹配表达式中的变量信息。

然后获取路由的uri配置,对配置进行解析获取配置中的匹配正则表达式,变量数组,前缀信息。

域名,路径匹配规则解析之后,根据解析后的数据创建一个CompiledRoute对象,并返回

因此,在路由编译过程中,主要是根据路由配置,解析出匹配的正则表达式,变量数组,前缀信息。并将这些解析之后的数据创建的CompiledRoute对象返回给调用方。这样,调用方就能够直接通过CompiledRoute的属性直接获取到路由解析之后的匹配规则。

匹配规则怎么解析的?

首先通过正则表达式匹配是否由变量配置,例如Route::get('/posts/{id}'),Route::domain('{account}.blog.dev')。如果有变量,则对配置规则进行截取,将配置规则中不包含变量的部分$tokens[] = ['text', $precedingText]; ,对所有变量$token = ['variable', $isSeparator ? $precedingChar : '', $regexp, $varName, false, true]保存解析后的信息。

当配置信息中不包含任何变量,则进入这段代码中第一个if判断里面,将匹配规则保存在token数组中。

区分当前解析是对域名的匹配还是对uri的匹配,如果对uri的匹配,则找出变量中第一个可选参数的位置。

这一步是把路由配置转换成可匹配的规则token。方便后续通过每个token生成匹配正则表达式。

通过解析获取的token数组,保存了所有的匹配规则数组。如果当前匹配规则token是text类型,则在对字符串进行转义处理,返回作为匹配的正则表达式。

如果是变量,则根据是否是可选的(上一步已经找到了第一个可选参数的位置),在正则表达式中添加可选标识。

根据每个token获取每个匹配规则的正则表达式,将所有的正则表达式拼接成一个正则表达式,并加上正则表达式前后缀。这样就获取了一个完整可匹配的正则表达式。

然后将前缀,匹配正则表达式,匹配规则数组tokens,变量数组返回给调用方。供调用方生成CompiledRoute对象。

附上Laravel路由匹配过程调用流程图