Hyperf框架中实现基于路径前缀的路由统一处理方案

背景介绍

在Hyperf框架开发中，我们经常会遇到需要根据URL路径前缀来统一处理请求的场景。例如，所有以"/v1/"开头的API请求都需要路由到同一个控制器方法进行处理。这种需求在API版本控制、多租户系统或统一入口处理等场景中非常常见。

传统路由方案的局限性

Hyperf框架提供了多种路由配置方式，包括注解路由和配置文件路由。常见的解决方案有：

1. AutoController注解：虽然可以自动映射控制器方法，但无法实现所有路径前缀统一到一个方法的功能。

2. 通配路由：如Router::get('/v1/{name}', 'ApiController::v1')，这种方式只能匹配单层路径，对于多层路径(如/v1/a/b)无法处理。

中间件解决方案

针对上述局限性，我们可以通过自定义中间件来实现更灵活的路由处理。下面是一个完整的实现方案：

<?php

namespace App\Middleware;

use App\Controller\RestfulController;
use FastRoute\Dispatcher;
use Hyperf\Context\RequestContext;
use Hyperf\Di\Annotation\Inject;
use Hyperf\HttpServer\Router\Dispatched;
use Hyperf\HttpServer\Router\DispatcherFactory;
use Hyperf\HttpServer\Router\Handler;
use Hyperf\Stringable\Str;
use Psr\Container\ContainerInterface;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
use Psr\Http\Server\MiddlewareInterface;
use Psr\Http\Server\RequestHandlerInterface;

class RouteMiddleware implements MiddlewareInterface
{
    #[Inject]
    private ContainerInterface $container;

    protected Dispatcher $dispatcher;

    public function __construct()
    {
        $this->dispatcher = $this->createDispatcher('http');
    }

    public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface
    {
        $uri = $request->getUri()->getPath();
        
        // 检查是否为v2开头的路径
        if (Str::startsWith($uri, '/v2/')) {
            // 尝试正常路由匹配
            $routes = $this->dispatcher->dispatch($request->getMethod(), $uri);
            
            // 如果没有匹配到路由，则统一处理
            if ($routes[0] === Dispatcher::NOT_FOUND) {
                $routeHandler = new Handler(
                    RestfulController::class . '@restfulApi',
                    $uri
                );

                // 构造新的路由信息
                $routes[0] = Dispatcher::FOUND;
                $routes[1] = $routeHandler;
                $routes[2] = [];

                // 设置新的请求分发信息
                $dispatched = new Dispatched($routes, 'http');
                $newRequest = RequestContext::set($request)
                    ->setAttribute(Dispatched::class, $dispatched);
                    
                return $handler->handle($newRequest);
            }
        }

        return $handler->handle($request);
    }

    protected function createDispatcher(string $serverName): Dispatcher
    {
        $factory = $this->container->get(DispatcherFactory::class);
        return $factory->getDispatcher($serverName);
    }
}

实现原理分析

1. 中间件拦截：通过中间件在请求处理前拦截所有请求。

2. 路径前缀检查：使用Str::startsWith()方法检查请求路径是否以特定前缀开头。

3. 路由匹配检查：先尝试正常路由匹配，如果匹配失败(返回NOT_FOUND)，则进行统一处理。

4. 动态路由构造：构造新的路由处理器(Handler)，指定统一处理的控制器和方法。

5. 请求重定向：通过修改请求的Dispatched属性，将请求重定向到指定的控制器方法。

方案优势

1. 灵活性高：可以处理任意层级的路径，不受路由通配符限制。

2. 兼容性好：不影响现有路由的正常工作，只对特定前缀的未匹配路由进行处理。

3. 可扩展性强：可以轻松扩展支持多个不同前缀的统一处理。

4. 维护方便：路由逻辑集中在一个中间件中，便于管理和修改。

实际应用场景

1. API版本控制：不同版本的API可以路由到不同的统一处理方法。

2. 多租户系统：根据路径前缀识别租户并路由到相应处理器。

3. 统一入口：为特定模块的所有请求提供统一入口点。

4. 灰度发布：通过路径前缀区分新旧版本实现灰度发布。

注意事项

1. 性能考虑：中间件会增加一定的处理开销，应合理设计匹配逻辑。

2. 路由优先级：确保中间件在路由中间件之后执行。

3. 异常处理：需要妥善处理统一方法中的各种异常情况。

4. 日志记录：建议记录统一处理的请求信息，便于调试和监控。

通过这种中间件方案，我们可以优雅地实现基于路径前缀的统一路由处理，为Hyperf应用提供更灵活的路由控制能力。