Laravel/Lumen 优化包 - 注解注入路由自动配置

背景

1. 因大量的路由配置信息，不一样时段的多人员开发，形成git冲突
2. 路由信息过多，形成维护困难

安装

composer require qklin/laravel-auto-router

注册中间件和提供者

安装包里已包含了几个demo版本的Middleware，自取自用

# add autorouter middleware
$app->routeMiddleware([
    //...

    'check_sign'   => \Qikl\AutoRouter\Middleware\CheckSignMiddleware::class,
    // ... more
]);

# add provider
$app->register(Qklin\AutoRouter\AppServiceProvider::class);

env

AUTO_ROUTER_MODULE_DIR=Modules
LARAVEL_ORIGIN_HTTP_PREFIX=h
AUTOROUTER_MODULE_HTTP_PREFIX=m,inside
AUTOROUTER_DEFAULT_MIDDLEWARE=token
AUTOROUTER_PROVIDER_START=1
AUTOROUTER_MIDDLEWARE_SUFFIX=OLNVIX

# middleware
AR_INSIDE_HOSTS=www.baidu.com,www.google.com
AR_CHECK_SIGN_TIMEOUT=30
AR_CHECK_SIGN_KEY=sdfsdfdf
AR_AUTH_API_DOMAIN=http://auth.baidu.com/checkauth
AR_API_THROTTLE=ar_api_throttle

# document variable
AR_DOCUMENT_ROUTER=arRouter
AR_DOCUMENT_METHOD=arMethod
AR_DOCUMENT_ONLY_INSIDE=arOnlyInside

使用

兼容原有已有在route.php里配置的路由

目前支持的注解

默认取上面定义名称来讲明

1. arRouter: 可直接配置方法携带后缀控制中间件
2. arMethod: POST|GET|PUT|...
3. arOnlyInisde: 路由必须inside开头

路由自动注入使用

1. api必须env配置（AUTOROUTER_MODULE_HTTP_PREFIX）前缀。
2. 路径包含驼峰目录以【_】分隔。like：HotKeys => hot_keys
3. 方法包含【.】的目录以【_】分隔。like：V1.0 => v1_0
4. 方法包含驼峰以【-】分隔。like：getListsO => get-list-o

控制器方法添加注解配置案例

具体案例, 模块根目录和控制器文件：app/Modules/Module/Hotkeys/V1.0/Controllers/IndexController.php
方法：getList，注解arRouter getListO
路由：/m/module/hot-keys/v1_0/index/get-list-o

/**
 * 案例一 纯路由注解
 * 匹配：/m/module/articles/college/detail
 * @arRouter
 * @return string
 */
public function detail()
{
}
 
/**
 * 案例二：路由注解并配置路由地址方法
 * 匹配：/m/module/articles/college/detail-o
 * @arRouter detailO
 * @return string
 */
public function detail()
{
}
 
 
/**
 * 案例三：路由注解请求方法和开启内网注解
 * 匹配，且前缀必须inside开头：/inside/module/articles/college/detail-o
 * 只支持post和get请求方法
 * @arRouter detailO
 * @arMehtod POST|GET
 * @arOnlyInside
 * @return string
 */
public function detail()
{
}

注解配置说明

1. O:Operate 操做 自动注入节流中间件
2. L:Look 查看 自动移除节流中间件[若是存在]
3. I:Inside 内网 自动注入内网中间件，且放置最前[若是不存在]，自动剔除token中间件
4. N:NotAuth 无需受权，公开api，自动移除token中间件[若是存在]
5. V:validate 请求验证，自动移除请求验证中间件[若是不存在]
6. X:checkSign 请求验签
7. 若是都不存在，默认根据route.php配置走

配置route.conf

// 文件位置：app/config/route.php
// 本文件可配置可不配置，根据需求配置
return [
    "middleware" => [  //中间件，目前只支持
        "controllers" => [ // 路由控制器路径 => 中间件
            "m/module/ctl/action" => ["token", "validate"],
        ],
        "actions"     => [ // 控制器方法 => 中间件
        ]
    ]
];

laravel版本

需在Application能够注入configure方法

/**
 * 加载配置文件
 * @param $name
 */
public function configure($name)
{
    if (isset($this->loadedConfigurations[$name])) {
        return;
    }

    $this->loadedConfigurations[$name] = true;

    $path = $this->getConfigurationPath($name);

    if ($path && is_file($path)) {
        $this->make('config')->set($name, require $path);
    }
}

/**
 * 获取配置路径
 * @param null $name
 * @return string
 */
public function getConfigurationPath($name = null)
{
    if (!$name) {
        $appConfigDir = $this->basePath('config') . '/';

        if (file_exists($appConfigDir)) {
            return $appConfigDir;
        } else if (file_exists($path = __DIR__ . '/../config/')) {
            return $path;
        }
    } else {
        $appConfigPath = $this->basePath('config') . '/' . $name . '.php';

        if (file_exists($appConfigPath)) {
            return $appConfigPath;
        } else if (file_exists($path = __DIR__ . '/../config/' . $name . '.php')) {
            return $path;
        }
    }
}