在 Laravel 中封装路由注解

在 Laravel 中，你可以在 routes 目录下创建路由的声明文件，例如 web.php 或者 api.php。这篇文章描述了另一种方式：通过扫描注解来注册路由。

示例

为了简化路由的编写，可以通过注解的方式来显示路由，也避免了编写路由需要跳转文件。先来看示例:

#[GetMapping(path: '/user/register')]
public function register() {}

看上去，使用注解会比在文件中单独声明要来的方便。

实现

首先你可能要创建一个注解类:

#[Attribute(Attribute::TARGET_METHOD)]
class GetMapping
{
    public function __construct(
        public string $path,
        public string $prefix = 'api'
    ) {}
}

接着，注解注解就是注释加上解释。肯定要在某一个时间点，去解析注释，你可以在 web.php 或者 api.php 中去解析注解。核心逻辑如下:

扫描控制器目录下 app\Http\Controllers 中的.php 结尾的代码文件
遍历每一个控制器中的每一个方法，利用反射读取是否包含 #[GetMapping] 之类的注解
如果包含路由注解，则获取注解中的参数，调用 Route 门面类自动注册路由

扫描控制器目录下的文件

我们先来看第 1 步，扫描控制器目录下的代码文件, 示例代码如下:

public static function scanForFiles(string $basePath): array
{
    $directoryIterator = new RecursiveDirectoryIterator($basePath);
    $recursiveIterator = new RecursiveIteratorIterator($directoryIterator);

    $controllerFiles = [];
    foreach ($recursiveIterator as $file) {
        if ($file->isDir() || in_array($file->getFilename(), '.php')) {
            continue;
        }
        if (str_contains($file->getFilename(), 'Controller.php')) {
            $controllerFiles[] = $file->getPathname();
        }
    }
    return $controllerFiles;
}

遍历控制器文件

接着，就是遍历控制器下的文件, 转换文件名到命名空间

foreach ($controllerFiles as $file) {
    // 只是说明一个思路，命名空间转换的代码就不贴出来了
    $controller = ControllerHelper::convertPathToNamespace($file);
    $reflectionClass = new ReflectionClass($controller);

    $methods = $reflectionClass->getMethods(ReflectionMethod::IS_PUBLIC);
    foreach ($methods as $method) {
        // todo: 扫描注解，自动注册路由
    }
}

扫描注解注册路由

最后一步，就是扫描注解注册路由了:

$attribute = collect($method->getAttributes())
    ->filter(fn (ReflectionAttribute $attribute) => $attribute->getName() === GetMapping::class)->first();
$uri = $attribute->newInstance()->path;
Route::{$routesMapping[$attribute->getName()]}($uri, [$controller, $method->getName()]);