calject/lann-route

lann-route

Maintainers

Details

github.com/calject/lann-route

Source

Issues

Installs: 27

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 1

Forks: 0

Open Issues: 0

v1.1-beta 2020-01-19 09:38 UTC

Requires

MIT 6895bd8e19d933170e5dd82514ce3ff6fbff48a2

  • 沧澜 <lryhuimeng.woop@163.com>

routeannotationlaravelcalject

This package is auto-updated.

Last update: 2025-03-29 00:43:20 UTC

README

PHP version license

版本说明

v1.0

  • 基础版本(通过注解(doc注释)自动解析路由文件)

v1.1

  • 添加php artisan calject:route:file 命令根据注解(doc注释)生成路由文件
Description:
  根据注解路由生成路由文件

Usage:
  calject:route:file [options]

Options:
      --path[=PATH]     设置扫描的路径参数(目录/具体路由文件)，默认为app/Http/Controllers
      --env[=ENV]       设置生成的env环境路由,仅生成参数内配置的env路由,多个环境以,分割(例: local,develop),默认不检查@env(...)
      --force           是否强制生成文件，将覆盖原有文件,默认已存在的文件不重复生成

  • 添加 @des(...)、@env(...)、@file(...) Tag, 参考使用介绍

  • 路由生成示例(routes/test.php)

<?php

/**
 * Class UploadController
 * @package App\Http\Controllers\Annotation
 */
Route::group(["prefix" => "file", "namespace" => "Annotation"], function () {
    // 文件上传
    Route::post('upload', 'UploadController@upload');
    // 文件下载
    Route::get('download', 'UploadController@download');
});

/**
 * Class TestController
 * @package App\Http\Controllers\Annotation
 */
Route::group(["prefix" => "annotation", "middleware" => ["api"], "namespace" => "Annotation"], function () {
    Route::get('getPath', 'TestController@getPath');
    Route::post('setPath', 'TestController@setPath');
    Route::match(["get", "post", "put", "delete"], 'user', 'TestController@user')->name('user');
    Route::match(["get", "post", "put", "delete"], 'file', 'TestController@file');
    Route::match(["get", "post", "put", "delete"], 'article', 'TestController@article');
});

Table of Contents

一、介绍 top

laravel annotation route(laravel 注解路由实现)

缓存

  • 不使用该路由功能，仅使用根据注解生成路由文件(开发中... v1.1)
  • 配合laravel框架内置路由缓存php artisan route:cache使用(仅在生成路由缓存时遍历一次控制器文件)

二、安装 top

composer require calject/lann-route

三、使用 top

AnnotationRouteLocalProvider、AnnotationRouteProvider、AnnotationRoute

服务提供者注册实现

  • config/app.php => 'providers' 属性中添加AnnotationRouteLocalProvider或AnnotationRouteProvider服务提供者

AnnotationRouteLocalProvider仅在env环境为local中生效, AnnotationRouteProvider 在所有环境中生效, 可通过AnnotationRoute的env方法设置

自定义实现

  • app/Providers/RouteServiceProvider.php 中添加注解实现AnnotationRoute
    /**
     * Define the routes for the application.
     *
     * @return void
     */
    public function map()
    {
        $this->mapApiRoutes();

        $this->mapCreditRoutes();

        $this->mapDevelopRoutes();
        
        $this->mapTestRoutes();
        
        // 添加注解实现
        $annotationRoute = new AnnotationRoute();
        // $annotationRoute->envs('local');                 // 设置生效环境
        // $annotationRoute->envs(['local', 'develop']);    // 设置生效环境
        $annotationRoute->register(...);                    // 注册:实现Calject\LannRoute\Contracts\AnnotationTagInterface接口的tag类
        $annotationRoute->mapRefRoutes();
    
    }
  • 示例
<?php

namespace App\Http\Controllers\Annotation;

use App\Http\Controllers\Controller;
use Illuminate\Contracts\Routing\ResponseFactory;
use Illuminate\Http\Request;
use Illuminate\Http\Response;

/**
 * Class TestController
 * @package App\Http\Controllers\Annotation
 * @group(prefix='annotation', middleware='api')
 * @restful()
 */
