Laravel Attribute Route

使用 PHP 8 注解（Attributes）注册 Laravel 路由与 Sanctum 验证的轻量级组件

在控制器上通过注解声明路由、中间件与权限，无需再手动维护路由文件：

<?php

namespace App\Http\Controllers;

use Xin\AnnoRoute\Attribute\GetRoute;
use Xin\AnnoRoute\Attribute\PostRoute;
use Xin\AnnoRoute\Attribute\RequestAttribute;

#[RequestAttribute(routePrefix: '/admin/user', abilitiesPrefix: 'admin')]
class UserController
{
    // GET /admin/user/list，需要登录态与 admin.user.list 权限
    #[GetRoute(route: '/list', authorize: 'user.list')]
    public function list()
    {
        // ...
    }

    // POST /admin/user/create，跳过鉴权，加限流中间件
    #[PostRoute(route: '/create', authorize: false, middleware: 'throttle:10')]
    public function create()
    {
        // ...
    }
}

环境要求

• PHP >= 8.2（Laravel 13 需要 PHP >= 8.3）
• Laravel 11 / 12 / 13

安装

composer require xin/attr-route

发布配置文件（可选）：

php artisan vendor:publish --tag=attr-route

快速开始

默认情况下，ServiceProvider 会自动扫描 app/Http/Controllers 并注册所有注解路由。 扫描目录可在 config/attr-route.php 的 scan_paths 中修改：

'scan_paths' => [
    app_path('Http/Controllers'),
],

也可以关闭自动扫描（'auto_scan' => false），在你自己的 ServiceProvider 中手动注册：

use Xin\AnnoRoute\Contracts\AttrRoute;

public function boot(AttrRoute $annoRoute): void
{
    $annoRoute->register(app_path('Http/Controllers'));
    // 支持数组
    $annoRoute->register([$pathA, $pathB]);
}

注解说明

类注解 RequestAttribute

标注在控制器类上，是所有路由注解生效的前提：

方法注解

方法注解的公共参数：

License

MIT