我要评论
1. 引言：mybatis-plus 代码生成器概述
1.1 什么是 autogenerator？
mybatis-plus (mp) 代码生成器，即 autogenerator，是 mybatis-plus 框架提供的一款高效工具。它的核心功能是根据数据库表结构，一键生成项目所需的分层代码，包括：
- entity (实体类/model)
- mapper (持久层接口)
- mapper xml (映射文件)
- service (业务层接口及其实现类)
- controller (控制层)
autogenerator 极大地减少了开发者在项目初期或数据库表结构变更时编写大量重复的 crud 代码的工作量，是 mybatis-plus 提高开发效率的关键工具之一 [1]。
1.2 核心优势
相比于传统的手动编写或旧版代码生成器，mybatis-plus autogenerator 具有以下优势：
- 高度自动化：只需配置数据源和生成策略，即可完成全套代码生成。
- 配置灵活：支持通过链式 api 进行精细化配置，包括命名策略、包结构、字段处理等。
- 模板丰富：内置支持 velocity、freemarker、beetl 等多种模板引擎，并允许用户完全自定义代码模板，以适应不同的项目规范。
- 现代 api：从 3.5.1 版本开始，引入了
fastautogenerator，采用流式 api 设计，配置更加简洁、直观和强大 [2]。
2. 依赖准备
mybatis-plus 代码生成器从 3.0.3 版本后将核心生成器和模板引擎解耦，因此需要手动引入相关依赖。
2.1 核心生成器依赖
在 maven 项目中，需要引入 mybatis-plus-generator 依赖。建议使用 3.5.1 及以上版本以获得最新的 fastautogenerator 功能。
<dependency>
<groupid>com.baomidou</groupid>
<artifactid>mybatis-plus-generator</artifactid>
<version>3.5.3.1</version> <!-- 请使用最新稳定版本 -->
</dependency>2.2 模板引擎依赖
mybatis-plus 默认使用 velocity 模板引擎，但推荐使用更强大的 freemarker 或 beetl。以下以 freemarker 为例：
<dependency>
<groupid>org.freemarker</groupid>
<artifactid>freemarker</artifactid>
<version>2.3.31</version> <!-- 请使用最新稳定版本 -->
</dependency>2.3 数据库驱动
同时，还需要引入对应数据库的 jdbc 驱动（例如 mysql connector/j）。
3. 核心配置体系：fastautogenerator
mybatis-plus 推荐使用 fastautogenerator 类进行配置，它通过流式 api 将配置过程划分为四个主要步骤：数据源、全局配置、包配置和策略配置 [2]。
3.1 整体结构
fastautogenerator.create(data_source_url, username, password)
.globalconfig(builder -> {
// 1. 全局配置 (globalconfig)
})
.packageconfig(builder -> {
// 2. 包配置 (packageconfig)
})
.strategyconfig(builder -> {
// 3. 策略配置 (strategyconfig)
})
.templateengine(new freemarkertemplateengine()) // 4. 模板引擎
.execute(); // 5. 执行生成
3.2 关键配置项详解
3.2.1 全局配置 (globalconfig)
用于设置生成代码的作者、输出目录、是否覆盖文件等全局属性。
| 方法 | 描述 | 示例 |
|---|---|---|
| outputdir(string) | 设置代码生成目录的绝对路径。 | builder.outputdir("d:/code_output"); |
| author(string) | 设置开发人员名称，用于代码注释。 | builder.author("manus ai"); |
| fileoverride() | 开启文件覆盖模式，谨慎使用。 | builder.fileoverride(); |
| enableswagger() | 开启 swagger 注解支持。 | builder.enableswagger(); |
| datetype(datetype) | 设置时间类型，如 datetype.only_date。 | builder.datetype(datetype.time_pack); |
3.2.2 包配置 (packageconfig)
用于定义生成的代码文件的包结构。
| 方法 | 描述 | 示例 |
|---|---|---|
| parent(string) | 设置父包名。 | builder.parent("com.example.project"); |
| modulename(string) | 设置模块名，会在父包下创建子包。 | builder.modulename("user"); |
| entity(string) | 设置实体类包名。 | builder.entity("model"); |
| mapper(string) | 设置 mapper 接口包名。 | builder.mapper("dao"); |
| service(string) | 设置 service 接口包名。 | builder.service("service"); |
| controller(string) | 设置 controller 包名。 | builder.controller("web"); |
3.2.3 策略配置 (strategyconfig)
用于定义数据库表和字段的生成策略，是配置最复杂的部分。
| 方法 | 描述 | 示例 |
|---|---|---|
| addinclude(string...) | 必须：设置需要生成的表名。 | builder.addinclude("t_user", "t_order"); |
| addtableprefix(string...) | 设置需要过滤的表前缀。 | builder.addtableprefix("t_", "sys_"); |
| entitybuilder() | 实体类生成策略配置。 | builder.entitybuilder().enablelombok(); |
| mapperbuilder() | mapper 接口生成策略配置。 | builder.mapperbuilder().enablemapperannotation(); |
| servicebuilder() | service 层生成策略配置。 | builder.servicebuilder().formatservicefilename("%sservice"); |
| controllerbuilder() | controller 层生成策略配置。 | builder.controllerbuilder().enablereststyle(); |
4. 完整案例：spring boot 集成与代码生成
本案例演示如何在 spring boot 项目中，使用 fastautogenerator 为 sys_user 表生成 entity、mapper、service 和 controller 代码。
4.1 案例环境准备
数据库表结构：假设 mysql 中存在以下表：
create table `sys_user` ( `id` bigint not null auto_increment comment '主键id', `user_name` varchar(50) not null comment '用户名', `age` int default null comment '年龄', `email` varchar(100) default null comment '邮箱', `create_time` datetime default current_timestamp comment '创建时间', primary key (`id`) ) engine=innodb default charset=utf8mb4 comment='系统用户表';
项目结构：在 spring boot 项目的 src/test/java 或一个独立的 generator 模块中创建代码生成器类。
4.2 代码生成器实现 (codegenerator.java)
我们使用 fastautogenerator 的流式 api，并配置 lombok、rest 风格 controller、以及下划线转驼峰命名策略。
package com.example.generator;
import com.baomidou.mybatisplus.annotation.idtype;
import com.baomidou.mybatisplus.generator.fastautogenerator;
import com.baomidou.mybatisplus.generator.config.outputfile;
import com.baomidou.mybatisplus.generator.engine.freemarkertemplateengine;
import java.util.collections;
public class codegenerator {
// 数据库连接信息
private static final string url = "jdbc:mysql://localhost:3306/test_db?useunicode=true&characterencoding=utf8&servertimezone=asia/shanghai";
private static final string username = "root";
private static final string password = "your_password";
private static final string parent_package = "com.example.demo";
private static final string module_name = "system";
private static final string author = "manus ai";
public static void main(string[] args) {
fastautogenerator.create(url, username, password)
// 1. 全局配置
.globalconfig(builder -> {
builder.author(author) // 设置作者
.enableswagger() // 开启 swagger 模式
.fileoverride() // 覆盖已生成文件
.outputdir(system.getproperty("user.dir") + "/src/main/java"); // 指定输出目录
})
// 2. 包配置
.packageconfig(builder -> {
builder.parent(parent_package) // 设置父包名
.modulename(module_name) // 设置父包模块名 (com.example.demo.system)
.pathinfo(collections.singletonmap(outputfile.xml,
system.getproperty("user.dir") + "/src/main/resources/mapper/" + module_name)); // 设置 mapper xml 输出路径
})
// 3. 策略配置
.strategyconfig(builder -> {
builder.addinclude("sys_user") // 设置需要生成的表名
.addtableprefix("sys_") // 设置过滤表前缀
// 3.1 entity 策略
.entitybuilder()
.enablelombok() // 开启 lombok
.enablechainmodel() // 开启链式模型
.idtype(idtype.auto) // 设置主键生成策略
.columnnaming(com.baomidou.mybatisplus.generator.config.rules.namingstrategy.underline_to_camel) // 字段名下划线转驼峰
// 3.2 controller 策略
.controllerbuilder()
.enablereststyle() // 开启 @restcontroller
// 3.3 service 策略
.servicebuilder()
.formatservicefilename("%sservice") // 格式化 service 接口文件名称
// 3.4 mapper 策略
.mapperbuilder()
.enablemapperannotation() // 开启 @mapper 注解
.enablebaseresultmap() // 启用 baseresultmap
.enablebasecolumnlist(); // 启用 basecolumnlist
})
// 4. 模板引擎配置 (使用 freemarker)
.templateengine(new freemarkertemplateengine())
// 5. 执行生成
.execute();
}
}
4.3 生成结果分析
执行上述 main 方法后，代码将生成到指定的输出目录，例如：
| 文件类型 | 路径 | 描述 |
|---|---|---|
| entity | com.example.demo.system.entity.user.java | 包含 id, username, age, email, createtime 属性，并带有 lombok 注解。 |
| mapper | com.example.demo.system.mapper.usermapper.java | 继承自 basemapper<user>，包含基础 crud 方法。 |
| mapper xml | src/main/resources/mapper/system/usermapper.xml | 包含 baseresultmap 和 basecolumnlist，以及基础 sql 语句。 |
| service | com.example.demo.system.service.userservice.java | 继承自 iservice<user>。 |
| service impl | com.example.demo.system.service.impl.userserviceimpl.java | 继承自 serviceimpl<usermapper, user>。 |
| controller | com.example.demo.system.controller.usercontroller.java | 带有 @restcontroller 注解，包含基础的 restful 接口。 |
5. 高级特性与最佳实践
5.1 自定义模板
如果默认生成的代码不符合您的项目规范（例如需要自定义注释、引入特定的父类或接口），可以通过自定义模板来实现。
- 获取默认模板：从
mybatis-plus-generator的源码中获取默认的模板文件（如entity.java.ftl）。 - 修改模板：将模板文件拷贝到项目的
src/main/resources/templates目录下，并根据需求修改其中的内容。 - 配置模板路径：在
fastautogenerator中通过templateconfig指定自定义模板的路径。
// 示例：配置自定义 entity 模板
.templateconfig(builder -> {
builder.entity("templates/my_entity.java"); // 使用自定义模板
})
5.2 字段类型处理
mybatis-plus 提供了灵活的字段类型处理机制，例如将数据库的 datetime 映射为 java 8 的 localdatetime。
// 在 globalconfig 中设置时间类型策略
.globalconfig(builder -> {
// ... 其他配置
builder.datetype(com.baomidou.mybatisplus.generator.config.rules.datetype.time_pack); // 映射为 localdatetime
})
5.3 排除公共字段
如果您的实体类继承了一个包含公共字段（如 id, create_time, update_time）的基类 (baseentity)，您可以在策略配置中排除这些字段，避免重复生成。
.strategyconfig(builder -> {
// ... 其他配置
builder.entitybuilder()
.superclass("com.example.baseentity") // 设置父类
.addsuperentitycolumns("id", "create_time", "update_time"); // 排除父类已有的字段
})
6. 结论
mybatis-plus 代码生成器（autogenerator）是 java 后端开发中不可多得的效率工具。通过掌握其 3.5.1+ 版本引入的 fastautogenerator 流式配置 api，开发者可以轻松实现代码的自动化生成，将更多精力聚焦于核心业务逻辑的创新与实现，从而显著提升项目的开发速度和代码质量。
以上为个人经验，希望能给大家一个参考，也希望大家多多支持代码网。
发表评论