class TestController extends Controller
{
    /**
     * @param Request $request
     * @return ResponseFactory|Response
     * @uri('testA')
     * @name(testA)
     */
    public function testA(Request $request)
    {
        return response('testA');
    }
    
    /**
     * @param Request $request
     * @return ResponseFactory|Response
     * @get('testB')
     */
    public function testB(Request $request)
    {
        return response('testB');
    }
    
    /**
     * @param Request $request
     * @return ResponseFactory|Response
     * @prefix('ttt')
     * @uri('testC, testC2')
     */
    public function testC(Request $request)
    {
        return response('testB');
    }
    
    /**
     * @param Request $request
     * @return ResponseFactory|Response
     * @api(uri='testD', method='post', middleware='test,td')
     */
    public function testD(Request $request)
    {
        return response('testB');
    }
    
    /**
     * @param Request $request
     * @return ResponseFactory|Response
     * @uri(testE)
     * @name(testE)
     * @middleware(query)
     */
    public function testE(Request $request)
    {
        return response('testD');
    }
}
  • 执行php artisan route:list查看路由列表
+--------+--------------------------+-----------------------+------------+--------------------------------------------------------------+-------------+
| Domain | Method                   | URI                   | Name       | Action                                                       | Middleware  |
+--------+--------------------------+-----------------------+------------+--------------------------------------------------------------+-------------+
|        | GET|POST|PUT|DELETE|HEAD | annotation/testA      | testA      | App\Http\Controllers\Annotation\TestController@testA         | api         |
|        | GET|HEAD                 | annotation/testB      |            | App\Http\Controllers\Annotation\TestController@testB         | api         |
|        | POST                     | annotation/testD      |            | App\Http\Controllers\Annotation\TestController@testD         | api,test,td |
|        | GET|POST|PUT|DELETE|HEAD | annotation/testE      | testE      | App\Http\Controllers\Annotation\TestController@testE         | api,query   |
|        | GET|POST|PUT|DELETE|HEAD | ttt/annotation/testC  |            | App\Http\Controllers\Annotation\TestController@testC         | api         |
|        | GET|POST|PUT|DELETE|HEAD | ttt/annotation/testC2 |            | App\Http\Controllers\Annotation\TestController@testC         | api         |
+--------+--------------------------+-----------------------+------------+--------------------------------------------------------------+-------------+

Class Annotation Tag

类注解(作用于所有类方法上,方法上定义同类型tag覆盖类定义)

@file(...)

  • @file('filePath') 设置生成的路由文件名(可忽略后缀)
  • 示例1: @file('route.php') 生成路由文件为routes目录下route.php文件
  • 示例2: @file(article) 生成路由文件为routes目录下article.php文件
  • 示例3: @file(test/article) 生成路由文件为routes/test目录下article.php文件

@group(...)

  • @group(xxx='xxx',xxx='xxx',...)
    • prefix[string] : 前缀
    • method[array] : 请求类型, --
      • get
      • post
      • put
      • delete
      • ...
    • middleware[array] : 请求中间件
  • 示例1: @group(method='get', prefix='query', middleware='api_query')
  • 示例2: @group(method='get,post,put,delete', prefix='test')

@env(...)

  • @env('local') 添加访问环境限制
  • 示例1: @env('local') local环境生效
  • 示例2: @env(all) 所有环境生效
  • 示例3: @env(local, develop, feature) [local,develop,feature]环境生效

@prefix(...)

  • @prefix('string') 添加请求前缀
  • 示例: @prefix('test')

@middleware(...)

  • @middleware('array') 添加请求中间件
  • 示例1: @middleware('api')
  • 示例2: @middleware('api, query')

@any(...)

  • @any() 添加restful定义，等同于@method('get,post,put,delete,...')
  • @any(xxx='xxx',xxx='xxx',...)
    • prefix[string] : 前缀
    • middleware[array] : 请求中间件
  • 示例1: @any()
  • 示例2: @any(prefix='api', middleware='api')

@restful(...)

  • @restful() 添加restful定义，等同于@method('get,post,put,delete')
  • @restful(xxx='xxx',xxx='xxx',...)
    • prefix[string] : 前缀
    • middleware[array] : 请求中间件
  • 示例1: @restful()
  • 示例2: @restful(prefix='api', middleware='api')

