xinadmin / laravel-attr-route

v0.0.1-alpha 2026-09-11 17:23 UTC

Requires

• php: ^8.2
• illuminate/console: ^11.0 || ^12.0 || ^13.0
• illuminate/contracts: ^11.0 || ^12.0 || ^13.0
• illuminate/http: ^11.0 || ^12.0 || ^13.0
• illuminate/routing: ^11.0 || ^12.0 || ^13.0
• illuminate/support: ^11.0 || ^12.0 || ^13.0
• laravel/sanctum: ^3.0 || ^4.0
• symfony/finder: ^7.0 || ^8.0

Requires (Dev)

• orchestra/testbench: ^9.0 || ^10.0 || ^11.0
• phpunit/phpunit: ^10.5 || ^11.0 || ^12.0

MIT

• XinAdmin

• route
• routing
• annotation
• attribute
• laravel
• xinadmin

Published on Packagist.org on 2026-09-11 17:28 UTC

README

使用 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

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

参数	类型	说明
routePrefix	string	路由前缀，如 /admin/user
abilitiesPrefix	string	权限【能力】前缀，与方法注解的 authorize 拼接
middleware	string|array	控制器级中间件，作用于类下所有路由
authModel	?string	用户模型守卫，验证 token 属于的模型

方法注解

注解	HTTP 方法
#[GetRoute]	GET
#[PostRoute]	POST
#[PutRoute]	PUT
#[PatchRoute]	PATCH
#[DeleteRoute]	DELETE
#[AnyRoute]	所有方法

方法注解的公共参数：

参数	类型	默认值	说明
route	string	''	路由地址，与 routePrefix 拼接
authorize	string|bool	true	false 关闭鉴权；字符串时作为权限名与前缀拼接
middleware	string|array	''	路由级中间件
where	array	[]	路由参数正则约束，如 ['id' => '[0-9]+']

License

MIT