Aube 一词源自法语, 意为黎明、初期。

Aube-Boot 项目是一个基于Spring Boot框架的脚手架。

和他的名字一样, 该项目并不会集成大而全的功能, 而是希望提供一个初期的启动代码和编码约定。

从Github获取最新代码

git clone https://github.com/zzzzbw/aube-boot.git

• JDK 1.8+

• Spring Boot 2.3.2.RELEASE

• mybatis-plus 3.3.2

• springfox 3.0.0

• hutool 5.3.10

• 封装集成mybatis-plus
• 封装集成swagger, 枚举类文档信息增强
• 全局统一响应数据自动包装
• 全局统一异常返回处理
• SpringMVC泛型对象自动封装
• 接口方法打印日志功能
• 通用Entity, DTO实体基类
• CRUD Controller功能, 快速自由生成增删改查接口
• 缓存工具类

├── aube-bootstrap -> 项目工程, 业务代码编写
├── aube-common -> 基类模块, 存放一些公共的基类
├── aube-starter -> 三方项目starter, 当引入三方的项目时, 通常需要根据自身业务再度进行配置, 在这个项目配置后, 再在bootstrap项目引入starter工程. 
    ├── aube-mybatis-plus-starter -> mybatis-plus参数配置工程
    ├── aube-swagger-starter -> swagger参数配置工程
    ├── aube-web-starter -> 配置项目的一些web设置, 如全局统一异常返回, 参数日志打印等

为什么这么分层？为什么把common和starter当作工程分出来, 直接在bootstrap下写一个common和config文件夹不就好了？

首先, 这样可以完全的把需求代码, 和公共基础代码分离. 并且不仅是代码层面的分离, 同时也是责任上的分离, 如aube-common和aube-starter工程只能由Leader才能修改.

其次, 如果把基础公共代码和需求代码写在一个工程下, 一旦公司需要新建一个项目, 那么还要把这个部分项目复制粘贴到新的项目. 一旦需要修改, 就要改动所有项目的公共代码. 现在分离成工程, 可以用maven的deploy方法将公共工程推到远程(或内网)仓库, 每个项目再通过maven引入这些依赖即可.

maven引入，如果引入第三方, 比如统一在父工程声明版本, 再在子工程使用, 如无特殊原因子工程不允许自行声明版本, 避免各个工程引用同一个库的不同版本. 如:

<properties>
    <mybatis-plus.version>3.3.2</mybatis-plus.version>
    <hutool.version>5.3.10</hutool.version>
    <springfox.version>3.0.0</springfox.version>
    ...
</properties>

<dependencyManagement>
    <dependencies>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-boot-starter</artifactId>
            <version>${springfox.version}</version>
        </dependency>
        <dependency>
            <groupId>cn.hutool</groupId>
            <artifactId>hutool-all</artifactId>
            <version>${hutool.version}</version>
        </dependency>
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>${mybatis-plus.version}</version>
        </dependency>
        ...
    </dependencies>
</dependencyManagement>

MyBatis-Plus （简称 MP）是一个 MyBatis 的增强工具，在 MyBatis 的基础上只做增强不做改变，为简化开发、提高效率而生。

在工程aube-starter#aube-mybatis-plus-starter中引入了MyBatis-Plus, 目前已经配置了分页插件、Entity字段自动填充功能。 如果需要其他配置可以参考其官方文档, 然后在工程中增加对应的配置。

我们的项目只需要在maven中添加:

<dependency>
    <groupId>com.github.zzzzbw</groupId>
    <artifactId>aube-mybatis-plus-starter</artifactId>
    <version>${version}</version>
</dependency>

就能引入统一的MyBatis-Plus插件及其配置。

Swagger在时隔几年之后终于从2升级到3了, 这里我们也直接引入了最新的Swagger.

相比于Swagger2, 最直观的感受就是文档标准切换到了Open API, 并且跟进了Spring Boot的自动装配特性, 有了对应的starter.

1. Aube中进一步封装了Swagger的配置, 可以统一通过配置文件修改Swagger文档基本信息, 如:

# application.yml
aube:
  swagger:
    enabled: true # 是否开启swagger
    base-package: com.github.zzzzbw.aube.controller # api扫描的包
    title: @artifactId@ # swagger的标题
    description: @description@ # swagger的描述
    version: @version@ # swagger的版本

2. 增强了枚举类文档信息

提供了SwaggerEnum接口, 只要枚举实现接口的getDesc()方法(通常是在枚举中声明String类型的desc字段, 然后生成getter方法), 如:

@AllArgsConstructor
@Getter
public enum UserTypeEnum implements SwaggerEnum {
    NORMAL("普通用户"),
    ADMIN("管理员用户");

    private final String desc;
}

Swagger文档中就会自动生成枚举类对应的值和备注: 用户类型 NORMAL: 普通用户; ADMIN: 管理员用户;

3. 自定义全局异常拦截, 自定义全局返回拦截, 日志拦截器, AOP日志与Interceptor日志

• Response、BaseException介绍、何时返回Response何时抛出BaseException

• 枚举处理

• 时间处理