3.11.1 扩展类库:基于FastRoute的快速路由
此扩展基于 FastRoute 实现,需要 PHP 5.4.0 及以上版本,可以通过配置实现自定义路由配置,从而轻松映射到PhalApi中的service接口服务。
3.11.2 安装和配置
(1)扩展包下载
从 PhalApi-Library 扩展库中下载获取 FastRoute 扩展包,如使用:
$ git clone https://git.oschina.net/dogstar/PhalApi-Library.git
然后把 FastRoute 目录复制到 ./PhalApi/Library/ 下,即:
$ cp ./PhalApi-Library/FastRoute/ ./PhalApi/Library/ -R
到此安装完毕!接下是插件的配置。
(2)扩展包配置
我们需要在 ./Config/app.php 配置文件中追加以下配置:
/**
* 扩展类库 - 快速路由配置
*/
'FastRoute' => array(
/**
* 格式:array($method, $routePattern, $handler)
*
* @param string/array $method 允许的HTTP请求方式,可以为:GET/POST/HEAD/DELETE 等
* @param string $routePattern 路由的正则表达式
* @param string $handler 对应PhalApi中接口服务名称,即:?service=$handler
*/
'routes' => array(
array('GET', '/user/get_base_info/{user_id:\d+}', 'User.GetBaseInfo'),
array('GET', '/user/get_multi_base_info/{user_ids:[0-9,]+}', 'User.GetMultiBaseInfo'),
),
),
(3)nginx的协助配置(省略index.php)
如果是使用nginx的情况下,需要添加以下配置:
# 最终交由index.php文件处理
location / {
try_files $uri $uri/ $uri/index.php;
}
# 匹配未找到的文件路径
if (!-e $request_filename) {
rewrite ^/(.*)$ /index.php/$1 last;
}
然后重启nginx。
3.11.3 入门使用
(1)入口注册
//$ vim ./Public/index.php
$loader->addDirs('Library');
// 其他代码....
//显式初始化,并调用分发
DI()->fastRoute = new FastRoute_Lite();
DI()->fastRoute->dispatch();
/** ---------------- 响应接口请求 ---------------- **/
$api = new PhalApi();
$rs = $api->response();
$rs->output();
3.11.3 调用效果及扩展
(1)通过新的路由正常访问
在完成上面的配置后,我们就可以这样进行页面访问测试:
http://library.phalapi.com/user/get_base_info/1
等效于:http://library.phalapi.com/?service=User.GetBaseInfo&user_id=1
http://library.phalapi.com/user/get_multi_base_info/1,2
等效于:http://library.phalapi.com/?service=User.GetMultiBaseInfo&user_ids=1,2
(2)非法访问
当请求的HTTP方法与配置的不符合时,就会返回405错误,如我们配置了:
array('POST', '/user/{id:\d+}/{name}', 'handler2'),
但是通过GET方式来访问,即:
http://library.phalapi.com/user/123/name
则会返回:
{
"ret": 405,
"data": [],
"msg": "快速路由的HTTP请求方法错误,应该为:POST"
}
(3)路由配置错误
当在./Config/app.php的文件里配置错误的路由时,会直接抛出FastRoute\BadRouteException异常,以及时提示开发人员修正。
(4)异常错误处理器
我们也可以实现FastRoute_Handler接口来自定义我们自己的错误异常处理回调函数。如:
class FastRoute_Handler_App implements FastRoute_Handler {
public function excute(PhalApi_Response $response) {
// ... ...
}
}
然后,在分发时指定handler:
DI()->fastRoute->dispatch(new FastRoute_Handler_App());
3.11.4 更多路由配置说明
请访问 FastRoute ,查看其官方说明。