PHP路由中通过call_user_func_array传递参数的技巧与实践

<?php

error_reporting(E_ALL);
ini_set('display_errors', 'On');

final class Router
{
    /**
     * 存储所有路由规则，键为正则表达式，值为可调用对象（callable）
     * 示例: (POST|GET)_/testMultiple/(\d+)/(\S+)
     * @var array<string, callable>
     */
    private array $routes = [];

    /**
     * 注册路由规则
     *
     * @param string $path URL路径模式，可包含正则表达式捕获组
     * @param callable $action 匹配成功后要执行的可调用对象（通常是控制器方法）
     * @param string $methods 允许的HTTP方法，默认为'POST|GET'
     * @return void
     */
    public function any(string $path, callable $action, string $methods = 'POST|GET'): void
    {
        // 简单的安全检查，防止路径注入
        if (strpos($path, '..') !== false) {
            return;
        }
        // 将HTTP方法和路径模式组合成一个正则表达式键
        $this->routes['(' . $methods . ')_' . $path] = $action;
    }

    /**
     * 根据当前请求的URL调用匹配的路由
     *
     * @param string $path 当前请求的URI
     * @return string 路由动作的执行结果
     * @throws Exception 如果未找到匹配的路由
     */
    public function callRoute(string $path): string
    {
        // 构造完整的匹配路径，包括HTTP方法和URI
        // 示例: GET_/testMultiple/123/test
        $requestPath = $_SERVER['REQUEST_METHOD'] . '_' . parse_url($path, PHP_URL_PATH);

        // 遍历所有已注册的路由规则
        foreach ($this->routes as $routePattern => $action) {
            // 构建完整的正则表达式，包括起始和结束锚点，并支持可选的末尾斜杠
            $regEx = "~^$routePattern/?$~i";
            $matches = [];

            // 使用preg_match尝试匹配当前请求路径
            if (!preg_match($regEx, $requestPath, $matches)) {
                continue; // 不匹配则尝试下一个路由
            }

            // 如果匹配成功，我们需要从$matches数组中提取真正的URL参数。
            // preg_match的结果中：
            // $matches[0] 是整个匹配到的字符串
            // $matches[1] 是第一个捕获组（在这里是HTTP方法，如'GET'）
            // $matches[2] 及以后是URL路径中的参数捕获组
            array_shift($matches); // 移除$matches[0] (完整匹配字符串)
            array_shift($matches); // 移除$matches[1] (HTTP方法)

            // 剩余的$matches元素即为从URL中捕获到的参数
            $arguments = $matches;

            // 使用call_user_func_array调用控制器方法，并传入捕获到的参数
            return call_user_func_array($action, $arguments);
        }
        // 如果遍历完所有路由都未找到匹配项，则抛出异常
        throw new Exception(sprintf('Route %s not found', $requestPath));
    }
}

final class TestController
{
    public function indexAction(): string
    {
        return 'Hello world';
    }

    public function testPost(): string
    {
        return 'Hello this is post only';
    }

    // 接收一个字符串参数
    public function testAction(string $parameter1): string
    {
        return 'Hello ' . $parameter1;
    }

    // 接收一个可选的字符串参数
    public function testOptionalAction(?string $parameter1 = null): string
    {
        return 'Hello ' . ($parameter1 ?? 'Guest');
    }

    // 接收多个不同类型的参数
    public function testMultiple(int $parameter1, string $parameter2): string
    {
        return 'The first value is ' . $parameter1 . ' and the second is ' . $parameter2;
    }
}

// 简单的服务容器（用于实例化控制器）
$services = [];
$services[TestController::class] = function () use ($services) {
    return new TestController();
};

// 实例化路由器
$router = new Router();

// 定义路由规则
// 1. 根路由
$router->any('/', [$services[TestController::class](), 'indexAction']);

// 2. 带有单个字符串参数的路由
// (\S+) 匹配任意非空白字符一次或多次
$router->any('/test/(\S+)', [$services[TestController::class](), 'testAction']);

// 3. 带有可选参数的路由
// /?(\S+)? 匹配可选的斜杠，后面跟着可选的非空白字符
$router->any('/testOptional/?(\S+)?', [$services[TestController::class](), 'testOptionalAction']);

// 4. 带有多个不同类型参数的路由
// (\d+) 匹配一个或多个数字 (int)
// (\S+) 匹配一个或多个非空白字符 (string)
$router->any('/testMultiple/(\d+)/(\S+)', [$services[TestController::class](), 'testMultiple']);

// 5. 仅限POST请求的路由
$router->any('/testJustPost', [$services[TestController::class](), 'testPost'], 'POST');

// 执行路由分发
// $_SERVER['REQUEST_URI'] 包含了完整的请求URI，例如 "/testMultiple/123/example"
echo $router->callRoute($_SERVER['REQUEST_URI']);