搭建单体SpringBoot项目 集成MybatisPlus代码生成

技术►搭建单体SpringBoot项目 , , , , 评论

官方 说明文档

引入maven

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
<!-- mybatis plus -->
<dependency>
  <groupId>com.baomidou</groupId>
  <artifactId>mybatis-plus-boot-starter</artifactId>
</dependency>
<!-- mybatis plus generator -->
<dependency>
  <groupId>com.baomidou</groupId>
  <artifactId>mybatis-plus-generator</artifactId>
</dependency>
<!-- freemarker -->
<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-freemarker</artifactId>
</dependency>

示例

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
import com.baomidou.mybatisplus.annotation.FieldFill;
import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.generator.FastAutoGenerator;
import com.baomidou.mybatisplus.generator.config.DataSourceConfig;
import com.baomidou.mybatisplus.generator.config.OutputFile;
import com.baomidou.mybatisplus.generator.config.converts.MySqlTypeConvert;
import com.baomidou.mybatisplus.generator.config.querys.MySqlQuery;
import com.baomidou.mybatisplus.generator.config.rules.DateType;
import com.baomidou.mybatisplus.generator.engine.FreemarkerTemplateEngine;
import com.baomidou.mybatisplus.generator.fill.Column;
import com.baomidou.mybatisplus.generator.fill.Property;
import com.baomidou.mybatisplus.generator.keywords.MySqlKeyWordsHandler;
import com.panda.common.base.*;

import java.util.Collections;

/**
 * mybatis plus 代码生成<br/>
 * 详细配置请前往 https://baomidou.com/pages/981406/
 * @author guoshunfa
 */
public class CodeGenerate {

    // 数据库url地址
    public static final String URL = "jdbc:mysql://127.0.0.1:3306/attacking-panda-db?useUnicode=true&characterEncoding=utf-8&useSSL=false";
    // 数据库用户名
    public static final String USERNAME = "root";
    // 数据库密码
    public static final String PASSWORD = "guoshunfa";
    // 代码开发作者
    public static final String AUTHOR = "guoshunfa";
    // 代码生成到指定目录
    public static final String OUTPUT_DIR = "/Users/guoshunfa/workspace/my/my-main-git-project/attacking-panda/attacking-panda-java/codeGenerate";
    // 父包名
    public static final String PARENT = "com.panda.admin";
    // 父包模块
    public static final String MODULE_NAME = "system";
    // 需要生成的表
    public static final String[] ADD_INCLUDE = {"sys_user", "sys_dept"};
    // 设置过滤表前缀，例子："t_", "c_"
    public static final String[] ADD_TABLE_PREFIX = {};

