Laravel 注解路由

Route and Event Annotations for the Laravel Framework

安装/使用

• composer 安装

composer require "laravelcollective/annotations:5.8.*"

• 创建app/Providers/AnnotationsServiceProvider.php

<?php

namespace App\Providers;

use Collective\Annotations\AnnotationsServiceProvider as ServiceProvider;

class AnnotationsServiceProvider extends ServiceProvider
{
    /**
     * The classes to scan for event annotations
     * @var array
     */
    protected $scanEvents = [];

    /**
     * The classes to scan for route annotations
     * @var array
     */
    protected $scanRoutes = [];

    /**
     * The classes to scan for model annotations
     * @var array
     */
    protected $scanModels = [];

    /**
     * Determines if we will auto-scan in the local environment.
     * @var bool
     */
    protected $scanWhenLocal = false;

    /**
     * Determines whether or not to automatically scan the controller
     * @var bool
     */
    protected $scanControllers = false;

    /**
     * Determines whether or not to automatically scan all namespaced
     * @var bool
     */
    protected $scanEverything = false;

    /**
     * 指定扫描的Controllers
     * @return array
     */
    public function routeScans()
    {
        static $app_path = [
            'Api',
            'Http',
        ];

        $classes = parent::routeScans();

        foreach ($app_path as $path) {
            $classes = array_merge(
                $classes,
                $this->getClassesFromPath("app/$path/Controllers")
            );
        }

        return $classes;
    }

    protected function getClassesFromPath(string $path)
    {
        $directory = base_path($path);

        return $this->app->make('Collective\Annotations\Filesystem\ClassFinder')
            ->findClasses($directory);
    }
}

• 修改config/app.php

'providers' => [
  // ...
  App\Providers\AnnotationsServiceProvider::class
  // ...
];

• 创建app/api/Controllers/TestController.php

<?php

namespace App\Api\Controller;

use App\Api\Controller as BaseController;
use Collective\Annotations\Routing\Annotations\Annotations\{
    Controller, Get
};

/**
 * Class TestController
 * @package App\Api\Controller
 *
 * @Controller(prefix="/api/test")
 */
class TestController extends BaseController
{
    /**
     * @Get("/test_route")
     */
    public function test_route()
    {
        dd('1024');
    }
}

• 执行 php artisan route:scan

• 生成了/storage/framework/routes.scanned.php

<?php 
$router->get('api/test/test_route', [
	'uses' => 'App\Api\Controller\TestController@test_route',
	'as' => NULL,
	'middleware' => [],
	'where' => [],
	'domain' => NULL,
]);

• 访问路由laravel8.test/api/test/test_route即可

其他命令参考: Laravel Annotations