本文纲要
- 代码生成器是什么
- 核心工作原理
- 项目准备与环境搭建
- 快速上手:最简代码生成
- 完整配置详解
5.1 数据源配置 (DataSourceConfig)
5.2 全局配置 (GlobalConfig)
5.3 包名配置 (PackageConfig)
5.4 策略配置 (StrategyConfig) - 生成后的代码结构
- 关于自动生成的
Service层 - 完整项目结构树
- 完整
pom.xml文件 - 完整的代码生成器类(可直接运行)
- 配置细节补充
- 总结
代码生成器是什么
在日常开发中,许多代码具有固定的模式和结构,只是实体名称、包路径等部分不同。比如,编写一个 MyBatis-Plus 的 DAO 接口时,我们通常会:
- 定义一个接口继承
BaseMapper<实体类> - 在接口上添加
@Mapper注解 - 导入实体类
对于不同的表(如 user、book),需要修改的地方只有三处:导入的实体类名、接口名、泛型类型。
如果把不变的代码结构看作模板,变化的部分看作参数,那么只要提供模板和参数,就能自动生成代码。
MyBatis-Plus 的代码生成器(AutoGenerator)正是基于这个思想设计的工具,它通过数据库表结构 + 配置参数 + 内置模板,自动生成实体类、Mapper 接口、Service 层、Controller 等全套标准代码,大幅提升开发效率。
核心工作原理
代码生成器的核心机制可以拆解为三个要素:
- 模板:由 MP 内置提供,基于 Velocity 模板引擎。这些模板是经过大量开发者验证的常用代码结构。
- 数据源:生成器通过连接数据库,读取表的字段、类型、注释等信息,填充到模板中。
- 用户配置:包括生成路径、包名、表前缀、是否使用 Lombok、逻辑删除字段等,用于控制生成细节。
将这三者组合,调用 autoGenerator.execute() 即可输出完整的 Java 代码文件。
项目准备与环境搭建
首先创建一个 Spring Boot 项目,并在 pom.xml 中引入代码生成器所需的依赖:
<!-- MyBatis-Plus 代码生成器 -->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-generator</artifactId>
<version>3.4.1</version>
</dependency>
<!-- Velocity 模板引擎(默认) -->
<dependency>
<groupId>org.apache.velocity</groupId>
<artifactId>velocity-engine-core</artifactId>
<version>2.3</version>
</dependency>
完整 pom.xml 还包含 Spring Boot、MyBatis-Plus、MySQL 驱动等基础依赖(参考文末完整代码)。
初始项目结构如下:
mybatisplus_04_generator
├── pom.xml
└── src
└── main
├── java
│ └── com
│ └── wb
│ └── Mybatisplus04GeneratorApplication.java
└── resources
└── application.properties
快速上手:最简代码生成
我们编写一个最简单的生成器,仅配置数据源,其他全部使用默认值,观察默认行为。
package com.wb;
import com.baomidou.mybatisplus.generator.AutoGenerator;
import com.baomidou.mybatisplus.generator.config.DataSourceConfig;
public class Generator {
public static void main(String[] args) {
// 1. 创建代码生成器对象
AutoGenerator autoGenerator = new AutoGenerator();
// 2. 设置数据源(只配数据库连接)
DataSourceConfig dataSource = new DataSourceConfig();
dataSource.setDriverName("com.mysql.cj.jdbc.Driver");
dataSource.setUrl("jdbc:mysql://localhost:3306/mybatisplus_db?serverTimezone=UTC");
dataSource.setUsername("root");
dataSource.setPassword("root");
autoGenerator.setDataSource(dataSource);
// 3. 执行生成
autoGenerator.execute();
}
}
运行后,代码生成器会连接 mybatisplus_db 库,读取所有表,并在系统根目录的 D 盘下生成一套默认包 com.baomidou 的代码。显然,默认输出位置和包结构并不符合我们的项目规范,需要进一步配置。
完整配置详解
一个贴近实际开发的代码生成器需要配置以下四大块:数据源、全局设置、包名、策略。
下面结合完整的 CodeGenerator 类逐块说明。
1 ) 数据源配置 (DataSourceConfig)
设置数据库连接信息,与 JDBC 连接参数一致。
DataSourceConfig dataSource = new DataSourceConfig();
dataSource.setDriverName("com.mysql.cj.jdbc.Driver");
dataSource.setUrl("jdbc:mysql://localhost:3306/mybatisplus_db?serverTimezone=UTC");
dataSource.setUsername("root");
dataSource.setPassword("root");
autoGenerator.setDataSource(dataSource);
| 配置项 | 说明 |
|---|---|
| setDriverName | JDBC 驱动类名 |
| setUrl | 数据库连接 URL |
| setUsername | 数据库用户名 |
| setPassword | 数据库密码 |
2 ) 全局配置 (GlobalConfig)
控制生成文件的整体行为。
GlobalConfig globalConfig = new GlobalConfig();
globalConfig.setOutputDir(System.getProperty("user.dir") + "/mybatisplus04generator/src/main/java"); // 输出目录
globalConfig.setOpen(false); // 生成后是否自动打开目录
globalConfig.setAuthor("黑马程序员"); // 作者名,会出现在类注释中
globalConfig.setFileOverride(true); // 是否覆盖已存在的文件
globalConfig.setMapperName("%sDao"); // Mapper 接口命名规则,%s 代表模块名
globalConfig.setIdType(IdType.ASSIGN_ID); // 主键生成策略
autoGenerator.setGlobalConfig(globalConfig);
| 配置项 | 说明 |
|---|---|
| setOutputDir | 代码生成的绝对路径,通常指向 src/main/java |
| setOpen | 生成完毕后是否打开输出文件夹,开发中一般设为 false |
| setAuthor | 生成类的 @author 注释内容 |
| setFileOverride | 是否覆盖已有文件,注意:开启后再次生成会直接覆盖,自定义代码会丢失 |
| setMapperName | Mapper 接口名称格式,例如 %sDao 会生成 UserDao |
| setIdType | 主键 ID 生成策略,如 ASSIGN_ID(雪花算法)、AUTO 等 |
3 ) 包名配置 (PackageConfig)
设置生成代码的父包及各层子包名。
PackageConfig packageInfo = new PackageConfig();
packageInfo.setParent("com.aaa"); // 父包名
packageInfo.setEntity("domain"); // 实体类子包
packageInfo.setMapper("dao"); // Mapper 接口子包
// 未显式设置的包会使用默认值,如 controller 在 controller 包下
autoGenerator.setPackageInfo(packageInfo);
最终实体类会生成在 com.aaa.domain 下,Mapper 接口在 com.aaa.dao 下。
4 ) 策略配置 (StrategyConfig)
这是最灵活的部分,控制生成哪些表、如何映射表名、是否启用 REST 风格、Lombok、逻辑删除等。
StrategyConfig strategyConfig = new StrategyConfig();
strategyConfig.setInclude("tbl_user"); // 指定参与生成的表,可传多个
strategyConfig.setTablePrefix("tbl_"); // 表名前缀,生成类名时会去掉此前缀
strategyConfig.setRestControllerStyle(true); // 生成 @RestController 控制器
strategyConfig.setVersionFieldName("version"); // 乐观锁字段名
strategyConfig.setLogicDeleteFieldName("deleted"); // 逻辑删除字段名
strategyConfig.setEntityLombokModel(true); // 实体类使用 Lombok
autoGenerator.setStrategy(strategyConfig);
| 配置项 | 说明 |
|---|---|
| setInclude | 指定要生成代码的表名,不设置则生成所有表 |
| setTablePrefix | 表名前缀,如 tbl_,表 tbl_user 生成的类名为 User |
| setRestControllerStyle | 是否生成 REST 风格 Controller(@RestController) |
| setVersionFieldName | 乐观锁字段,生成 @Version 注解 |
| setLogicDeleteFieldName | 逻辑删除字段,生成 @TableLogic 注解 |
| setEntityLombokModel | 实体类是否使用 Lombok 的 @Data 等注解 |
生成后的代码结构
执行 CodeGenerator.main() 后,在 com.aaa 包下会生成如下结构:
com.aaa
├── controller
│ └── UserController.java
├── dao
│ └── UserDao.java
├── domain
│ └── User.java
└── service
├── IUserService.java
└── impl
└── UserServiceImpl.java
各文件核心内容展示:
实体类 (domain/User.java)
package com.aaa.domain;
import com.baomidou.mybatisplus.annotation.*;
import java.io.Serializable;
import lombok.Data;
import lombok.EqualsAndHashCode;
@Data
@EqualsAndHashCode(callSuper = false)
@TableName("tbl_user")
public class User implements Serializable {
private static final long serialVersionUID = 1L;
@TableId(value = "id", type = IdType.ASSIGN_ID)
private Long id;
private String name;
private String pwd;
private Integer age;
private String tel;
@TableLogic
private Integer deleted;
@Version
private Integer version;
}
Mapper 接口 (dao/UserDao.java)
package com.aaa.dao;
import com.aaa.domain.User;
import com.baomidou.mybatisplus.core.mapper.BaseMapper;
public interface UserDao extends BaseMapper<User> {
}
Controller (controller/UserController.java)
package com.aaa.controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
@RequestMapping("/user")
public class UserController {
}
Service 接口 (service/IUserService.java)
package com.aaa.service;
import com.aaa.domain.User;
import com.baomidou.mybatisplus.extension.service.IService;
public interface IUserService extends IService<User> {
}
Service 实现 (service/impl/UserServiceImpl.java)
package com.aaa.service.impl;
import com.aaa.domain.User;
import com.aaa.dao.UserDao;
import com.aaa.service.IUserService;
import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;
import org.springframework.stereotype.Service;
@Service
public class UserServiceImpl extends ServiceImpl<UserDao, User> implements IUserService {
}
关于自动生成的 Service 层
代码生成器自动生成的 Service 继承了 IService<User>,并提供了大量内置方法:
- 增:
save(entity),saveBatch(list) - 删:
removeById(id),remove(queryWrapper) - 改:
updateById(entity),update(entity, wrapper) - 查:
getById(id),list(wrapper),page(page, wrapper)等
这些方法与 Mapper 层的 BaseMapper 方法类似,但位于 Service 层。在简单 CRUD 场景下可以直接使用,无需编写实现类代码。
然而在实际项目中,Service 层通常需要包含业务校验、数据组装等自定义逻辑,自动生成的 Service 可能并不完全适用。因此,开发者可以根据需要保留或删除这些自动生成的 Service 代码,它只是一个辅助工具。
完整项目结构树
├── pom.xml
├── src
│ ├── main
│ │ ├── java
│ │ │ └── com
│ │ │ ├── wb
│ │ │ │ ├── CodeGenerator.java # 完整配置的生成器
│ │ │ │ ├── Generator.java # 最简示例生成器
│ │ │ │ └── Mybatisplus04GeneratorApplication.java # 启动类
│ │ │ └── aaa # 自动生成的代码
│ │ │ ├── controller
│ │ │ │ └── UserController.java
│ │ │ ├── dao
│ │ │ │ └── UserDao.java
│ │ │ ├── domain
│ │ │ │ └── User.java
│ │ │ └── service
│ │ │ ├── IUserService.java
│ │ │ └── impl
│ │ │ └── UserServiceImpl.java
│ │ └── resources
│ │ └── application.properties
│ └── test
│ └── java
│ └── com
│ └── wb
│ └── Mybatisplus04GeneratorApplicationTests.java
完整 pom.xml 文件
代码生成器项目需要引入的完整依赖如下(基于原文提供的项目配置):
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.5.1</version>
</parent>
<groupId>com.wb</groupId>
<artifactId>mybatisplus04generator</artifactId>
<version>0.0.1-SNAPSHOT</version>
<properties>
<java.version>1.8</java.version>
</properties>
<dependencies>
<!--spring webmvc-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<!--mybatisplus-->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>3.4.1</version>
</dependency>
<!--druid-->
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>druid</artifactId>
<version>1.1.16</version>
</dependency>
<!--mysql-->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<scope>runtime</scope>
</dependency>
<!--test-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
<!--lombok-->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.18.12</version>
</dependency>
<!--代码生成器-->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-generator</artifactId>
<version>3.4.1</version>
</dependency>
<!--velocity模板引擎-->
<dependency>
<groupId>org.apache.velocity</groupId>
<artifactId>velocity-engine-core</artifactId>
<version>2.3</version>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
完整的代码生成器类(可直接运行)
将四大配置整合在一个 main 方法中,提供完整可复制的代码:
package com.wb;
import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.generator.AutoGenerator;
import com.baomidou.mybatisplus.generator.config.DataSourceConfig;
import com.baomidou.mybatisplus.generator.config.GlobalConfig;
import com.baomidou.mybatisplus.generator.config.PackageConfig;
import com.baomidou.mybatisplus.generator.config.StrategyConfig;
public class CodeGenerator {
public static void main(String[] args) {
// 1. 创建代码生成器对象
AutoGenerator autoGenerator = new AutoGenerator();
// 2. 数据源配置
DataSourceConfig dataSource = new DataSourceConfig();
dataSource.setDriverName("com.mysql.cj.jdbc.Driver");
dataSource.setUrl("jdbc:mysql://localhost:3306/mybatisplus_db?serverTimezone=UTC");
dataSource.setUsername("root");
dataSource.setPassword("root");
autoGenerator.setDataSource(dataSource);
// 3. 全局配置
GlobalConfig globalConfig = new GlobalConfig();
globalConfig.setOutputDir(System.getProperty("user.dir") + "/mybatisplus04generator/src/main/java");
globalConfig.setOpen(false);
globalConfig.setAuthor("黑马程序员");
globalConfig.setFileOverride(true);
globalConfig.setMapperName("%sDao");
globalConfig.setIdType(IdType.ASSIGN_ID);
autoGenerator.setGlobalConfig(globalConfig);
// 4. 包名配置
PackageConfig packageInfo = new PackageConfig();
packageInfo.setParent("com.aaa"); // 生成的父包
packageInfo.setEntity("domain");
packageInfo.setMapper("dao");
autoGenerator.setPackageInfo(packageInfo);
// 5. 策略配置
StrategyConfig strategyConfig = new StrategyConfig();
strategyConfig.setInclude("tbl_user"); // 要生成的表
strategyConfig.setTablePrefix("tbl_"); // 去掉表前缀
strategyConfig.setRestControllerStyle(true); // REST风格
strategyConfig.setVersionFieldName("version"); // 乐观锁
strategyConfig.setLogicDeleteFieldName("deleted"); // 逻辑删除
strategyConfig.setEntityLombokModel(true); // 使用Lombok
autoGenerator.setStrategy(strategyConfig);
// 6. 执行生成
autoGenerator.execute();
}
}
配置细节补充
- 主键策略(
setIdType)常用可选值:IdType.AUTO:数据库自增IdType.ASSIGN_ID:雪花算法生成Long型IDIdType.ASSIGN_UUID:生成UUID字符串IdType.INPUT:用户手动输入
- 覆盖模式:
setFileOverride(true)开启后再次生成会直接覆盖已有文件,建议仅在初始开发时使用,后期应设为false避免覆盖手写业务代码。 - 自定义模板:若内置模板不满足需求,可通过
autoGenerator.setTemplateEngine(...)指定自定义模板引擎,或通过TemplateConfig配置自定义模板路径。
总结
以上即为 MyBatis-Plus 代码生成器的完整实践内容,从理论到配置再到完整项目代码,可直接复制使用。后续可根据公司规范调整包名、表前缀等参数。
MyBatis-Plus 代码生成器通过 模板 + 数据源 + 配置 三位一体的方式,将重复的代码编写工作自动化。
核心使用步骤为:
- 引入
mybatis-plus-generator和velocity依赖 - 创建
AutoGenerator对象 - 配置
DataSourceConfig、GlobalConfig、PackageConfig、StrategyConfig - 调用
execute()方法
合理配置后,可以一键生成实体类、Mapper、Service、Controller 全套代码,显著提升开发效率。初期学习时建议理解其原理,在实际项目中再灵活运用。
1497



被折叠的 条评论
为什么被折叠?



