mybatis自动生成代码插件配置-精创网络云防护

帮助文档
mybatis自动生成代码插件配置
来源：www.jcwlyf.com更新时间：2025-02-25
MyBatis 是一个流行的持久层框架，它通过映射文件和注解来提供数据库操作的支持。为了提高开发效率，许多开发者选择使用 MyBatis 自动生成代码插件。通过自动生成代码，开发人员可以快速地生成实体类、Mapper 接口、XML 映射文件等，大大减少了手动编写的工作量。本文将详细介绍 MyBatis 自动生成代码插件的配置方法，帮助开发者快速上手并提高工作效率。
一、MyBatis 自动生成代码插件概述
MyBatis 自动生成代码插件（MyBatis Generator，简称 MBG）是 MyBatis 提供的一个工具，旨在自动生成基于数据库表的 Java 类、映射文件、Mapper 接口等。它可以大大减少开发人员在进行持久层开发时的工作量。通过 MBG，开发者只需提供数据库表的相关信息，插件便能根据表结构生成相应的实体类和操作数据库的代码。
MyBatis Generator 的核心功能包括：
自动生成实体类
自动生成 Mapper 接口
自动生成 XML 映射文件
自动生成 DAO 层接口与实现类
接下来，我们将详细讲解如何配置和使用 MyBatis 自动生成代码插件。
二、MyBatis Generator 配置步骤
在开始使用 MyBatis Generator 之前，首先需要在项目中引入相关的依赖。
1. 引入依赖
在 Maven 项目中，引入 MyBatis Generator 相关的依赖，编辑 pom.xml 文件。
```
<dependency>
    <groupId>org.mybatis.generator</groupId>
    <artifactId>mybatis-generator-core</artifactId>
    <version>1.3.7</version>
</dependency>
<dependency>
    <groupId>org.mybatis</groupId>
    <artifactId>mybatis</artifactId>
    <version>3.5.5</version>
</dependency>
<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
    <version>8.0.23</version>
</dependency>
```
如果是 Gradle 项目，可以通过以下方式引入依赖：
```
dependencies {
    implementation 'org.mybatis.generator:mybatis-generator-core:1.3.7'
    implementation 'org.mybatis:mybatis:3.5.5'
    implementation 'mysql:mysql-connector-java:8.0.23'
}
```
2. 配置 MyBatis Generator
在项目的资源文件夹中创建一个 mybatis-generator-config.xml 配置文件，该文件用于定义生成代码的规则。
```
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE generatorConfiguration PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN" "http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd">
<generatorConfiguration>
    
    <context id="MySQL" targetRuntime="MyBatis3">
        <jdbcConnection driverClass="com.mysql.cj.jdbc.Driver" 
                        connectionURL="jdbc:mysql://localhost:3306/testdb?useSSL=false&serverTimezone=UTC"
                        userId="root" 
                        password="root">
        </jdbcConnection>
        
        
        <javaModelGenerator targetPackage="com.example.model" targetProject="src/main/java">
            <property name="enableSubPackages" value="false"/>
            <property name="trimStrings" value="true"/>
        </javaModelGenerator>
        
        
        <javaClientGenerator targetPackage="com.example.mapper" targetProject="src/main/java">
            <property name="enableSubPackages" value="false"/>
        </javaClientGenerator>

        
        <sqlMapGenerator targetPackage="com.example.mapper" targetProject="src/main/resources">
            <property name="enableSubPackages" value="false"/>
        </sqlMapGenerator>
        
        
        <table tableName="user" domainObjectName="User"/>
    </context>
</generatorConfiguration>
```
在该配置文件中，主要包括以下几个部分：
jdbcConnection：配置数据库连接信息，指定数据库的 URL、用户名、密码等。
javaModelGenerator：配置生成实体类的包名和路径。
javaClientGenerator：配置生成 Mapper 接口的包名和路径。
sqlMapGenerator：配置生成 XML 映射文件的包名和路径。
table：指定需要生成代码的数据库表及其对应的 Java 类名称。
3. 执行 MyBatis Generator
配置完成后，需要通过执行 MyBatis Generator 来生成代码。可以通过 Maven 插件的方式执行，编辑 pom.xml 文件，在 "<build>" 标签内添加如下插件配置：
```
<build>
    <plugins>
        <plugin>
            <groupId>org.mybatis.generator</groupId>
            <artifactId>mybatis-generator-maven-plugin</artifactId>
            <version>1.3.7</version>
            <executions>
                <execution>
                    <goals>
                        <goal>generate</goal>
                    </goals>
                </execution>
            </executions>
            <configuration>
                <configurationFile>src/main/resources/mybatis-generator-config.xml</configurationFile>
                <verbose>true</verbose>
            </configuration>
        </plugin>
    </plugins>
</build>
```
通过 Maven 执行以下命令来生成代码：
```
mvn mybatis-generator:generate
```
执行后，系统将根据数据库表结构生成相应的实体类、Mapper 接口和 XML 映射文件。
三、生成的代码文件分析
生成代码后，我们可以看到以下文件：
实体类</strong：生成的实体类与数据库表结构一一对应。
Mapper 接口：为每个表生成对应的 Mapper 接口，其中包含常见的增、删、改、查方法。
XML 映射文件：XML 文件包含 SQL 映射，提供具体的 SQL 查询语句。
四、定制化生成规则
MyBatis Generator 提供了丰富的定制化选项，开发者可以根据实际需求定制生成的代码。例如，可以通过修改 XML 配置文件中的属性，来控制生成的类名、包名以及字段的命名规则。
1. 定义生成的类名
可以通过修改 "domainObjectName" 属性来定义生成的实体类名称，例如：
```
<table tableName="user" domainObjectName="UserEntity"/>
```
这样生成的实体类将被命名为 UserEntity。
2. 自定义字段类型映射
MyBatis Generator 允许开发者根据需要自定义字段类型的映射。例如，将数据库中的某个字段映射成 Java 中的 "LocalDate" 类型。
五、总结
通过 MyBatis Generator 自动生成代码插件，开发者可以大幅提高开发效率。只需通过简单的配置，就能自动生成实体类、Mapper 接口和 XML 映射文件。本文介绍了 MyBatis Generator 的安装与配置方法，并深入探讨了如何定制生成规则。希望本教程能帮助你快速上手 MyBatis Generator，提高开发效率。