摘要：非常輕量級的單一文件的路由器。會將真實的名作為參數傳入需要你在此方法中調度來執行真正的請求方法。例如網站維護時可允許配置的值為路由將會直接執行此路由。

inhere/sroute 非常輕量級的單一文件的路由器。簡潔、自定義性強

referrer the project noahbuschermacaw , but add some feature.

支持請求方法: GET POST PUT DELETE HEAD OPTIONS

支持事件: found notFound. 你可以做一些事情當觸發事件時(比如記錄日志等)

支持設置匹配路由的解析器: SRoute::setMatchedRouteParser(). 你可以自定義如何調用匹配的路由處理程序.

支持自動匹配路由到控制器就像 yii 一樣, 請參看配置項 autoRoute.

支持手動調度一個路由通過方法 SRoute::dispatchTo()

你也可以不配置任何東西, 它也能很好的工作

{
    "require": {
        "inhere/sroute": "dev-master"
    }
}

首先, 導入類

use inheresrouteSRoute;

// 匹配 GET 請求. 處理器是個閉包 Closure
SRoute::get("/", function() {
    echo "hello";
});

// 匹配參數 "test/john"
SRoute::get("/test/(w+)", function($arg) {
    echo $arg; // "john"
});

// 匹配 POST 請求
SRoute::post("/user/login", function() {
    var_dump($_POST);
});

// 匹配 GET 或者 POST
SRoute::map(["get", "post"], "/user/login", function() {
    var_dump($_GET, $_POST);
});

// 允許任何請求方法
SRoute::any("/home", function() {
    echo "hello, you request page is /home";
});

如果配置了 "ignoreLastSep" => true, "/index" 等同于 "/index/"

SRoute::get("/index", "appcontrollersHome@index");

動態匹配控制器方法, 需配置 "dynamicAction" => true

NOTICE: 使用動態匹配控制器方法, 應當使用 any() 添加路由. 即此時無法限定請求方法 REQUEST_METHOD

// 訪問 "/home/test" 將會執行 "appcontrollersHome::test()"
SRoute::any("/home/(w+)", appcontrollersHome::class);

// 可匹配 "/home", "/home/test" 等
SRoute::any("/home(/w+)?", appcontrollersHome::class);

上面兩個的區別是 第一個無法匹配 /home

配置 actionExecutor 為你需要的方法名，例如配置為 "actionExecutor" => "run"，那所有的方法請求都會提交給此方法。
會將真實的action名作為參數傳入run($action), 需要你在此方法中調度來執行真正的請求方法。

在你需要將路由器整合到自己的框架時很有用

示例：

// 訪問 "/user", 將會調用 appcontrollersUser::run("")
SRoute::get("/user", "appcontrollersUser");

// 訪問 "/user/profile", 將會調用 appcontrollersUser::run("profile")
SRoute::get("/user/profile", "appcontrollersUser");

// 同時配置 "actionExecutor" => "run" 和 "dynamicAction" => true,
// 訪問 "/user", will call appcontrollersUser::run("")
// 訪問 "/user/profile", will call appcontrollersUser::run("profile")
SRoute::get("/user(/w+)?", "appcontrollersUser");

支持自動匹配路由到控制器就像 yii 一樣, 需配置 autoRoute.

    "autoRoute" => [
        "enable" => 1, // 啟用
        "controllerNamespace" => "examplescontrollers", // 控制器類所在命名空間
        "controllerSuffix" => "Controller", // 控制器類后綴
    ],

配置 "matchAll" 可用于攔截所有請求。 （例如網站維護時）

可允許配置 "matchAll" 的值為

路由path

    "matchAll" => "/about", // a route path

將會直接執行此路由。

回調

    "matchAll" => function () {
        echo "System Maintaining ... ...";
    },

將會直接執行此回調

SRoute::any("/404", function() {
    echo "Sorry,This page {$_GET["path"]} not found.";
});

// 成功匹配路由
SRoute::on(SRoute::FOUND, function ($uri, $cb) use ($app) {
    $app->logger->debug("Matched uri path: $uri, setting callback is: " . is_string($cb) ? $cb : get_class($cb));
});

// 當匹配失敗, 重定向到 "/404"
SRoute::on("notFound", "/404");

// 或者, 當匹配失敗, 輸出消息...
SRoute::on("notFound", function ($uri) {
    echo "the page $uri not found!";
});

// set config
SRoute::config([
    "stopOnMatch" => true,
    "ignoreLastSep" => true,
    "dynamicAction" => true,
    
//    "matchAll" => "/", // a route path
//    "matchAll" => function () {
//        echo "System Maintaining ... ...";
//    },
    
    // enable autoRoute, work like yii framework
    // you can access "/demo" "/admin/user/info", Don"t need to configure any route
    "autoRoute" => [
        "enable" => 1,
        "controllerNamespace" => "examplescontrollers",
        "controllerSuffix" => "Controller",
    ],
]);

默認配置如下

// 所有的默認的配置
[
    // stop on matched. only match one
    "stopOnMatch" => true,
    // Filter the `/favicon.ico` request.
    "filterFavicon" => false,
    // ignore last "/" char. If is True, will clear last "/", so "/home" equals to "/home/"
    "ignoreLastSep" => false,

    // match all request.
    // 1. If is a valid URI path, will match all request uri to the path.
    // 2. If is a callable, will match all request then call it
    "matchAll" => "", // eg: "/site/maintenance" or `function () { echo "System Maintaining ... ..."; }`

    // auto route match @like yii framework
    "autoRoute" => [
        // If is True, will auto find the handler controller file.
        "enable" => false,
        // The default controllers namespace, is valid when `"enable" = true`
        "controllerNamespace" => "", // eg: "appcontrollers"
        // controller suffix, is valid when `"enable" = true`
        "controllerSuffix" => "",    // eg: "Controller"
    ],

    // default action method name
    "defaultAction" => "index",

    // enable dynamic action.
    // e.g
    // if set True;
    //  SRoute::any("/demo/(w+)", appcontrollersDemo::class);
    //  you access "/demo/test" will call "appcontrollersDemo::test()"
    "dynamicAction" => false,

    // action executor. will auto call controller"s executor method to run all action.
    // e.g
    //  `run($action)`
    //  SRoute::any("/demo/(:act)", appcontrollersDemo::class);
    //  you access `/demo/test` will call `appcontrollersDemo::run("test")`
    "actionExecutor" => "", // "run"
]

NOTICE: 必須在調用 SRoute::dispatch() 之前使用 SRoute::config() 來進行一些配置

SRoute::dispatch();

你可以通過 bash ./php_server 來運行一個測試服務器, 現在你可以訪問 http://127.0.0.1:5670

github

git@osc