一款功能丰富交互式的 Dubbo 脚手架

ゝ一纸荒年。 2021-10-01 11:40 231阅读 0赞

# DeepEXI Dubbo Scaffold Generator #

此脚手架生成器基于[Yeoman][]构建。

[CHANGELOG][]

## How To ##

### Getting Started ###

#### 1. 安装yeoman ####

$ npm install -g yo

#### 2. 安装generator-deepexi-dubbo ####

$ npm install -g generator-deepexi-dubbo

#### 3. 创建你的应用 ####

通过交互模式创建

$ mdir {your_project_name}
    $ cd {your_project_name}
    $ yo deepexi-dubbo

或者使用命令行模式创建

$ mdir {your_project_name}
    $ cd {your_project_name}
    $ yo deepexi-dubbo -c

更多帮助信息可以通过以下命令查看

$ yo deepexi-dubbo --help

## 功能一览 ##

### 可选项 ###

<table> 
 <thead> 
  <tr> 
   <th style="text-align:center"><strong>类型</strong></th> 
   <th></th> 
   <th></th> 
   <th></th> 
   <th></th> 
   <th></th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td style="text-align:center">配置中心</td> 
   <td>✅️Apollo</td> 
   <td>☑️Disconfig</td> 
   <td>✅️Spring-Cloud-Config</td> 
   <td></td> 
   <td></td> 
  </tr> 
  <tr> 
   <td style="text-align:center">消息队列</td> 
   <td>✅RabbitMQ</td> 
   <td>☑️RocketMQ</td> 
   <td>Kafka</td> 
   <td></td> 
   <td></td> 
  </tr> 
  <tr> 
   <td style="text-align:center">注册中心</td> 
   <td>✅zookeeper</td> 
   <td>✅nacos</td> 
   <td></td> 
   <td></td> 
   <td></td> 
  </tr> 
  <tr> 
   <td style="text-align:center">任务调度</td> 
   <td>☑️ES Job</td> 
   <td>☑️XXL-Job</td> 
   <td>☑️SiaTask</td> 
   <td>☑️Quartz</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td style="text-align:center">RDBMS</td> 
   <td>✅MySQL</td> 
   <td>☑️PG SQL</td> 
   <td>☑️SQL Server</td> 
   <td></td> 
   <td></td> 
  </tr> 
  <tr> 
   <td style="text-align:center">NoSQL</td> 
   <td>✅️Redis</td> 
   <td>☑️MongoDB</td> 
   <td></td> 
   <td></td> 
   <td></td> 
  </tr> 
  <tr> 
   <td style="text-align:center">连接池</td> 
   <td>✅Druid</td> 
   <td></td> 
   <td></td> 
   <td></td> 
   <td></td> 
  </tr> 
  <tr> 
   <td style="text-align:center">权限控制</td> 
   <td>☑️Shiro</td> 
   <td>☑️Spring Security</td> 
   <td></td> 
   <td></td> 
   <td></td> 
  </tr> 
  <tr> 
   <td style="text-align:center">分布式事务</td> 
   <td>☑️Seata</td> 
   <td></td> 
   <td></td> 
   <td></td> 
   <td></td> 
  </tr> 
  <tr> 
   <td style="text-align:center">APM</td> 
   <td>☑️SkyWalking</td> 
   <td>☑️Zipkin</td> 
   <td>☑️PinPoint</td> 
   <td></td> 
   <td></td> 
  </tr> 
  <tr> 
   <td style="text-align:center">分库分表</td> 
   <td>☑️Sharding-JDBC</td> 
   <td>☑️MyCAT</td> 
   <td></td> 
   <td></td> 
   <td></td> 
  </tr> 
  <tr> 
   <td style="text-align:center">服务器</td> 
   <td>✅Tomcat</td> 
   <td>☑️Jetty</td> 
   <td>✅Undertow</td> 
   <td></td> 
   <td></td> 
  </tr> 
  <tr> 
   <td style="text-align:center">JSON解析</td> 
   <td>✅Jackson</td> 
   <td>☑️FastJson</td> 
   <td>☑️Gson</td> 
   <td></td> 
   <td></td> 
  </tr> 
  <tr> 
   <td style="text-align:center">模板引擎</td> 
   <td>✅Thymeleaf</td> 
   <td>☑️Freemarker</td> 
   <td></td> 
   <td></td> 
   <td></td> 
  </tr> 
  <tr> 
   <td style="text-align:center">对象存储</td> 
   <td>☑️AliOSS</td> 
   <td>☑️FastDFS</td> 
   <td>☑️TencentOSS</td> 
   <td>☑️QiNiuOSS</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td style="text-align:center">ORM</td> 
   <td>✅MybatisPlus</td> 
   <td>☑️JPA</td> 
   <td></td> 
   <td></td> 
   <td></td> 
  </tr> 
  <tr> 
   <td style="text-align:center">日志系统</td> 
   <td>✅Logback</td> 
   <td>☑️Log4j2</td> 
   <td></td> 
   <td></td> 
   <td></td> 
  </tr> 
  <tr> 
   <td style="text-align:center">Bean转换器</td> 
   <td>✅SpringMVC Converter</td> 
   <td>✅MapStruct</td> 
   <td></td> 
   <td></td> 
   <td></td> 
  </tr> 
  <tr> 
   <td style="text-align:center">MVC</td> 
   <td>✅SpringMVC</td> 
   <td></td> 
   <td></td> 
   <td></td> 
   <td></td> 
  </tr> 
  <tr> 
   <td style="text-align:center">WebSocket</td> 
   <td>☑️Spring Boot Websocket</td> 
  </tr> 
  <tr> 
   <td style="text-align:center">DeepEXI产品</td> 
   <td>☑️sPaaS</td> 
   <td></td> 
   <td></td> 
   <td></td> 
   <td></td> 
  </tr> 
 </tbody> 
