1. Mybatis代码生成器项目概述

作为一名长期使用Mybatis框架的后端开发者，我深刻体会到手动编写实体类、Mapper接口和XML文件的繁琐。特别是在项目初期，面对数十张表的CRUD操作，重复劳动不仅效率低下，还容易出错。这就是为什么我决定深入研究Mybatis官方提供的代码生成器（MyBatis Generator，简称MBG），并在此分享我的实战经验。

Mybatis代码生成器本质上是一个自动化工具，它通过读取数据库表结构，自动生成对应的实体类、Mapper接口和XML映射文件。根据我的使用统计，相比手动编写，它能将开发效率提升300%以上，特别适合快速构建数据访问层。本系列开发日记将详细记录从环境配置到高级定制的全过程，涵盖IntelliJ IDEA集成、POM依赖管理、自定义模板等实用技巧。

2. 核心原理与架构设计

2.1 生成器工作原理剖析

MBG的核心工作机制可以分为三个关键阶段：

1. 数据库元数据采集：通过JDBC连接数据库，读取表结构、字段类型、主键、外键等元数据。这里需要注意，不同数据库（MySQL/Oracle等）的元数据获取方式存在差异。

2. 代码生成引擎：基于Velocity模板引擎（默认）将元数据填充到预设模板中。模板文件决定了最终生成的代码结构和风格。

3. 输出控制：支持生成POJO、Mapper接口、XML映射文件以及Example类，可以通过配置精确控制生成内容。

重要提示：MBG默认生成的Example类在实际项目中往往使用率不高，建议通过配置关闭以保持代码简洁。

2.2 标准项目结构设计

经过多个项目的实践验证，我总结出以下推荐目录结构：

src/main ├── java │ ├── com.xxx.entity # 生成的实体类 │ ├── com.xxx.mapper # Mapper接口 └── resources ├── generator # 生成器配置文件 │ ├── generatorConfig.xml │ └── customTemplates # 自定义模板目录 └── mapper # 生成的XML文件

这种结构清晰分离了生成代码和业务代码，便于维护。特别是在多模块项目中，建议将生成器配置和生成的代码放在独立的模块中。

3. 环境搭建与基础配置

3.1 依赖管理关键点

在pom.xml中添加MBG插件时，版本兼容性至关重要。以下是我的推荐配置：

<plugin> <groupId>org.mybatis.generator</groupId> <artifactId>mybatis-generator-maven-plugin</artifactId> <version>1.4.1</version> <dependencies> <dependency> <groupId>mysql</groupId> <artifactId>mysql-connector-java</artifactId> <version>8.0.28</version> </dependency> </dependencies> </plugin>

常见版本问题包括：

• MySQL 8.0+需要对应版本的connector
• 与MyBatis主版本保持兼容（3.x对应MBG 1.4.x）
• 与Spring Boot版本协调（通过mybatis-spring-boot-starter间接依赖）

3.2 核心配置文件详解

generatorConfig.xml是MBG的核心配置文件，主要包含以下几个关键部分：

<context id="MySQLTables" targetRuntime="MyBatis3"> <!-- 数据库连接配置 --> <jdbcConnection driverClass="com.mysql.cj.jdbc.Driver" connectionURL="jdbc:mysql://localhost:3306/test" userId="root" password="123456"> <property name="nullCatalogMeansCurrent" value="true"/> </jdbcConnection> <!-- Java模型生成配置 --> <javaModelGenerator targetPackage="com.example.entity" targetProject="src/main/java"> <property name="enableSubPackages" value="true"/> <property name="trimStrings" value="true"/> </javaModelGenerator> <!-- SQL映射文件生成配置 --> <sqlMapGenerator targetPackage="mapper" targetProject="src/main/resources"> <property name="enableSubPackages" value="true"/> </sqlMapGenerator> <!-- Mapper接口生成配置 --> <javaClientGenerator type="XMLMAPPER" targetPackage="com.example.mapper" targetProject="src/main/java"/> <!-- 表配置 --> <table schema="test" tableName="user%" domainObjectName="User" enableCountByExample="false" enableUpdateByExample="false" enableDeleteByExample="false" enableSelectByExample="false" selectByExampleQueryId="false"> <generatedKey column="id" sqlStatement="MySQL" identity="true"/> </table> </context>

实际项目中容易踩的坑：

1. MySQL 8.0+需要设置nullCatalogMeansCurrent=true
2. 表名模糊匹配使用tableName="user%"
3. 禁用Example相关方法可以简化代码
4. 主键自增配置对INSERT操作至关重要

4. 高级定制与实战技巧

4.1 自定义模板开发

