一個PHP的微型路由控制器

一個PHP的微型路由控制器

之前使用dispatch, 但是從4.0到現在的8.0 API變動比較大，特別是在最近兩次大的版本的升級，為了保持代碼簡潔丟失了向下相容的特性。
感覺作者的的核心思想不是很堅定。所以生出了自己造輪子的衝動。

router.lua

這個是一個微型的可以在openresty裡面啟動並執行路由控制器，曾經幫作者做了一次重大改版，現在還是這個項目第二貢獻者。
其中的思想是很值得借鑒的：

使用樹形結構來儲存url和handler的映射關係。（按照樹形結構尋找保證了尋找回呼函數的效率Olog(n),
而傳統的以Regex做key映射handler方式，尋找回呼函數時間不穩定，最壞情況需要執行一遍所有的Regex）

將reqest method定義成是match函數的一個封裝形式。便於提供方便的形式來映射路由。

Router

鑒於以上兩個非常好的特性，所以就把這個lua的庫在PHP下面重寫了一遍。同時在寫的過程中加入了一些新的特性：

增加error這個API，一個API提供兩種調用方式（這個借鑒了dispatch裡面的一些特性，有點像jquery的某些方法），可以兼具定義error handler和觸發error handler的作用。

增加hook API，同樣有兩種調用方式。

預設觸發“before”和“after”兩個hook。分別在執行真正的handler前後。

在“before”這個hook後面執行使用者自訂的hook，這些hook是在定義回呼函數的時候一起給定當前url需要調用的hook列表。（當然這些hook全部都要使用者自己定義回呼函數）

安裝

這個微型的路由控制器已經提交到packagist網站，可以通過composer工具安裝

composer require lloydzhou/router

此處附README裡面的一個例子：

(new Router())/* 定義錯誤處理函數 */->error(401, function($message){    header('Location: /login', true, 302);    die($message);})->error(405, function($message){    header('Location: /hello/world', true, 302);})->error(406, function($message){    die($message);})/* 定義hook函數，除了內建預設調用的before和after，還定義了檢查登入的auth */->hook('auth', function($params){    if ('lloyd' == $params['name'])    return $params;    $params['router']->error(401, 'Forbiden');})/* 定義after這個鉤子函數，支援json或者jsonp格式輸出 */->hook('after', function($result, $router){    if ($result) {    header('Content-type: application/'. ($_GET['jsoncallback']?'javascript':'json'));    if ($_GET['jsoncallback'])        print $_GET['jsoncallback']. '('. json_encode($result). ')';    else print json_encode($result);    }})->hook('before', function($params){    //$params['name'] = 'lloydzhou';    return $params;})/* 定義url映射 */->get('/', function(){    echo "Hello world !!!";})->get('/hello/:name', function($name){    echo "Hello $name !!!";})->get('/hello/:name/again', function($name){    echo "Hello $name again !!!";}, 'auth')->get('/hello/:name.:ext', function($name, $ext){    if ('js' == $ext || 'json' == $ext) return array('name'=>$name);    return array('code'=>1, 'msg'=>'error message...');}, 'auth')/* 程式入口，以當前的url尋找對應的處理函數，並擷取變數執行該函數 */->execute();

啟動服務

php -S 0.0.0.0:8888 test.php

測試

curl -vvv 127.0.0.1:8888/hello/url未能映射成功，觸發405錯誤處理函數, 自動跳轉向 URL: "/hello/world"curl -vvv 127.0.0.1:8888/hello/lloyd 返回 "Hello lloyd !!!"curl -vvv 127.0.0.1:8888/hello/lloyd/again 返回 "Hello lloyd again !!!"curl -vvv 127.0.0.1:8888/hello/world/again 在鉤子函數auth處理失敗觸發401錯誤處理函數, 自動跳轉到 URL: "/login"curl -vvv 127.0.0.1:8888/hello/lloyd.json 支援“/”和“.”作為pathinfo的分隔字元，並且和after鉤子函數配合，返回json格式文本 {"name": "lloyd"}curl -vvv 127.0.0.1:8888/hello/lloyd.js?jsoncallback=test返回jsonp格式文本 test({"name": "lloyd"})curl -vvv 127.0.0.1:8888/hello/lloyd.jsx?jsoncallback=test最後的尾碼名不匹配，輸出錯誤jsonp格式的訊息 test({"code":1,"msg":"error message..."})

效能

使用樹形結構來儲存url和handler的映射關係。尋找URL映射函數的時候保證了尋找回呼函數的效率O(log n)。
而傳統的以Regex做key映射handler方式，尋找回呼函數時間不穩定，最壞情況需要執行一遍所有的Regex。

DEMO

為了一邊測試，一邊完善這個庫。所以使用這個庫結合另外一個ActiveRecord和MicroTpl 寫了一個簡單的部落格，裡面基本涵蓋了這幾個庫的API。

