MyBatisPlus生成器配置与使用指南

在文章实战开发的过程中，我们经常会遇到一些这样那样的问题，然后要卡好半天，等问题解决了才发现原来一些细节知识点还是没有掌握好。今天golang学习网就整理分享《MyBatisPlus代码生成器配置与使用教程》，聊聊，希望可以帮助到正在努力赚钱的你。

使用MyBatisPlus代码生成器可大幅提升开发效率。1. 引入相关依赖，包括mybatis-plus-generator、freemarker及数据库驱动；2. 编写配置类设置数据源、全局配置、包名及策略，用于生成实体类、Mapper、Service和Controller；3. 可选自定义模板以满足编码风格需求；4. 注意常见问题如数据库连接、字段映射、注释生成等，确保配置准确以提升代码生成效果。

使用MyBatisPlus代码生成器可以大幅提升开发效率，尤其在项目初期搭建阶段。它能根据数据库表结构自动生成实体类、Mapper接口、Service层、Controller层等基础代码，省去了大量重复劳动。

1. 引入依赖

要使用MyBatisPlus的代码生成器，首先要在项目中引入相关依赖。如果你用的是Maven项目，可以在pom.xml中添加以下内容：

<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-generator</artifactId>
    <version>3.5.2</version>
</dependency>
<dependency>
    <groupId>org.freemarker</groupId>
    <artifactId>freemarker</artifactId>
    <version>2.3.31</version>
</dependency>

注意：不同版本的MyBatisPlus Generator可能对FreeMarker或其他模板引擎有不同要求，确保版本兼容性。

另外，还需要数据库驱动依赖，比如MySQL：

<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
    <version>8.0.26</version>
</dependency>

2. 编写配置类

接下来是编写一个Java类来配置代码生成器。你可以创建一个main方法运行这个类，也可以集成到Spring Boot项目中作为启动任务。

核心配置如下：

AutoGenerator generator = new AutoGenerator();

// 数据源配置
DataSourceConfig dataSourceConfig = new DataSourceConfig();
dataSourceConfig.setUrl("jdbc:mysql://localhost:3306/your_db?useUnicode=true&characterEncoding=UTF-8&serverTimezone=Asia/Shanghai");
dataSourceConfig.setDriverName("com.mysql.cj.jdbc.Driver");
dataSourceConfig.setUsername("root");
dataSourceConfig.setPassword("123456");
generator.setDataSource(dataSourceConfig);

// 全局配置
GlobalConfig globalConfig = new GlobalConfig();
globalConfig.setOutputDir(System.getProperty("user.dir") + "/src/main/java");
globalConfig.setAuthor("your_name");
globalConfig.setOpen(false);
globalConfig.setServiceName("%sService"); // 去掉IService前缀
generator.setGlobalConfig(globalConfig);

// 包名配置
PackageConfig packageConfig = new PackageConfig();
packageConfig.setParent("com.example.demo");
packageConfig.setModuleName("system");
generator.setPackageInfo(packageConfig);

// 策略配置
StrategyConfig strategy = new StrategyConfig();
strategy.setNaming(NamingStrategy.underline_to_camel); // 表转类名策略
strategy.setColumnNaming(NamingStrategy.underline_to_camel); // 字段转属性名策略
strategy.setEntityLombokModel(true); // 使用Lombok
strategy.setRestControllerStyle(true); // Controller为RestController风格
strategy.setInclude("user", "role"); // 需要生成的表名
generator.setStrategy(strategy);

// 执行生成
generator.execute();

几点说明：

• outputDir建议设置成项目的src/main/java目录下，这样生成的代码可以直接使用。
• setServiceName("%sService")去掉默认的I前缀，更符合多数团队命名习惯。
• 如果你使用Lombok，记得加上依赖，并且IDE安装了Lombok插件。

3. 自定义模板（可选）

如果默认生成的代码风格或结构不符合你的需求，可以通过自定义模板来调整。

步骤如下：

• 下载官方默认模板（通常是以.ftl结尾的Freemarker文件）
• 修改模板内容，比如Controller加注解、字段描述格式化等
• 在配置中指定模板路径：

TemplateConfig templateConfig = new TemplateConfig();
templateConfig.setController("templates/controller.java.ftl");
generator.setTemplate(templateConfig);

这种方式适合希望统一编码风格、添加特定注释或字段处理逻辑的团队。

4. 常见问题与注意事项

• 数据库连接失败：检查url、用户名、密码是否正确，尤其是MySQL 8以上驱动名称应为com.mysql.cj.jdbc.Driver
• 生成的类没有字段：可能是表字段名和命名策略不匹配，或者未开启自动映射
• 字段类型不准确：有些数据库类型如tinyint会被识别为布尔值，需要手动调整或修改模板
• 字段注释没生成：确保数据库字段设置了comment，并在策略中开启字段注释支持：

strategy.setEntityTableFieldAnnotationEnable(true);

基本上就这些。配置一次后，后续新增表只需要改一下strategy.setInclude(...)即可快速生成代码。虽然看起来步骤不少，但每一步都比较直观，关键在于理解各配置项的作用。

本篇关于《MyBatisPlus生成器配置与使用指南》的介绍就到此结束啦，但是学无止境，想要了解学习更多关于文章的相关知识，请关注golang学习网公众号！