MBG默认生成的代码风格可能不符合团队规范，这时就需要自定义模板。以修改实体类模板为例：

1. 复制默认模板：从MBG的jar包中提取org/mybatis/generator/templates/model/ModelClass.java.ftl
2. 创建自定义目录：在resources下新建generator/customTemplates
3. 修改模板内容：例如添加Lombok注解、Swagger注解等
4. 配置使用自定义模板：

<context> <property name="javaFileEncoding" value="UTF-8"/> <plugin type="org.mybatis.generator.plugins.SerializablePlugin"/> <commentGenerator> <property name="suppressAllComments" value="true"/> </commentGenerator> <!-- 指定自定义模板路径 --> <javaModelGenerator targetPackage="com.example.entity" targetProject="src/main/java"> <property name="rootClass" value="com.example.BaseEntity"/> <property name="templatePath" value="generator/customTemplates"/> </javaModelGenerator> </context>

我常用的模板优化包括：

• 添加@Data、@Builder等Lombok注解
• 增加字段注释（从数据库comment读取）
• 实现Serializable接口
• 添加JSR303校验注解

4.2 插件开发实战

当内置功能无法满足需求时，可以开发自定义插件。例如实现一个自动添加Mapper注解的插件：

public class MapperAnnotationPlugin extends PluginAdapter { @Override public boolean clientGenerated(Interface interfaze, TopLevelClass topLevelClass, IntrospectedTable introspectedTable) { // 添加@Mapper注解 interfaze.addAnnotation("@Mapper"); interfaze.addImportedType("org.apache.ibatis.annotations.Mapper"); return true; } @Override public boolean validate(List<String> warnings) { return true; } }

在配置文件中启用插件：

<context> <plugin type="com.example.MyMapperAnnotationPlugin"/> </context>

其他实用的插件场景：

• 自动生成toString()方法
• 添加Swagger API注解
• 生成字段常量定义
• 自动生成Service层接口

5. 工程化实践与性能优化

5.1 多模块项目集成

在大型项目中，推荐采用以下模块结构：

project ├── pom.xml ├── generator-module # 代码生成专用模块 │ ├── src/main/resources/generator │ └── pom.xml ├── domain-module # 实体类模块 │ ├── src/main/java │ └── pom.xml └── persistence-module # Mapper模块 ├── src/main/java └── pom.xml

关键配置要点：

1. 在generator模块中配置MBG插件
2. 设置targetProject指向其他模块的路径
3. 处理好模块间的依赖关系

5.2 生成代码优化策略

1. 批量生成与增量生成：

   • 全量生成：mvn mybatis-generator:generate
   • 单表生成：通过tableName配置指定特定表

2. 生成代码版本控制：

   • 将生成的代码纳入Git管理
   • 使用.gitattributes设置合并策略：

     src/main/resources/mapper/*.xml merge=union

3. 生成前后钩子：

   • 使用Maven的exec-maven-plugin在生成前后执行脚本
   • 常见用途：格式化代码、生成额外的DTO类等

6. 常见问题排查指南

6.1 典型错误与解决方案

6.2 日志调试技巧

1. 启用详细日志：

<plugin> <configuration> <verbose>true</verbose> </configuration> </plugin>

2. 使用MyBatis Log Free插件查看实际执行的SQL

3. 通过Arthas监控生成的SQL语句：

watch org.apache.ibatis.mapping.MappedStatement getBoundSql '{params,returnObj}'

7. 进阶扩展方向

7.1 与MyBatis-Plus整合

虽然MBG功能强大，但MyBatis-Plus提供了更便捷的CRUD操作。可以结合两者优势：

1. 使用MBG生成基础代码
2. 让Mapper接口继承BaseMapper
3. 配置MyBatis-Plus的分页插件

public interface UserMapper extends BaseMapper<User> { // 自定义方法 }

7.2 动态条件查询优化

替代传统的Example查询，可以使用更灵活的Wrapper：

QueryWrapper<User> wrapper = new QueryWrapper<>(); wrapper.lambda() .eq(User::getName, "张三") .gt(User::getAge, 18) .orderByAsc(User::getCreateTime); userMapper.selectList(wrapper);

对于复杂查询，可以结合@Select注解实现：

@Select("select * from user where name = #{name} and age > #{age}") List<User> selectByCustom(@Param("name") String name, @Param("age") Integer age);

经过多个项目的实践验证，合理使用MyBatis代码生成器可以显著提升开发效率，特别是在初期搭建阶段。但需要注意，生成的代码只是起点，实际项目中通常需要根据业务需求进行深度定制。建议团队制定统一的代码生成规范，并定期review生成结果，确保代码质量。