AFF重构技术选型

环球易购

• PHP版本: 7.2
• 开发框架: laravel 5.7
• PHP PSR 标准规范
• 编码规范: PSR-2
• 开发IDE: phpstorm
• 数据库
  
  • MySQL 5.7
  • Elasticsearch 6.3
• 中间件(消息队列)
  
  • RabbitMQ
  • Kafka
• 缓存: Redis Sentinel
• 进程监控工具: supervisord(MQ实时消费)
• 定时任务: e-job

• 代码注释

  • phpstorm注释模板设置
    
    • File-->Default Settings-->Editor-->File and Code Templates
  • 文件头注释(PHP File Header)

  /**
   * description: 
   * author: zhangshuang@globaegrow.com
   * date: ${DATE}
   */

  

  • 方法注释(PHP Function Doc Comment)

  /**
   * description: 
   * author: zhangshuang@globaegrow.com
   * date: ${DATE}
   * 
  ${PARAM_DOC}
  #if (${TYPE_HINT} != "void") * @return ${TYPE_HINT}
  #end
  ${THROWS_DOC}
  */

  

  • 示例

  <?php
  /**
   * description:
   * author: zhangshuang@globaegrow.com
   * date: 2019/1/28
   */
  namespace App\Http\Controllers\Web;
  use App\Http\Controllers\Controller;
  class TestController extends Controller
  {
      /**
       * description:
       * author: zhangshuang@globaegrow.com
       * date: 2019/1/28
       *
       * @param array $data
       * @param string $name
       * @return array
       */
      public function test(array $data, $name = '')
      {
          return [];
      }
  }

• 代码目录说明

.
├── app
│   ├── Console         //定时任务及命令存放目录
│   │   ├── Commands
│   │   └── Kernel.php  //定时任务及命令入口文件
│   ├── Enum            //常量存放目录
│   │   ├── CodeEnum.php
│   │   ├── CommonEnum.php
│   │   ├── LoggerEnum.php
│   │   └── MerchantConfigEnum.php
│   ├── Events          //事件存放目录
│   │   ├── Event.php
│   │   └── ExampleEvent.php
│   ├── Exceptions      
│   │   └── Handler.php //框架异常出口文件
│   ├── Helpers.php     //公共方法文件
│   ├── Http
│   │   ├── Controllers     //Contollers存放目录，按模块分目录
│   │   │   ├── Admin
│   │   │   │   └── MerchantController.php
│   │   │   ├── Api
│   │   │   │   └── AdvertiseController.php
│   │   │   ├── Controller.php
│   │   │   ├── ExampleController.php
│   │   │   └── Web
│   │   │       ├── LangController.php
│   │   │       └── TestController.php
│   │   └── Middleware          //HTTP中间件存放目录
│   │       ├── AdminAuth.php
│   │       ├── ApiAuth.php
│   │       ├── Authenticate.php
│   │       ├── ExampleMiddleware.php
│   │       └── LangAuth.php
│   ├── Jobs                    //lumen队列Job存放目录
│   │   ├── ExampleJob.php
│   │   └── Job.php
│   ├── Listeners               //事件监听者存放目录
│   │   ├── ExampleListener.php
│   │   └── QueryListener.php
│   ├── Models                  //Models存放目录
│   │   ├── AdvertisinUrlInfo.php
│   │   ├── MerchantBussinessConfig.php
│   │   ├── MerchantConfig.php
│   │   └── Model.php
│   ├── Providers           
│   │   ├── AppServiceProvider.php
│   │   ├── AuthServiceProvider.php
│   │   ├── EventServiceProvider.php    //事件注册文件
│   │   └── LogServiceProvider.php
│   ├── Services                        //Services存放目录，按模块分目录
│   │   ├── Admin
│   │   │   └── Merchant.php
│   │   ├── Api
│   │   │   ├── Advertise.php
│   │   │   └── Validation.php
│   │   ├── Service.php
│   │   └── Traits                  //Trait存放目录，按模块分目录
│   ├── User.php
│   └── Utils                       //自定义公共类库
│       ├── HttpQuery.php
│       ├── Time.php
│       └── Validation.php
├── artisan                         //命令行入口文件
├── bootstrap
│   └── app.php                     //框架初始化文件
├── composer.json
├── composer.lock
├── config                          //存放配置文件目录
│   ├── apis.php
│   ├── app.php
│   ├── cache.php
│   ├── database.php
│   ├── elasticsearch.php
│   ├── elink.php
│   └── queue.php
├── database
│   ├── factories
│   │   └── ModelFactory.php
│   ├── migrations              //建表文件
│   │   ├── 2019_01_10_065103_create_advertisin_url_info_table.php
│   │   ├── 2019_01_10_065113_create_merchant_business_config_table.php
│   │   └── 2019_01_14_091651_create_merchant_config_table.php
│   └── seeds           
│       └── DatabaseSeeder.php
├── phpunit.xml
├── public
│   └── index.php               //框架入口文件
├── readme.md
├── resources              
│   ├── lang                     //多语言存放目录
│   │   ├── en
│   │   │   └── messages.php
│   │   └── zh-CN
│   │       └── messages.php
│   └── views
├── routes                      //路由存放目录
│   ├── admin.php
│   ├── api.php
│   └── web.php
├── storage                     //日志、缓存存放目录
│   ├── app
│   ├── framework
│   │   ├── cache
│   │   └── views
│   └── logs
│       ├── TMS-2019-01-10.log
│       ├── TMS-2019-01-11.log
│       ├── TMS-2019-01-14.log
│       └── TMS-2019-01-27.log
├── tests                   //测试用例存放目录，可按分层进行用例的开发
│   ├── Controllers
│   │   ├── AdvertiseTest.php
│   │   └── MerchantTest.php
│   ├── ExampleTest.php
│   ├── Models
│   │   ├── MerchantBussinessConfigTest.php
│   │   └── MerchantConfigTest.php
│   ├── Services
│   │   ├── AdvertiseTest.php
│   │   └── MerchantTest.php
│   └── TestCase.php
└── vendor              //第三方类库存放目录
└── .env.example        //框架配置示例文件

• 常用第三方类库
  
  • Redis缓存:
    
    • predis/predis:1.1
    • illuminate/redis:5.6
  • CURL请求
    
    • guzzlehttp/guzzle:6.3
  • RabbitMQ
    
    • bschmitt/laravel-amqp:2.0
  • Elasticsearch
    
    • cviebrock/laravel-elasticsearch:3.4

• 自定义类

  • 监控
    
    • e-monitor
  • 日志
    
    • e-log
  • 文件上传
  • 文件导出
  • 文件上传AWS S3

• lumen框架高级功能

  • HTTP Middleware
    
    • API接口公共验证，包括:API KEY、公共参数合法性、接口调用频率等
    • 多语言环境设置
  • 事件机制
    
    • 解耦代码流程过长的问题，比如: 注册完成之后发送邮件、发奖等业务逻辑。

• 待处理

  • 前端API接口验证机制
  • 后台API接口验证机制
  • 对外API接口验证机制
  • 猫头鹰对接流程
  • 定时任务接入e-job