1. Mybatis代码生成器项目概述作为一名长期使用Mybatis框架的后端开发者我深刻体会到手动编写实体类、Mapper接口和XML文件的繁琐。特别是在项目初期面对数十张表的CRUD操作重复劳动不仅效率低下还容易出错。这就是为什么我决定深入研究Mybatis官方提供的代码生成器MyBatis Generator简称MBG并在此分享我的实战经验。Mybatis代码生成器本质上是一个自动化工具它通过读取数据库表结构自动生成对应的实体类、Mapper接口和XML映射文件。根据我的使用统计相比手动编写它能将开发效率提升300%以上特别适合快速构建数据访问层。本系列开发日记将详细记录从环境配置到高级定制的全过程涵盖IntelliJ IDEA集成、POM依赖管理、自定义模板等实用技巧。2. 核心原理与架构设计2.1 生成器工作原理剖析MBG的核心工作机制可以分为三个关键阶段数据库元数据采集通过JDBC连接数据库读取表结构、字段类型、主键、外键等元数据。这里需要注意不同数据库MySQL/Oracle等的元数据获取方式存在差异。代码生成引擎基于Velocity模板引擎默认将元数据填充到预设模板中。模板文件决定了最终生成的代码结构和风格。输出控制支持生成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 groupIdorg.mybatis.generator/groupId artifactIdmybatis-generator-maven-plugin/artifactId version1.4.1/version dependencies dependency groupIdmysql/groupId artifactIdmysql-connector-java/artifactId version8.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 idMySQLTables targetRuntimeMyBatis3 !-- 数据库连接配置 -- jdbcConnection driverClasscom.mysql.cj.jdbc.Driver connectionURLjdbc:mysql://localhost:3306/test userIdroot password123456 property namenullCatalogMeansCurrent valuetrue/ /jdbcConnection !-- Java模型生成配置 -- javaModelGenerator targetPackagecom.example.entity targetProjectsrc/main/java property nameenableSubPackages valuetrue/ property nametrimStrings valuetrue/ /javaModelGenerator !-- SQL映射文件生成配置 -- sqlMapGenerator targetPackagemapper targetProjectsrc/main/resources property nameenableSubPackages valuetrue/ /sqlMapGenerator !-- Mapper接口生成配置 -- javaClientGenerator typeXMLMAPPER targetPackagecom.example.mapper targetProjectsrc/main/java/ !-- 表配置 -- table schematest tableNameuser% domainObjectNameUser enableCountByExamplefalse enableUpdateByExamplefalse enableDeleteByExamplefalse enableSelectByExamplefalse selectByExampleQueryIdfalse generatedKey columnid sqlStatementMySQL identitytrue/ /table /context实际项目中容易踩的坑MySQL 8.0需要设置nullCatalogMeansCurrenttrue表名模糊匹配使用tableNameuser%禁用Example相关方法可以简化代码主键自增配置对INSERT操作至关重要4. 高级定制与实战技巧4.1 自定义模板开发MBG默认生成的代码风格可能不符合团队规范这时就需要自定义模板。以修改实体类模板为例复制默认模板从MBG的jar包中提取org/mybatis/generator/templates/model/ModelClass.java.ftl创建自定义目录在resources下新建generator/customTemplates修改模板内容例如添加Lombok注解、Swagger注解等配置使用自定义模板context property namejavaFileEncoding valueUTF-8/ plugin typeorg.mybatis.generator.plugins.SerializablePlugin/ commentGenerator property namesuppressAllComments valuetrue/ /commentGenerator !-- 指定自定义模板路径 -- javaModelGenerator targetPackagecom.example.entity targetProjectsrc/main/java property namerootClass valuecom.example.BaseEntity/ property nametemplatePath valuegenerator/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(ListString warnings) { return true; } }在配置文件中启用插件context plugin typecom.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关键配置要点在generator模块中配置MBG插件设置targetProject指向其他模块的路径处理好模块间的依赖关系5.2 生成代码优化策略批量生成与增量生成全量生成mvn mybatis-generator:generate单表生成通过tableName配置指定特定表生成代码版本控制将生成的代码纳入Git管理使用.gitattributes设置合并策略src/main/resources/mapper/*.xml mergeunion生成前后钩子使用Maven的exec-maven-plugin在生成前后执行脚本常见用途格式化代码、生成额外的DTO类等6. 常见问题排查指南6.1 典型错误与解决方案问题现象可能原因解决方案无法连接数据库JDBC驱动版本不匹配使用与数据库版本对应的驱动表找不到schema配置错误设置nullCatalogMeansCurrenttrue生成代码缺少字段字段命名不规范检查columnOverride配置XML文件有语法错误特殊字符未转义配置escapeWildcardstrue重复生成覆盖修改文件已存在策略设置overwritetrue或mergeabletrue6.2 日志调试技巧启用详细日志plugin configuration verbosetrue/verbose /configuration /plugin使用MyBatis Log Free插件查看实际执行的SQL通过Arthas监控生成的SQL语句watch org.apache.ibatis.mapping.MappedStatement getBoundSql {params,returnObj}7. 进阶扩展方向7.1 与MyBatis-Plus整合虽然MBG功能强大但MyBatis-Plus提供了更便捷的CRUD操作。可以结合两者优势使用MBG生成基础代码让Mapper接口继承BaseMapper配置MyBatis-Plus的分页插件public interface UserMapper extends BaseMapperUser { // 自定义方法 }7.2 动态条件查询优化替代传统的Example查询可以使用更灵活的WrapperQueryWrapperUser 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}) ListUser selectByCustom(Param(name) String name, Param(age) Integer age);经过多个项目的实践验证合理使用MyBatis代码生成器可以显著提升开发效率特别是在初期搭建阶段。但需要注意生成的代码只是起点实际项目中通常需要根据业务需求进行深度定制。建议团队制定统一的代码生成规范并定期review生成结果确保代码质量。