</table>

### 固有项 ###

<table> 
 <thead> 
  <tr> 
   <th style="text-align:center"><strong>类型</strong></th> 
   <th></th> 
   <th></th> 
   <th></th> 
   <th></th> 
   <th></th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td style="text-align:center">Java版本</td> 
   <td>✅JDK1.8</td> 
   <td></td> 
   <td></td> 
   <td></td> 
   <td></td> 
  </tr> 
  <tr> 
   <td style="text-align:center">开发框架</td> 
   <td>✅springfox(swagger)</td> 
   <td>✅lombok</td> 
   <td>✅guava</td> 
   <td>✅common-lang3</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td style="text-align:center">测试框架</td> 
   <td>✅junit</td> 
   <td>✅️jfairy</td> 
   <td>✅mockito</td> 
   <td>✅️jacoco</td> 
   <td>✅hamcrest</td> 
   <td>☑️mockneat</td> 
   <td>☑️mockserver</td> 
  </tr> 
  <tr> 
   <td style="text-align:center">部署相关</td> 
   <td>✅docker</td> 
   <td>✅filebeat</td> 
   <td></td> 
   <td></td> 
   <td></td> 
  </tr> 
  <tr> 
   <td style="text-align:center">开发相关</td> 
   <td>✅devtools</td> 
   <td></td> 
   <td></td> 
   <td></td> 
   <td></td> 
  </tr> 
  <tr> 
   <td style="text-align:center">其它</td> 
   <td>✅️actuator</td> 
   <td>✅configuration-processor</td> 
   <td></td> 
   <td></td> 
   <td></td> 
  </tr> 
 </tbody> 
</table>

## Development Reference ##

### 设计参考 ###

**[《阿里巴巴Java开发手册》][Java]**

**《DDD领域驱动设计》**

### 工程结构 ###

![9434708-c5f24885e50afbf1][]

各层间领域对象传输规范