    public static void main(String[] args) {
        FastAutoGenerator.create(
                new DataSourceConfig.Builder(URL, USERNAME, PASSWORD)
                        .dbQuery(new MySqlQuery()) // 数据库查询
                        .schema("") // 数据库 schema(部分数据库适用)
//                        .typeConvert(new MySqlTypeConvert()) // 数据库类型转换器
                        .keyWordsHandler(new MySqlKeyWordsHandler()) // 数据库关键字处理器
                ) // 数据库配置
                // ----------------------------------全局配置----------------------------------
                .globalConfig(builder -> {
                    builder.fileOverride() // 覆盖已生成文件，默认值:false
//                            .disableOpenDir() // 禁止打开输出目录，默认值:true
                            .outputDir(OUTPUT_DIR) // 指定输出目录
                            .author(AUTHOR) // 作者名
//                            .enableKotlin() // 开启 kotlin 模式，默认值:false
                            .enableSwagger() // 开启 swagger 模式，默认值:false
                            .dateType(DateType.TIME_PACK) // 时间策略
                            .commentDate("yyyy-MM-dd"); // 注释日期
                })
                // ----------------------------------包配置----------------------------------
                .packageConfig(builder -> {
                    builder.parent(PARENT) // 父包名 默认值:com.baomidou
                            .moduleName(MODULE_NAME) // 父包模块名 默认值:无
                            .entity("entity") // Entity 包名	默认值:entity
                            .service("service") // 	Service 包名	默认值:service
                            .serviceImpl("service.impl") // Service Impl 包名	默认值:service.impl
                            .mapper("mapper") // Mapper 包名	默认值:mapper
                            .xml("mapper.xml") // Mapper XML 包名	默认值:mapper.xml
                            .controller("controller") // Controller 包名	默认值:controller
                            .other("other") // 自定义文件包名	输出自定义文件时所用到的包名
                            .pathInfo(Collections.singletonMap(OutputFile.mapperXml, OUTPUT_DIR)) // 路径配置信息
                            .build();
                })
                // ----------------------------------模板配置----------------------------------
//                .templateConfig(builder -> {})
                // ----------------------------------注入配置----------------------------------
                .injectionConfig(builder -> {
                    builder.beforeOutputFile(((tableInfo, objectMap) -> {
                                System.out.println("tableInfo: " + tableInfo.getEntityName() + " objectMap: " + objectMap.size());
                            })) // 输出文件之前消费者
//                            .customMap(Collections.singletonMap("test", "baomidou")) // 自定义配置 Map 对象
//                            .customFile(Collections.singletonMap("test.txt", "/templates/test.vm")) // 自定义配置模板文件
                            .build();
                })
                // ----------------------------------策略配置----------------------------------
                .strategyConfig(builder -> {
                    builder.enableCapitalMode() // 开启大写命名	默认值:false
                            .enableSkipView() // 开启跳过视图	默认值:false
                            .disableSqlFilter() // 禁用 sql 过滤	默认值:true，语法不能支持使用 sql 过滤表的话，可以考虑关闭此开关
                            .enableSchema() // 启用 schema	默认值:false，多 schema 场景的时候打开
//                            .likeTable(new LikeTable("USER")) // 模糊表匹配(sql 过滤)	likeTable 与 notLikeTable 只能配置一项
//                            .notLikeTable(new LikeTable("USER")) // 模糊表排除(sql 过滤)	likeTable 与 notLikeTable 只能配置一项
                            .addInclude(ADD_INCLUDE) // 增加表匹配(内存过滤)	include 与 exclude 只能配置一项
//                            .addExclude("a_abc") // 增加表排除匹配(内存过滤)	include 与 exclude 只能配置一项
                            .addTablePrefix(ADD_TABLE_PREFIX) // 增加过滤表前缀
//                            .addTableSuffix("abc") // 增加过滤表后缀
//                            .addFieldPrefix("sys_") // 增加过滤字段前缀
//                            .addFieldSuffix("_flag") // 增加过滤字段后缀
                            // ----------------------------------Entity 策略配置----------------------------------
                            .entityBuilder().superClass(BaseEntity.class) // 设置父类
//                            .disableSerialVersionUID() // 禁用生成 serialVersionUID 默认值:true
//                            .enableColumnConstant() // 开启生成字段常量	默认值:false
                            .enableChainModel() // 开启链式模型	默认值:false
//                            .enableLombok() // 开启 lombok 模型	默认值:false
                            .enableRemoveIsPrefix() // 开启 Boolean 类型字段移除 is 前缀	默认值:false
                            .enableTableFieldAnnotation() // 开启生成实体时生成字段注解	默认值:false
                            .enableActiveRecord() // 开启 ActiveRecord 模型	默认值:false
                            .versionColumnName("version") // 乐观锁字段名(数据库)
                            .versionPropertyName("version") // 乐观锁属性名(实体)
                            .logicDeleteColumnName("delete_flag") // 逻辑删除字段名(数据库)
                            .logicDeletePropertyName("deleteFlag") // 逻辑删除属性名(实体)
//                            .naming(NamingStrategy.no_change) // 数据库表映射到实体的命名策略	默认下划线转驼峰命名:NamingStrategy.underline_to_camel
//                            .columnNaming(NamingStrategy.underline_to_camel) // 数据库表字段映射到实体的命名策略	默认为 null，未指定按照 naming 执行
                            .addSuperEntityColumns("id", "delete_flag", "version", "created_by", "created_time", "updated_by", "updated_time") // 添加父类公共字段
//                            .addIgnoreColumns("age") // 添加忽略字段
                            .addTableFills(new Column("create_time", FieldFill.INSERT)) // 添加表字段填充
                            .addTableFills(new Property("updateTime", FieldFill.INSERT_UPDATE)) // 添加表字段填充
                            .idType(IdType.ASSIGN_UUID) // 全局主键类型
//                            .formatFileName("%sEntity") // 格式化文件名称
                            .build()
                            // ----------------------------------Controller 策略配置----------------------------------
                            .controllerBuilder()
                            .superClass(BaseController.class) // 设置父类
                            .enableHyphenStyle() // 开启驼峰转连字符
                            .enableRestStyle() // 开启生成@RestController 控制器
//                            .convertFileName() // 转换文件名称
                            .formatFileName("%sController") // 格式化文件名称
                            .build()
                            // ----------------------------------Service 策略配置----------------------------------
                            .serviceBuilder()
                            .superServiceClass(BaseService.class) // 设置 service 接口父类
                            .superServiceImplClass(BaseServiceImpl.class) // 设置 service 实现类父类
//                            .convertServiceFileName() // 转换 service 接口文件名称
//                            .convertServiceImplFileName() // 转换 service 实现类文件名称
                            .formatServiceFileName("I%sService") // 格式化 service 接口文件名称
                            .formatServiceImplFileName("%sServiceImpl") // 格式化 service 实现类文件名称
                            .build()
                            // ----------------------------------Mapper 策略配置----------------------------------
                            .mapperBuilder()
                            .superClass(BaseMapper.class) // 设置父类
                            .enableMapperAnnotation() // 开启 @Mapper 注解 默认值:false
                            .enableBaseResultMap() // 启用 BaseResultMap 生成
                            .enableBaseColumnList() // 启用 BaseColumnList
//                            .cache(MyMapperCache.class) // 设置缓存实现类
//                            .convertMapperFileName(ConverterFileName) // 转换 mapper 类文件名称
//                            .convertXmlFileName(ConverterFileName) // 转换 xml 文件名称
                            .formatMapperFileName("%sMapper") // 格式化 mapper 文件名称
                            .formatXmlFileName("%sXml") // 格式化 xml 实现类文件名称
                            .build();
                })
                // ----------------------------------自定义模版支持(DTO\VO等)配置----------------------------------
                .templateEngine(new FreemarkerTemplateEngine()) // 使用Freemarker引擎模板，默认的是Velocity引擎模板
                .execute();
    }

}