@get(...)

  • @get()
  • @get(xxx='xxx',xxx='xxx',...)
    • prefix[string] : 前缀
    • middleware[array] : 请求中间件
  • 示例1: @get()
  • 示例2: @get(prefix='api', middleware='api')

@post(...)

  • @post()
  • @post(xxx='xxx',xxx='xxx',...)
    • prefix[string] : 前缀
    • middleware[array] : 请求中间件
  • 示例1: @post()
  • 示例2: @post(prefix='api', middleware='api')

@put(...)

  • @put()
  • @put(xxx='xxx',xxx='xxx',...)
    • prefix[string] : 前缀
    • middleware[array] : 请求中间件
  • 示例1: @put()
  • 示例2: @put(prefix='api', middleware='api')

@delete(...)

  • @delete()
  • @delete(xxx='xxx',xxx='xxx',...)
    • prefix[string] : 前缀
    • middleware[array] : 请求中间件
  • 示例1: @delete()
  • 示例2: @delete(prefix='api', middleware='api')

Function Annotation Tag

@uri(...)

  • @uri('array') 添加请求地址
  • 示例1: @uri('test')
  • 示例2: @uri('test1, test2') 将生成两个地址: xxx/test1 xxx/test2

@name(...)

  • @name('string') 添加别名
  • 示例 @name('test')

@des(...)

  • @des('路由描述') 生成路由文件的路由描述
  • 示例1: @env('请求测试')

@env(...)

  • @env('local') 添加访问环境限制
  • 示例1: @env('local') local环境生效
  • 示例2: @env(all) 所有环境生效
  • 示例3: @env(local, develop, feature) [local,develop,feature]环境生效

@prefix(...)

  • @prefix('string') 添加请求前缀
  • 示例: @prefix('test')

@middleware(...)

  • @middleware('array') 添加请求中间件
  • 示例1: @middleware('api')
  • 示例2: @middleware('api, query')

@any(...)

  • @any() 添加restful定义，等同于@method('get,post,put,delete,...')
  • @any(xxx='xxx',xxx='xxx',...)
    • prefix[string] : 前缀
    • middleware[array] : 请求中间件
  • 示例1: @any()
  • 示例2: @any(prefix='api', middleware='api')

@restful(...)

  • @restful() 添加restful定义，等同于@method('get,post,put,delete')
  • @restful('uri[array]') 添加restful定义，并添加uri访问地址
  • @restful(xxx='xxx',xxx='xxx',...)
    • prefix[string] : 前缀
    • middleware[array] : 请求中间件
  • 示例1: @restful()
  • 示例2: @restful(prefix='api', middleware='api')
  • 示例3: @restful('test')

@get(...)

  • @get()
  • @get('uri[array]')
  • @get(xxx='xxx',xxx='xxx',...)
    • prefix[string] : 前缀
    • middleware[array] : 请求中间件
  • 示例1: @get()
  • 示例2: @get(prefix='api', middleware='api')
  • 示例3: @egt('test')

@post(...)

  • @post()
  • @post('uri[array]')
  • @post(xxx='xxx',xxx='xxx',...)
    • prefix[string] : 前缀
    • middleware[array] : 请求中间件
  • 示例1: @post()
  • 示例2: @post(prefix='api', middleware='api')
  • 示例3: @post('test')

@put(...)

  • @put()
  • @put('uri[array]')
  • @put(xxx='xxx',xxx='xxx',...)
    • prefix[string] : 前缀
    • middleware[array] : 请求中间件
  • 示例1: @put()
  • 示例2: @put(prefix='api', middleware='api')
  • 示例3: @put('test')

@delete(...)

  • @delete()
  • @delete('uri[array]')
  • @delete(xxx='xxx',xxx='xxx',...)
    • prefix[string] : 前缀
    • middleware[array] : 请求中间件
  • 示例1: @delete()
  • 示例2: @delete(prefix='api', middleware='api')
  • 示例3: @delete('test')

