MyBatis-Plus 代码生成器

🧱 MyBatis-Plus 代码生成器#

在 Java 后端开发中，当我们面对一个数据库表时，通常需要手动编写一系列基础代码文件，如：

实体类（Entity）
数据访问层接口（Mapper）
Mapper XML 文件
服务层接口与实现（Service / ServiceImpl）
控制器类（Controller）

这些重复性工作不仅枯燥，还容易出错。幸运的是，MyBatis-Plus 提供了一个强大的代码生成器，可以帮助我们自动生成这些基础代码，大幅提升开发效率！

1. 引入依赖#

1
<dependency>
2
    <groupId>com.baomidou</groupId>
3
    <artifactId>mybatis-plus-generator</artifactId>
4
    <version>3.5.1</version>
5
</dependency>
6

7
<dependency>
8
    <groupId>org.apache.velocity</groupId>
9
    <artifactId>velocity-engine-core</artifactId>
10
    <version>2.3</version>
11
</dependency>

2. 编写生成器代码#

下面给出官方的代码生成器示例，请根据实际情况自行修改配置。

全新的代码生成器添加于 3.5.1 版本，且对历史版本不兼容！如果您用的是 3.5.1 以下的版本，请参考代码生成器进行配置与使用。

1
FastAutoGenerator.create("url", "username", "password")
2
        .globalConfig(builder -> builder
3
                .author("Baomidou")
4
                .outputDir(Paths.get(System.getProperty("user.dir")) + "/src/main/java")
5
                .commentDate("yyyy-MM-dd")
6
        )
7
        .packageConfig(builder -> builder
8
                .parent("com.baomidou.mybatisplus")
9
                .entity("entity")
10
                .mapper("mapper")
11
                .service("service")
12
                .serviceImpl("service.impl")
13
                .xml("mapper.xml")
14
        )
15
        .strategyConfig(builder -> builder
16
                .entityBuilder()
17
                .enableLombok()
18
        )
19
        .templateEngine(new VelocityTemplateEngine())
20
        .execute();

NOTE
为了生成更加符合需求的代码，官方提供了一系列完整的配置说明，可参考代码生成器配置 | MyBatis-Plus

3. 运行并查看生成的代码#

我在数据库中预先创建了一张表item，运行上面这段代码后，自动生成的文件结构如下所示：

自定义模板#

1. 创建自定义模板目录#

在项目的 src/main/resources 下创建 templates 目录：

1
src/main/resources
2
└── templates
3
    ├── entity.java.vm       # 实体类模板
4
    ├── controller.java.vm   # Controller模板
5
    └── mapper.xml.vm        # Mapper XML模板

2. 修改模板内容#

以自定义实体类模板 (entity.java.vm) 为例：

1
## 实体类模板示例（添加Swagger和自定义注释）
2
package ${package.Entity};
3

4
import com.baomidou.mybatisplus.annotation.TableName;
5
import io.swagger.annotations.ApiModel;
6
import io.swagger.annotations.ApiModelProperty;
7
import lombok.Data;
8
import lombok.EqualsAndHashCode;
9

10
/**
11
 * 实体类 - ${table.comment}
12
 * @author ${author}
13
 * @date ${date}
14
 */
15
@Data
16
@EqualsAndHashCode(callSuper = true)
17
@TableName("${table.name}")
18
@ApiModel("${table.comment}实体")
19
public class ${entity} extends ${superEntityClass} {
20
    private static final long serialVersionUID = 1L;
21

22
## ---------- 字段循环生成 ----------
23
#foreach($field in ${table.fields})
24
    #if(${field.comment})
25
    @ApiModelProperty("${field.comment}")
26
    #end
27
    #if(${field.keyFlag})
28
    @TableId(value = "${field.name}", type = IdType.${field.keyIdentityFlag})
29
    #else
30
    @TableField("${field.name}")
31
    #end
32
    private ${field.propertyType} ${field.propertyName};
33
#end
34
}

3. 配置生成器使用自定义模板#

在代码生成器中指定模板路径（默认自动识别，无需额外配置）：

1
TemplateConfig templateConfig = new TemplateConfig.Builder()
2
    .entity("/templates/entity.java.vm")  // 指定实体类模板路径
3
    .controller("/templates/controller.java.vm")
4
    .build();

4. 自定义模板的关键变量#

模板中可使用的预定义变量（以 entity.java.vm 为例）：

变量名	说明
`package.Entity`	实体类的包名
`author`	全局配置中设置的作者
`date`	当前日期（如 `2024-01-01`）
`table.comment`	数据库表注释
`entity`	实体类名（如 `User`）
`superEntityClass`	实体类父类（如 `BaseEntity`）
`table.fields`	表的字段集合
`field.propertyName`	字段对应的属性名（如 `userName`）
`field.propertyType`	字段对应的Java类型（如 `String`）
`field.comment`	字段注释

MyBatis-Plus 代码生成器

🧱 MyBatis-Plus 代码生成器#

1. 引入依赖#

2. 编写生成器代码#

3. 运行并查看生成的代码#

自定义模板#

1. 创建自定义模板目录#

2. 修改模板内容#

3. 配置生成器使用自定义模板#

4. 自定义模板的关键变量#

相关推荐