从零开始编写一个PHP框架 系列的《路由模块》
项目地址：terse
前言
路由类，是用户请求的门神，它过滤了不符合当前规则的链接。同时，也美化了我们的 URL。一个好的路由类，会让我们的程序更加灵活。
需求分析
- 可以指定请求类型，如果是
any说明不限制类型 - 可以使用正则
- 可以指定控制器、方法及其前后缀
- 可以指定命名空间
文件结构
└── Mvc
├── Router
│ └── Route.php [路由定义解析类]
└── Router.php [路由配置类]
路由配置类
指定请求类型的路由
我们想要实现一个类似于下面情况的路由：
<?php
$router = new Router();
$router->get('/', ['controller' => 'Home', 'action' => 'index']);
$router->post('/analysis.do', ['controller' => 'Home', 'action' => 'analysis']);
$router->get('/edit.do', ['controller' => 'Article', 'action' => 'edit']);
$router->post('/edit.do', ['controller' => 'Article', 'action' => 'doEdit']);
所以从上面可以看出，我们可以给某一个路由添加不同的请求类型。
既然说到请求类型，那么就得用到上一篇刚写好的请求模块了。
当然，如果我们需要某一个路由无论什么请求方式都可以的话，可以考虑用 any。
<?php
use Request;
class Router
{
const METHOD_ANY = 'any';
/**
* 路由信息
*
* @var array
*/
protected $_routes [];
/**
* 设置请求方式为GET的规则
*
* @param string $uri
* @param array $rules
* @return \Terse\Mvc\Router
*/
public function get($uri, array $rules)
{
$this->add($uri, $rules, Request::METHOD_GET);
return $this;
}
/**
* 设置请求方式为POST的规则
*
* @param string $uri
* @param array $rules
* @return \Terse\Mvc\Router
*/
public function post($uri, array $rules)
{
$this->add($uri, $rules, Request::METHOD_POST);
return $this;
}
/**
* 设置请求方式为PUT的规则
*
* @param string $uri
* @param array $rules
* @return \Terse\Mvc\Router
*/
public function put($uri, array $rules)
{
$this->add($uri, $rules, Request::METHOD_PUT);
return $this;
}
/**
* 设置请求方式为DELETE的规则
*
* @param string $uri
* @param array $rules
* @return \Terse\Mvc\Router
*/
public function delete($uri, array $rules)
{
$this->add($uri, $rules, Request::METHOD_DELETE);
return $this;
}
/**
* 设置请求方式为HEAD的规则
*
* @param string $uri
* @param array $rules
* @return \Terse\Mvc\Router
*/
public function head($uri, array $rules)
{
$this->add($uri, $rules, Request::METHOD_HEAD);
return $this;
}
/**
* 设置请求方式为OPTIONS的规则
*
* @param string $uri
* @param array $rules
* @return \Terse\Mvc\Router
*/
public function options($uri, array $rules)
{
$this->add($uri, $rules, Request::METHOD_OPTIONS);
return $this;
}
/**
* 设置请求方式为PATCH的规则
*
* @param string $uri
* @param array $rules
* @return \Terse\Mvc\Router
*/
public function patch($uri, array $rules)
{
$this->add($uri, $rules, Request::METHOD_PATCH);
return $this;
}
/**
* 设置任意请求方式的规则
*
* @param string $uri
* @param array $rules
* @return \Terse\Mvc\Router
*/
public function any($uri, array $rules)
{
$this->add($uri, $rules, self::METHOD_ANY);
return false;
}
}
在上述代码中，我们看到，每一个方法都调用了 add 方法，这个方法主要是用来统一定义路由的，如果有什么需要修改或者添加的，可以在这里扩展。
关于
add方法里用到的Route类，会在后续说明。
<?php
use Request;
class Router
{
...
/**
* 添加一种规则
*
* @param string $uri
* @param array $rules
* @param string $method
*/
protected function add($uri, array $rules, $method)
{
$this->_routes[$method][] = new Route($uri, $rules);
}
}
懒人配置
路由添加好了，还可以考虑一下使用情况如下：
<?php
$router = new Router();
$router->get('/', ['controller' => '\APP\Controller\HomeController', 'action' => 'indexAction']);
$router->get('/version', ['controller' => '\APP\Controller\HomeController', 'action' => 'versionAction']);
$router->get('/about', ['controller' => '\APP\Controller\HomeController', 'action' => 'aboutAction']);
我们可以看到每个控制器都有一个后缀 Controller 和命名空间，每个方法都有一个后缀 Action。(这个与实际项目规划有关)
可以想象，如果有一堆路由，我们就得写一堆的 Controller、命名空间 和 Action。
懒人有懒招，我们只需要给它两个接口，去定义后缀是什么、命名空间是什么，就不需要每次都手打 Controller、命名空间 和 Action 了。
<?php
use Request;
class Router
{
/**
* 命名空间
*
* @var string
*/
protected $_namespace;
/**
* 控制器后缀
*
* @var string
*/
protected $_controllerSuffix;
/**
* 方法后缀
*
* @var string
*/
protected $_actionSuffix;
...
/**
* 设置命名空间
*
* @param string $namespace
*/
public function setNamespace($namespace)
{
$namespace = (string)$namespace;
$namespace = trim($namespace, '\\');
$this->_namespace = sprintf("\\%s", $namespace);
}
/**
* 设置控制器后缀
*
* @param string $suffix
*/
public function setControllerSuffix($suffix)
{
$this->_controllerSuffix = (string)$suffix;
}
/**
* 设置方法后缀
*
* @param string $suffix
*/
public function setActionSuffix($suffix)
{
$this->_actionSuffix = (string)$suffix;
}
}
默认路由
再思考一下，如果用户发了一个请求，而这个请求的路由并没有定义，这个时候，我们不报错，希望它能够到一个指定的页面，改怎么做？
默认路由！！！
<?php
use Request;
class Router
{
/**
* 默认路由
*
* @var array
*/
protected $_default = [];
...
/**
* 设置默认控制器
*
* @param string $controller
*/
public function setDefaultController($controller)
{
$this->_default['controller'] = (string)$controller;
}
/**
* 设置默认方法
*
* @param string $action
*/
public function setDefaultAction($action)
{
$this->_default['action'] = (string)$action;
}
/**
* 设置默认参数
*
* @param string $params
*/
public function setDefaultParams(array $params)
{
$this->_default['params'] = $params;
}
}
解析
所有配置都完成之后，下面就涉及到解析路由了。
我们在存储路由的时候，用了一个数组。不同请求类型的路由存放在不同的列表当中，如果我们需要筛选出我们想要的路由，就需要对这个列表进行遍历。当然，如果想要减少遍历次数，也不是很难，可以参考自动加载模块别名的设置与匹配。
过程分析：
1、获取当前请求的路由
2、获取当前请求方式
3、获取此请求方式的列表和 any 列表
4、匹配路由
5、获取匹配结果并存储
<?php
use Request;
class Router
{
/**
* 匹配路由
*
* @var array
*/
protected $_matchRoute = [];
...
/**
* 路由解析
*
* @return void
*/
public function render()
{
// 获取当前请求的路由
$uri = $request->getServer('REQUEST_URI');
$baseUri = $this->parse2BaseUri($uri);
// 获取当前请求方式
$request = new Request();
$method = $request->getMethod();
// 获取此请求方式的列表并匹配
$rules = [];
if (isset($this->_routes[$method])) {
$route = $this->getRules($method, $baseUri);
}
// 若没有匹配到，则匹配 any 列表
if (!$route && isset($this->_routes[self::METHOD_ANY])) {
$route = $this->getRules(self::METHOD_ANY, $baseUri);
}
// 如果还是没有匹配到，取默认路由
if (!$route) {
$this->_matchRoute = $this->getDefaultMatchRoute();
return true;
}
// 获取匹配到的信息
$controller = $route->getControllerName();
$controller = ltrim($controller, '\\');
$action = $route->getActionName();
$params = $route->getParams();
// 拼凑结果
$this->_matchRoute = $this->formatMatched($controller, $action, $params);
}
/**
* 匹配路由
*
* @param string $method
* @param string $uri
* @return mixed
*/
protected function getRules($method, $uri)
{
foreach ($this->_routes[$method] as $route) {
if ($route->match($uri)) {
return $route;
}
}
return false;
}
/**
* 获取 base uri
*
* @param string $uri
* @return string
*/
protected function parse2BaseUri($uri)
{
if (!$uri) {
return '/';
}
$uriParts = explode('?', $uri);
$uri = reset($uriParts);
return $uri ? $uri : '/';
}
/**
* 获取默认匹配
*
* @throws \Exception
* @return array
*/
protected function getDefaultMatchRoute()
{
$default = $this->_default;
if (!$default
|| !isset($default['controller']) || !$default['controller']
|| !isset($default['action']) || !$default['action']) {
throw new \Exception('您访问的网页不存在', -__LINE__);
}
$params = isset($default['params']) ? $default['params'] : [];
return $this->formatMatched($default['controller'], $default['action'], $params);
}
/**
* 匹配结果格式化
*
* @param string $controller
* @param string $action
* @param array $params
* @return array
*/
protected function formatMatched($controller, $action, $params = [])
{
return [
'controller' => sprintf("%s\\%s%s", $this->_namespace, $controller, $this->_controllerSuffix),
'action' => sprintf("%s%s", $action, $this->_actionSuffix),
'params' => $params
];
}
}
获取匹配结果
<?php
use Request;
class Router
{
/**
* 获取匹配的路由
*
* @return array
*/
public function getMatchRoute()
{
return $this->_matchRoute;
}
}
路由定义解析类
在上面使用路由定义解析类的时候，我没有多做解释，主要是解释之后，就会有点混乱，还不如直接放到后面来介绍。
在使用过程中，我们涉及到了几个方法 __construct、match、getControllerName、getActionName、getParams。
现在开始介绍最后三个。
构造函数
<?php
$router->get('/', ['controller' => 'Home', 'action' => 'index']);
$router->get('/articles/{gallery:[a-zA-Z]+}', ['controller' => 'Article', 'action' => 'list']);
从路由定义的角度来看，我们的构造函数需要两个参数，分别是路由和路由信息。
过程分析：
1、设置路由和相关参数
2、如果路由里不包含正则，则赋值类属性
3、如果路由里包含正则，则解析并返回路由正则表达式(这里用了PHP子组模式，有兴趣的小伙伴可以看看)
<?php
class Route
{
/**
* 原始路由
*
* @var string
*/
protected $_pattern = '';
/**
* 解析后的正则表达式
*
* @var string
*/
protected $_compilePattern = '';
/**
* 路由正则参数
*
* @var array
*/
protected $_params = [];
/**
* 路由信息
*
* @var array
*/
protected $_rules = [
'controller' => '',
'action' => '',
'params' => []
];
/**
* 构造函数
*
* @param string $pattern
* @param array $rules
*/
function __construct($pattern, array $rules)
{
$pattern = (string)$pattern;
// 解析路由规则
$this->reConfigure($pattern);
$this->_rules['controller'] = isset($rules['controller']) ? $rules['controller'] : '';
$this->_rules['action'] = isset($rules['action']) ? $rules['action'] : '';
$this->_rules['params'] = isset($rules['params']) ? $rules['params'] : [];
}
/**
* 解析路由规则
*
* @param string $pattern
*/
public function reConfigure($pattern)
{
if (!$pattern) {
throw new \Exception('路由规则不能为空', -__LINE__);
}
// 如果存在正则，则需要解析正则
if (strpos($pattern, '{') !== false) {
$prePattern = $this->extractNamePattern($pattern);
$this->_compilePattern = $prePattern;
} else {
$this->_compilePattern = $pattern;
}
$this->_pattern = $pattern;
}
/**
* 解析参数正则
*
* @param string $pattern
* @return string
*/
public function extractNamePattern($pattern)
{
$callback = function ($match) {
if (!isset($match[1])) {
return '';
}
$params = explode(':', $match[1]);
if (!isset($params[1])) {
return '';
}
list($ident, $pattern) = $params;
$this->_params[] = [
'ident' => $ident,
'pattern' => $pattern
];
return sprintf("(?'%s'%s)", $ident, $pattern);
};
return preg_replace_callback('/\B{([^}]+)}/x', $callback, $pattern);
}
}
获取匹配参数
匹配好一个路由，我们需要知道调用哪个控制器，哪个方法。所以这里需要解析类提供解析后的结果。
这里还有一个没有做的，那就是模块。目前我自己写的项目中，不同的模块是使用域名来区分的，如果有需要可以后续加上，也并不麻烦。
<?php
class Route
{
/**
* 路由信息
*
* @var array
*/
protected $_rules = [
'controller' => '',
'action' => '',
'params' => []
];
/**
* 获取控制器名称
*
* @return string
*/
public function getControllerName()
{
return $this->_rules['controller'];
}
/**
* 获取方法名称
*
* @return string
*/
public function getActionName()
{
return $this->_rules['action'];
}
/**
* 获取参数
*
* @return array
*/
public function getParams()
{
return $this->_rules['params'];
}
}
匹配
过程分析：
1、如果请求路由和定义路由一致，直接返回真
2、不一致则获取路由匹配正则，查看是否匹配
3、如果匹配，则将匹配到的内容拼凑成参数
<?php
class Route
{
/**
* 匹配
*
* @param string $uri
* @return bool
*/
public function match($uri)
{
// 如果路由和定义的一致，则直接返回真
if ($this->_pattern == $uri) {
return true;
}
// 拼凑正则
$preg = sprintf('#^%s$#u', $this->_compilePattern);
$matches = [];
// 匹配正则
if (preg_match($preg, $uri, $matches) == false) {
return false;
}
// 拼凑参数
foreach ($this->_params as $param) {
$ident = $param['ident'];
$this->_rules['params'][] = isset($matches[$ident]) ? $matches[$ident] : '';
}
return true;
}
}
完整代码
路由设置类
<?php
namespace Terse\Mvc;
use Terse\Http\Request;
use Terse\Mvc\Router\Route;
/**
* Terse\Mvc\Router
*
* 路由设置
*
* @link https://gitee.com/imjcw/terse
* @author imjcw <imjcw@imjcw.com>
*/
class Router
{
const METHOD_ANY = 'any';
/**
* 路由信息
*
* @var array
*/
protected $_routes [];
/**
* 命名空间
*
* @var string
*/
protected $_namespace = '';
/**
* 控制器后缀
*
* @var string
*/
protected $_controllerSuffix = '';
/**
* 方法后缀
*
* @var string
*/
protected $_actionSuffix = '';
/**
* 匹配路由
*
* @var array
*/
protected $_matchRoute = [];
/**
* 默认路由
*
* @var array
*/
protected $_default = [];
/**
* 构造函数
*/
function __construct()
{
$this->_matchRoute = [];
$this->_namespace = '';
$this->_controllerSuffix = '';
$this->_actionSuffix = '';
}
/**
* 设置命名空间
*
* @param string $namespace
*/
public function setNamespace($namespace)
{
$namespace = (string)$namespace;
$namespace = trim($namespace, '\\');
$this->_namespace = sprintf("\\%s", $namespace);
}
/**
* 设置控制器后缀
*
* @param string $suffix
*/
public function setControllerSuffix($suffix)
{
$this->_controllerSuffix = (string)$suffix;
}
/**
* 设置方法后缀
*
* @param string $suffix
*/
public function setActionSuffix($suffix)
{
$this->_actionSuffix = (string)$suffix;
}
/**
* 设置默认控制器
*
* @param string $controller
*/
public function setDefaultController($controller)
{
$this->_default['controller'] = (string)$controller;
}
/**
* 设置默认方法
*
* @param string $action
*/
public function setDefaultAction($action)
{
$this->_default['action'] = (string)$action;
}
/**
* 设置默认参数
*
* @param string $params
*/
public function setDefaultParams(array $params)
{
$this->_default['params'] = $params;
}
/**
* 设置请求方式为GET的规则
*
* @param string $uri
* @param array $rules
* @return \Terse\Mvc\Router
*/
public function get($uri, array $rules)
{
$this->add($uri, $rules, Request::METHOD_GET);
return $this;
}
/**
* 设置请求方式为POST的规则
*
* @param string $uri
* @param array $rules
* @return \Terse\Mvc\Router
*/
public function post($uri, array $rules)
{
$this->add($uri, $rules, Request::METHOD_POST);
return $this;
}
/**
* 设置请求方式为PUT的规则
*
* @param string $uri
* @param array $rules
* @return \Terse\Mvc\Router
*/
public function put($uri, array $rules)
{
$this->add($uri, $rules, Request::METHOD_PUT);
return $this;
}
/**
* 设置请求方式为DELETE的规则
*
* @param string $uri
* @param array $rules
* @return \Terse\Mvc\Router
*/
public function delete($uri, array $rules)
{
$this->add($uri, $rules, Request::METHOD_DELETE);
return $this;
}
/**
* 设置请求方式为HEAD的规则
*
* @param string $uri
* @param array $rules
* @return \Terse\Mvc\Router
*/
public function head($uri, array $rules)
{
$this->add($uri, $rules, Request::METHOD_HEAD);
return $this;
}
/**
* 设置请求方式为OPTIONS的规则
*
* @param string $uri
* @param array $rules
* @return \Terse\Mvc\Router
*/
public function options($uri, array $rules)
{
$this->add($uri, $rules, Request::METHOD_OPTIONS);
return $this;
}
/**
* 设置请求方式为PATCH的规则
*
* @param string $uri
* @param array $rules
* @return \Terse\Mvc\Router
*/
public function patch($uri, array $rules)
{
$this->add($uri, $rules, Request::METHOD_PATCH);
return $this;
}
/**
* 设置任意请求方式的规则
*
* @param string $uri
* @param array $rules
* @return \Terse\Mvc\Router
*/
public function any($uri, array $rules)
{
$this->add($uri, $rules, self::METHOD_ANY);
return false;
}
/**
* 路由解析
*
* @return void
*/
public function render()
{
// 获取当前请求的路由
$uri = $request->getServer('REQUEST_URI');
$baseUri = $this->parse2BaseUri($uri);
// 获取当前请求方式
$request = new Request();
$method = $request->getMethod();
// 获取此请求方式的列表并匹配
$rules = [];
if (isset($this->_routes[$method])) {
$route = $this->getRules($method, $baseUri);
}
// 若没有匹配到，则匹配 any 列表
if (!$route && isset($this->_routes[self::METHOD_ANY])) {
$route = $this->getRules(self::METHOD_ANY, $baseUri);
}
// 如果还是没有匹配到，取默认路由
if (!$route) {
$this->_matchRoute = $this->getDefaultMatchRoute();
return true;
}
// 获取匹配到的信息
$controller = $route->getControllerName();
$controller = ltrim($controller, '\\');
$action = $route->getActionName();
$params = $route->getParams();
// 拼凑结果
$this->_matchRoute = $this->formatMatched($controller, $action, $params);
}
/**
* 获取匹配的路由
*
* @return array
*/
public function getMatchRoute()
{
return $this->_matchRoute;
}
/**
* 添加一种规则
*
* @param string $uri
* @param array $rules
* @param string $method
*/
protected function add($uri, array $rules, $method)
{
$this->_routes[$method][] = new Route($uri, $rules);
}
/**
* 匹配路由
*
* @param string $method
* @param string $uri
* @return mixed
*/
protected function getRules($method, $uri)
{
foreach ($this->_routes[$method] as $route) {
if ($route->match($uri)) {
return $route;
}
}
return false;
}
/**
* 获取 base uri
*
* @param string $uri
* @return string
*/
protected function parse2BaseUri($uri)
{
if (!$uri) {
return '/';
}
$uriParts = explode('?', $uri);
$uri = reset($uriParts);
return $uri ? $uri : '/';
}
/**
* 获取默认匹配
*
* @throws \Exception
* @return array
*/
protected function getDefaultMatchRoute()
{
$default = $this->_default;
if (!$default
|| !isset($default['controller']) || !$default['controller']
|| !isset($default['action']) || !$default['action']) {
throw new \Exception('您访问的网页不存在', -__LINE__);
}
$params = isset($default['params']) ? $default['params'] : [];
return $this->formatMatched($default['controller'], $default['action'], $params);
}
/**
* 匹配结果格式化
*
* @param string $controller
* @param string $action
* @param array $params
* @return array
*/
protected function formatMatched($controller, $action, $params = [])
{
return [
'controller' => sprintf("%s\\%s%s", $this->_namespace, $controller, $this->_controllerSuffix),
'action' => sprintf("%s%s", $action, $this->_actionSuffix),
'params' => $params
];
}
}
路由定义类
<?php
namespace Terse\Mvc\Router;
/**
* Terse\Mvc\Router\Route
*
* 路由规则解析和匹配
*
* @link https://gitee.com/imjcw/terse
* @author imjcw <imjcw@imjcw.com>
*/
class Route
{
/**
* 原始路由
*
* @var string
*/
protected $_pattern = '';
/**
* 解析后的正则表达式
*
* @var string
*/
protected $_compilePattern = '';
/**
* 路由正则参数
*
* @var array
*/
protected $_params = [];
/**
* 路由信息
*
* @var array
*/
protected $_rules = [
'controller' => '',
'action' => '',
'params' => []
];
/**
* 构造函数
*
* @param string $pattern
* @param array $rules
*/
function __construct($pattern, array $rules)
{
$pattern = (string)$pattern;
// 解析路由规则
$this->reConfigure($pattern);
$this->_rules['controller'] = isset($rules['controller']) ? $rules['controller'] : '';
$this->_rules['action'] = isset($rules['action']) ? $rules['action'] : '';
$this->_rules['params'] = isset($rules['params']) ? $rules['params'] : [];
}
/**
* parse pattern
*
* @param string $pattern
*/
public function reConfigure($pattern)
{
if (!$pattern) {
throw new \Exception('pattern 不能为空', -__LINE__);
}
// 如果存在正则，则需要解析正则
if (strpos($pattern, '{') !== false) {
$prePattern = $this->extractNamePattern($pattern);
$this->_compilePattern = $prePattern;
} else {
$this->_compilePattern = $pattern;
}
$this->_pattern = $pattern;
}
/**
* 解析参数正则
*
* @param string $pattern
* @return string
*/
public function extractNamePattern($pattern)
{
$callback = function ($match) {
if (!isset($match[1])) {
return '';
}
$params = explode(':', $match[1]);
if (!isset($params[1])) {
return '';
}
list($ident, $pattern) = $params;
$this->_params[] = [
'ident' => $ident,
'pattern' => $pattern
];
return sprintf("(?'%s'%s)", $ident, $pattern);
};
return preg_replace_callback('/\B{([^}]+)}/x', $callback, $pattern);
}
/**
* 匹配
*
* @param string $uri
* @return bool
*/
public function match($uri)
{
// 如果路由和定义的一致，则直接返回真
if ($this->_pattern == $uri) {
return true;
}
// 拼凑正则
$preg = sprintf('#^%s$#u', $this->_compilePattern);
$matches = [];
// 匹配正则
if (preg_match($preg, $uri, $matches) == false) {
return false;
}
// 拼凑参数
foreach ($this->_params as $param) {
$ident = $param['ident'];
$this->_rules['params'][] = isset($matches[$ident]) ? $matches[$ident] : '';
}
return true;
}
/**
* 获取控制器名称
*
* @return string
*/
public function getControllerName()
{
return isset($this->_rules['controller']) ? $this->_rules['controller'] : '';
}
/**
* 获取方法名称
*
* @return string
*/
public function getActionName()
{
return isset($this->_rules['action']) ? $this->_rules['action'] : '';
}
/**
* 获取参数
*
* @return array
*/
public function getParams()
{
return isset($this->_rules['params']) ? $this->_rules['params'] : [];
}
}
最后
这一篇没有介绍太多，主要是细节比较多，直接读代码要比解释的效果要好多了。
下一篇《中间件模块》
