Java MyBatis 怎么通过代码生成器自动生成实体类与 Mapper 接口

舞夢輝影

舞夢輝影

2026-07-31

848人浏览

原创

mybatis 官方推荐使用 mybatis generator(mbg)自动生成实体类、mapper 接口和 xml 映射文件;需在 pom.xml 中配置插件及依赖,编写 generatorconfig.xml 定义数据源与生成规则,执行 mvn mybatis-generator:generate 命令即可完成代码生成。

java mybatis 怎么通过代码生成器自动生成实体类与 mapper 接口

MyBatis 本身不自带代码生成器,但官方推荐并广泛使用的是 MyBatis Generator(MBG),它能根据数据库表结构自动生成实体类(POJO)、Mapper 接口和 XML 映射文件。以下是标准、可落地的配置与使用方式。

配置 MyBatis Generator 插件(Maven 项目)

pom.xml 中引入 MBG 核心依赖和插件:

  • 添加 mybatis-generator-core 依赖(运行时非必需,但 IDE 中预览需要)
  • 配置 mybatis-generator-maven-plugin 插件,指定数据库连接、生成策略和输出路径

示例关键配置片段:


  org.mybatis.generator
  mybatis-generator-maven-plugin
  1.4.2
  
    src/main/resources/generatorConfig.xml
    true
    true
  

编写 generatorConfig.xml 配置文件

该文件定义数据源、生成规则和目标结构。核心部分包括:

Java JDK 25
Java JDK 25

Java JDK 25 来自 OpenJDK 官方归档,版本为 JDK 25,本条下载地址已指向官方 Windows x64 zip 安装包直链,适合调试旧项目或兼容旧版 Java 运行环境。

下载
  • jdbcConnection:填入数据库 URL、用户名、密码和驱动类(如 MySQL 8+ 用 com.mysql.cj.jdbc.Driver
  • javaModelGenerator:设置实体类包名、是否使用 Lombok、是否生成 toString/equals/hashCode 等
  • sqlMapGenerator:指定 XML 文件输出目录(如 src/main/resources/mapper
  • javaClientGenerator:选择 Mapper 类型(ANNOTATEDMAPPER 生成注解版,XMLMAPPER 生成 XML + 接口)
  • table:可逐个指定表名,或用 tableName="%" 批量生成所有表(慎用,建议显式列出)

运行生成命令

在项目根目录执行 Maven 命令即可触发生成:

  • 命令行:mvn mybatis-generator:generate
  • IDEA 中右键 pom.xmlMavenGenerate sources and update folders,或直接双击插件目标 mybatis-generator:generate

成功后,会在指定目录下生成:

  • domain/User.java(实体类,默认带 getter/setter)
  • mapper/UserMapper.java(接口,含基础 CRUD 方法)
  • mapper/UserMapper.xml(SQL 映射文件,若选 XML 模式)

进阶建议与常见注意点

  • 实体类字段命名默认按数据库列名转驼峰(如 user_nameuserName),确保数据库命名规范或启用 useActualColumnNames=false
  • 如用 Lombok,可在 javaModelGenerator 中加 <property name="enableSubPackages" value="true"></property> 并配合 @Data 注解简化代码
  • 生成后建议手动检查主键策略(如 MySQL 的 id 是否设为 INSERT 自增)、逻辑删除字段(deleted)是否被正确识别
  • 避免每次生成都覆盖全部文件——可将自定义方法写在独立的 Mapper 接口继承类中,或使用 example 类辅助复杂查询

不复杂但容易忽略细节,配好一次,后续加表只需改配置再运行即可。

Java免费学习笔记:立即使用
解锁 Java 大师之旅:从入门到精通的终极指南

相关专题

更多
java
java

Java是一个通用术语,用于表示Java软件及其组件,包括“Java运行时环境 (JRE)”、“Java虚拟机 (JVM)”以及“插件”。php中文网还为大家带了Java相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

2023.06.15

3864

6

java正则表达式语法
java正则表达式语法

java正则表达式语法是一种模式匹配工具,它非常有用,可以在处理文本和字符串时快速地查找、替换、验证和提取特定的模式和数据。本专题提供java正则表达式语法的相关文章、下载和专题,供大家免费下载体验。

2023.07.05

2839

9

java自学难吗
java自学难吗

Java自学并不难。Java语言相对于其他一些编程语言而言,有着较为简洁和易读的语法,本专题为大家提供java自学难吗相关的文章,大家可以免费体验。

2023.07.31

2877

8

java配置jdk环境变量
java配置jdk环境变量

Java是一种广泛使用的高级编程语言,用于开发各种类型的应用程序。为了能够在计算机上正确运行和编译Java代码,需要正确配置Java Development Kit(JDK)环境变量。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.08.01

637

3

java保留两位小数
java保留两位小数

Java是一种广泛应用于编程领域的高级编程语言。在Java中,保留两位小数是指在进行数值计算或输出时,限制小数部分只有两位有效数字,并将多余的位数进行四舍五入或截取。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.08.02

602

3

java基本数据类型
java基本数据类型

java基本数据类型有:1、byte;2、short;3、int;4、long;5、float;6、double;7、char;8、boolean。本专题为大家提供java基本数据类型的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.02

726

5

java有什么用
java有什么用

java可以开发应用程序、移动应用、Web应用、企业级应用、嵌入式系统等方面。本专题为大家提供java有什么用的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.02

1317

5

java在线网站
java在线网站

Java在线网站是指提供Java编程学习、实践和交流平台的网络服务。近年来,随着Java语言在软件开发领域的广泛应用,越来越多的人对Java编程感兴趣,并希望能够通过在线网站来学习和提高自己的Java编程技能。php中文网给大家带来了相关的视频、教程以及文章,欢迎大家前来学习阅读和下载。

2023.08.03

18845

3

配置java环境变量
配置java环境变量

配置Java环境变量是为了让操作系统能够识别和使用Java的相关命令和功能。本专题为大家提供配置java环境变量相关文章,帮助大家解决问题。

2023.08.03

647

8

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Java JDBC数据库连接官方教程
Java JDBC数据库连接官方教程

共0课时 | 0人学习

Java 26官方文档
Java 26官方文档

共0课时 | 0人学习