四、拓展 top

  1. 实现Calject\LannRoute\Contracts\AnnotationTagInterface接口或者继承Calject\LannRoute\Contracts\AbsAnnotationTag抽象类, 参考src/Components/Tag/目录下的tag实现
  2. 在AnnotationRoute中注册
  • 示例
<?php

namespace Calject\LannRoute\Components\Tag;

use Calject\LannRoute\Components\Model\RouteClassData;
use Calject\LannRoute\Components\Model\RouteFuncData;
use Calject\LannRoute\Constant\RouteConstant;
use Calject\LannRoute\Contracts\AbsAnnotationTag;

/**
 * Class Route
 * @package Calject\LannRoute\Components\Tag
 * @example @route(xxx='xxx',xxx='xxx',...)
 */
class Route extends AbsAnnotationTag
{
    /**
     * @return string
     */
    public function tag(): string
    {
        return 'route';
    }
    
    /**
     * @param RouteFuncData|RouteClassData $route
     * @param array|string $params
     * @return mixed
     */
    public function handle($route, $params)
    {
        $this->doRoutes($route, $params);
    }
    
    /**
     * tag过滤参数(数组或者为空)
     * @return array|mixed|null|void
     */
    public function tagParams()
    {
        return ['middleware', 'uri', 'method'];
    }
    
    /**
     * 作用范围, 可选: class, function
     * @return array|string
     */
    public function scope()
    {
        return RouteConstant::SCOPE_FUNCTION;
    }
}
  • 注册
// 添加注解实现
$annotationRoute = new AnnotationRoute();
$annotationRoute->register(new Tag());
$annotationRoute->mapRefRoutes();
  • 使用
<?php

namespace App\Http\Controllers\Annotation;

use App\Http\Controllers\Controller;
use Illuminate\Contracts\Routing\ResponseFactory;
use Illuminate\Http\Request;
use Illuminate\Http\Response;

/**
 * Class TestController
 * @package App\Http\Controllers\Annotation
 * @group(prefix='annotation', middleware='api')
 */
class TestController extends Controller
{
    /**
     * @param Request $request
     * @return ResponseFactory|Response
     * @route(uri='test', method='get')
     */
    public function test(Request $request)
    {
        return response('test');
    }
}

Plan

v1.2 (待定...)

  • 添加路由配置route.ini配置文件，作用于文件夹下所有控制器类
    • 可以使用已定义的所有作用于CLASS级别的tag，如@restful、@file()、@middleware()
    • 子级目录将覆盖父级目录的定义
    • 类中定义的@tag(...)将覆盖route.ini的配置
      • 如route.ini中定义prefix=api, class中添加@prefix(test),最终class的prefix为test/...
待定模式@tag{}、@tag[]

  • 添加@tag{...}模式,标识tag相关内容为追加, 不覆盖php.ini及上级类的@tag

    • 支持tag
      • @method、@middleware、@prefix、@file、@env
    • 如route.ini中定义prefix=api, class中添加@prefix{test},最终class的prefix为api/test/...

  • 添加@tag[...]模式，标识tag相关内容为删除, 删除其上层相关配置

    • 如route.ini中定义middleware=api,query, class中添加@middleware[api],最终class的middleware为query
    • 如TestController注释中添加@method(get,post), function注释中添加@method[post],最终function请求method为get

  • 示例:

method=get,post,put,delete
prefix=annotation
middleware=api
...

v1.1 (开发...)

  • 添加@env(...)作用环境

    • 作用环境: CLASS 、FUNCTION
    • 示例: @env(produce) | @env(local,develop)

  • 添加根据路由注解生成路由文件功能

    • 添加命令php artisan calject:route:file 根据路由注解生成文件
    • 添加tag@file(...) : 生成路由的文件名(作用于当前类)
      • 作用范围: CLASS
      • 示例: @file(route.php) | @file(test/route.php) 将在routes目录下生成对应的路由文件

  • 示例

<?php

/**
 * Class TestController
 * @env(produce,develop,local)  限定produce,develop,local环境生效
 * @file(route.php)
 */
class TestController extends Controller
{
    /**
     * @return ResponseFactory|Response
     * @route(uri='test', method='get')
     * @env(local) 限定local生效
     */
    public function test()
    {
        return response('test');
    }
}