前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >Laravel/Lumen 优化包 - 注解注入路由自动配置

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

作者头像
猿哥
发布2019-11-28 23:51:52
1.3K0
发布2019-11-28 23:51:52
举报
文章被收录于专栏:Web技术布道师

背景

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

安装

代码语言:javascript
复制
composer require qklin/laravel-auto-router

注册中间件和提供者

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

代码语言:javascript
复制
# add autorouter middleware
$app->routeMiddleware([
    //...

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

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

env

代码语言:javascript
复制
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
控制器方法添加注解配置案例
代码语言:javascript
复制
具体案例, 模块根目录和控制器文件: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
代码语言:javascript
复制
// 文件位置:app/config/route.php
// 本文件可配置可不配置,根据需求配置
return [
    "middleware" => [  //中间件,目前只支持
        "controllers" => [ // 路由控制器路径 => 中间件
            "m/module/ctl/action" => ["token", "validate"],
        ],
        "actions"     => [ // 控制器方法 => 中间件
        ]
    ]
];
laravel版本

需在Application可以注入configure方法

代码语言:javascript
复制
/**
 * 加载配置文件
 * @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;
        }
    }
}
本文参与 腾讯云自媒体同步曝光计划,分享自微信公众号。
原始发表:2019-11-27,如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 PHP技术大全 微信公众号,前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体同步曝光计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
目录
  • 背景
  • 安装
  • 注册中间件和提供者
  • env
  • 使用
    • 目前支持的注解
      • 路由自动注入使用
        • 控制器方法添加注解配置案例
          • 注解配置说明
            • 配置route.conf
              • laravel版本
              相关产品与服务
              消息队列 TDMQ
              消息队列 TDMQ (Tencent Distributed Message Queue)是腾讯基于 Apache Pulsar 自研的一个云原生消息中间件系列,其中包含兼容Pulsar、RabbitMQ、RocketMQ 等协议的消息队列子产品,得益于其底层计算与存储分离的架构,TDMQ 具备良好的弹性伸缩以及故障恢复能力。
              领券
              问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档