.
    ├── 1.docs  // 与项目相关的文档
    │   ├── guides  // 指导文档
    │   │   ├── dev_reference.md
    │   │   ├── quickly_start.md
    │   │   └── reference.md
    │   └── sql     // 数据库sql脚本
    │       └── v1.0.0
    ├── deepexi-dubbo-api
    │   ├── pom.xml
    │   └── src
    │       └── main
    │           └── java
    │               └── com
    │                   └── deepexi
    │                       └── api                 // RPC-API层对外暴露的声明式接口，以 XXXApi 结尾
    │                           └── model           // API层方法入参与出参模型
    │                               └── dto         // 数据传输对象，供其它服务 RPC 调用
    │                               └── vo          // 显示层对象，供其它服务  HTTP  调用
    │                               └── query       // 数据查询对象
    ├── deepexi-dubbo-provider
    │   ├── pom.xml
    │   └── src
    │       └── main
    │           ├── java
    │           │   └── com
    │           │       └── deepexi
    │           │           ├── api         // RPC-API层对外暴露的声明式接口实现，以 XXXApiImpl 结尾
    │           │           │   └── impl    
    │           │           ├── aop         // 切面
    │           │           ├── config      // 应用相关配置
    │           │           │   └── web
    │           │           ├── constant    // 常量定义
    │           │           ├── controller  // 请求处理web层
    │           │           ├── converter   // bean转换器
    │           │           ├── model       // 业务各层方法入参与出参模型
    │           │           │   ├── dto     // 数据传输对象（data transfer object）
    │           │           │   ├── entity  // 数据源对象（do）
    │           │           │   ├── query   // 查询对象
    │           │           │   └── vo      // 视图对象（view object）
    │           │           ├── domain      // 领域逻辑层
    │           │           │   ├── entity  // 领域实体
    │           │           │   └── manager // 领域实体管理
    │           │           ├── enums       // 枚举类
    │           │           ├── exception   // 异常类
    │           │           ├── extension   // 扩展，如自定义注解
    │           │           ├── mapper      // DAO 层
    │           │           ├── remote      // 远程服务调用
    │           │           ├── repo        // 仓储层（repository）
    │           │           ├── service     // 业务逻辑层
    │           │           │   └── impl
    │           │           ├── util        // 工具类
    │           │           └── StartupApplication.java     // 应用启动入口
    │           └── resources
    │               ├── META-INF
    │               │   └── spring-devtools.properties      // devtools元数据
    │               ├── application.yml             // 通用配置文件
    │               ├── application-dev.yml         // 开发环境配置文件
    │               ├── application-local.yml       // 本地环境配置文件
    │               ├── application-prod.yml        // 生产环境配置文件
    │               ├── application-qa.yml          // 测试环境配置文件
    │               ├── bootstrap.yml
    │               └── mapper           // mybatis mapper相关
    │               └── db               // 数据库 SQL 增量文件
    ├── .gitignore
    ├── build.sh        // 项目构建脚本
    ├── commitlint.config.js
    ├── common.sh
    ├── Dockerfile
    ├── entrypoint.sh
    ├── filebeat.yml
    ├── package.json
    └── pom.xml
    ├── README.md       // 帮助文档
    ├── run.sh          // 运行脚本
    ├── scaffold.md     // 脚手架信息
    ├── start-code.sh   // 项目启动脚本
    ├── start-fb.sh     // filebeat启动脚本
    ├── LICENSE         // 协议信息

### 学习文档 ###

*  **Dubbo**：Dubbo 是一款高性能、轻量级的开源 Java RPC 框架，你可以点击 → [Dubbo 官方文档][Dubbo] 了解学习它。
 *  **Mybatis-Plus**：MyBatis-Plus 是一个 MyBatis 的增强工具，简化开发、提高了效率，你可以点击 → [Mybatis-Plus 官方参考手册][Mybatis-Plus] 了解学习它。
 *  **参数校验**：通常我们需要对请求传递的参数进行校验，你可以通过这篇文章学习它 → [参数校验][Link 1]。
 *  **Lombok**：Lombok 提供了一些注解来帮助我们简化消除一些必须有但显得臃肿的 java 代码，你可以通过这篇文章学习它 → [Lombok ][Lombok]。
 *  **单元测试**：SpringBoot 单元测试与 Mockito 的使用可阅读改篇文章 → [点击这里][Link 2]。

> ... 持续更新 -> [聪明的杰瑞博客][Link 3]

### DDD 领域设计案例 ###

*  [工程中心][Link 4]

[Yeoman]: https://links.jianshu.com/go?to=https%3A%2F%2Fyeoman.io%2F
[CHANGELOG]: https://links.jianshu.com/go?to=.%2FCHANGELOG.md
[Java]: https://links.jianshu.com/go?to=https%3A%2F%2Fyq.aliyun.com%2Fdownload%2F2719
[9434708-c5f24885e50afbf1]: /images/20210811/fcb7a312655244df98986169a73968f2.png
[Dubbo]: https://links.jianshu.com/go?to=http%3A%2F%2Fdubbo.apache.org%2Fzh-cn%2Fdocs%2Fuser%2Fpreface%2Fbackground.html
[Mybatis-Plus]: https://links.jianshu.com/go?to=https%3A%2F%2Fmp.baomidou.com%2Fguide%2F
[Link 1]: https://links.jianshu.com/go?to=https%3A%2F%2Fjuejin.im%2Fpost%2F5d6b5a5af265da03be48f14a
[Lombok]: https://links.jianshu.com/go?to=https%3A%2F%2Fjuejin.im%2Fpost%2F5d5c182df265da03f66dc353
[Link 2]: https://links.jianshu.com/go?to=https%3A%2F%2Fjuejin.im%2Fpost%2F5d62cc3ee51d45620b21c3e9
[Link 3]: https://links.jianshu.com/go?to=https%3A%2F%2Fjuejin.im%2Fuser%2F5bd1c4886fb9a05cd777874a
[Link 4]: https://links.jianshu.com/go?to=https%3A%2F%2Fgithub.com%2FLinYuanBaoBao%2Fproject-center-demo