基础类

最简单的基础类，当然也可以不使用自己的基础类，直接使用MybatisPlus默认的基础类，只需要把配置父类的代码删掉就可以。

但是我建议是使用自己的基础类，这样可以扩展。

BaseController

1
2
3
4
5
6
7
8
9
10
/**
 * 基础控制器
 *
 * @className: BaseController
 * @author: GuoShunFa
 * @date: 2022/11/10
 **/
public class BaseController {
}

BaseEntity

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
import com.baomidou.mybatisplus.annotation.FieldFill;
import com.baomidou.mybatisplus.annotation.TableField;
import com.baomidou.mybatisplus.annotation.TableId;
import com.baomidou.mybatisplus.extension.activerecord.Model;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;

import java.io.Serializable;
import java.util.Date;

/**
 * 基础实体类
 *
 * @className: BaseEntity
 * @author: GuoShunFa
 * @date: 2022/11/10
 **/
@ApiModel("基础类")
public class BaseEntity<T> extends Model implements Serializable {

    @ApiModelProperty("主键id字段")
    @TableField("id")
    @TableId
    private String id;

    @ApiModelProperty("乐观锁字段")
    @TableField("version")
    private String version;

    @ApiModelProperty("逻辑删除字段")
    @TableField("delete_flag")
    private String deleteFlag;

    @ApiModelProperty("记录创建时间")
    @TableField(value = "create_time", fill = FieldFill.INSERT)
    private Date createTime;

    @ApiModelProperty("记录创建人")
    @TableField("create_by")
    private String createBy;

    @ApiModelProperty("记录修改时间")
    @TableField(value = "update_time", fill = FieldFill.INSERT_UPDATE)
    private Date updateTime;

    @ApiModelProperty("记录创建人")
    @TableField("update_by")
    private String updateBy;

    public String getCreateBy() {
        return createBy;
    }

    public void setCreateBy(String createBy) {
        this.createBy = createBy;
    }

    public String getUpdateBy() {
        return updateBy;
    }

    public void setUpdateBy(String updateBy) {
        this.updateBy = updateBy;
    }

    public Date getCreateTime() {
        return createTime;
    }

    public void setCreateTime(Date createTime) {
        this.createTime = createTime;
    }

    public Date getUpdateTime() {
        return updateTime;
    }

    public void setUpdateTime(Date updateTime) {
        this.updateTime = updateTime;
    }

    public String getId() {
        return id;
    }

    public void setId(String id) {
        this.id = id;
    }

    public String getVersion() {
        return version;
    }

    public void setVersion(String version) {
        this.version = version;
    }

    public String getDeleteFlag() {
        return deleteFlag;
    }

    public void setDeleteFlag(String deleteFlag) {
        this.deleteFlag = deleteFlag;
    }

}

BaseMapper

1
2
3
4
5
6
7
8
9
/**
 * 基础映射类
 *
 * @className: BaseMapper
 * @author: GuoShunFa
 * @date: 2022/11/10
 **/
public interface BaseMapper<T> extends com.baomidou.mybatisplus.core.mapper.BaseMapper<T> {
}

BaseService

1
2
3
4
5
6
7
8
9
10
11
import com.baomidou.mybatisplus.extension.service.IService;

/**
 * 基础服务接口
 *
 * @className: BaseService
 * @author: GuoShunFa
 * @date: 2022/11/10
 **/
public interface BaseService<T> extends IService {
}

BaseServiceImpl

1
2
3
4
5
6
7
8
9
import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;

/**
 * @className: BaseServiceImpl
 * @author: GuoShunFa
 * @date: 2022/11/10
 **/
public class BaseServiceImpl<M, T> extends ServiceImpl implements BaseService<T> {
}

郭顺发JAVA开发攻城狮

专注于服务端场景的解决方案。