Spring Boot 3.x 整合 MyBatis 代码生成器插件

在后端项目开发中，每当迭代新功能时，通常都会先进行表设计、接口设计这一步，第一步就是为每张表创建对应的实体类、Mapper 接口，如果你使用的持久层框架是 MyBatis , 还需要额外创建 XML 映射文件。这些步骤都是模板式的，完全可以自动化生成相关代码，以提升开发效率！

1. mybatis-generator 是什么？

在这里插入图片描述

mybatis-generator-maven-plugin 是一个 Maven 插件，用于生成 MyBatis 的代码（如 Mapper 接口、Mapper XML 文件等），官方文档地址: https://mybatis.org/generator/ 。它可以根据数据库表自动生成相应的 Java 实体类、Mapper 接口和 XML 映射文件，大大减少了手动编写这些重复且机械化的代码的工作量。以下是它的一些优点：

自动化生成代码： 可以根据数据库表结构自动生成与之对应的 Java 实体类、Mapper 接口和 XML 映射文件，省去了手动编写这些代码的繁琐过程。
提高开发效率： 通过自动生成代码，开发人员可以更专注于业务逻辑的实现，而不必花费大量时间在重复的 CRUD 操作上。
保持数据一致性： 自动生成的代码与数据库表结构保持一致，避免了手动编写代码时可能出现的字段名拼写错误或数据类型不匹配等问题。
易于维护： 自动生成的代码结构清晰，易于阅读和理解，便于后续的维护和修改。
支持定制化配置： 可以通过配置文件或插件参数对生成的代码进行定制，满足不同项目的需求。

2. 开始整合

   <properties>
		// 省略...
		
        <mybatis-generator-maven-plugin.version>1.3.5</mybatis-generator-maven-plugin.version>

		// 省略...
    </properties>
    
    // 省略...
    
    <build>
        <!-- 统一插件管理 -->
        <pluginManagement>
            <plugins>
                // 省略...

                <!-- 代码生成器 -->
                <plugin>
                    <groupId>org.mybatis.generator</groupId>
                    <artifactId>mybatis-generator-maven-plugin</artifactId>
                    <version>${
    
    mybatis-generator-maven-plugin.version}</version>
                    <configuration>
                        <!-- 允许移动生成的文件 -->
                        <verbose>true</verbose>
                        <!-- 允许覆盖生成的文件 -->
                        <overwrite>true</overwrite>
                    </configuration>
                    <!-- 此插件需要连接数据库，所以需要依赖 MySQL 驱动 -->
                    <dependencies>
                        <dependency>
                            <groupId>mysql</groupId>
                            <artifactId>mysql-connector-java</artifactId>
                            <version>${
    
    mysql-connector-java.version}</version>
                        </dependency>
                    </dependencies>
                </plugin>
            </plugins>
        </pluginManagement>

    </build>

接着，在其他模块，在 pom.xml 文件中添加该插件：

    <build>
        <plugins>
			// 省略...
			
            <!-- 代码生成器 -->
            <plugin>
                <groupId>org.mybatis.generator</groupId>
                <artifactId>mybatis-generator-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

添加完成后，重新刷新一下 Maven 依赖。大概率还会爆红，暂时先不管，观察右侧栏，确认一下认证服务中 Plugins 下是否有该插件, 如下图所示：

在这里插入图片描述

3. 添加配置文件

插件添加完毕后，在 /resources 目录下，创建名为 generatorConfig.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="mysqlTables" targetRuntime="MyBatis3" defaultModelType="flat">

        <!-- 自动检查关键字，为关键字增加反引号，如：`type` -->
        <property name="autoDelimitKeywords" value="true"/>
        <property name="beginningDelimiter" value="`"/>
        <property name="endingDelimiter" value="`"/>
        <!-- 指定生成的 Java 文件编码 -->
        <property name="javaFileEncoding" value="UTF-8"/>

        <!-- 对生成的注释进行控制 -->
        <commentGenerator>
            <!-- 由于此插件生成的注释不太美观，这里设置不生成任何注释 -->
            <property name="suppressAllComments" value="true"/>
        </commentGenerator>

        <!-- 数据库链接 -->
        <jdbcConnection driverClass="com.mysql.cj.jdbc.Driver"
                        connectionURL="jdbc:mysql://127.0.0.1:3306/xiaohashu"
                        userId="root"
                        password="123456">
            <!-- 解决多个重名的表生成表结构不一致问题 -->
            <property name="nullCatalogMeansCurrent" value="true"/>
        </jdbcConnection>

        <!-- 不强制将所有的数值类型映射为 Java 的 BigDecimal 类型 -->
        <javaTypeResolver>
            <property name="forceBigDecimals" value="false"/>
        </javaTypeResolver>

        <!-- DO 实体类存放路径 -->
        <javaModelGenerator targetPackage="com.quanxiaoha.xiaohashu.auth.domain.dataobject"
                            targetProject="src/main/java"/>

        <!-- Mapper xml 文件存放路径-->
        <sqlMapGenerator targetPackage="mapper"
                         targetProject="src/main/resources"/>

        <!-- Mapper 接口存放路径 -->
        <javaClientGenerator type="XMLMAPPER" targetPackage="com.quanxiaoha.xiaohashu.auth.domain.mapper"
                             targetProject="src/main/java"/>

        <!-- 需要生成的表-实体类 -->
        <table tableName="t_user" domainObjectName="UserDO"
               enableCountByExample="false"
               enableUpdateByExample="false"
               enableDeleteByExample="false"
               enableSelectByExample="false"
               selectByExampleQueryId="false"/>
    </context>
</generatorConfiguration>

解释一下各项配置的含义：

generatorConfiguration 标签是根标签，用于定义整个配置文件的内容。
```
context
```
标签定义了一个上下文，用于指定生成代码的一些全局配置和规则。
- id 属性指定了上下文的唯一标识符，这里是 mysqlTables。
- targetRuntime 属性指定了生成代码的目标运行时环境，这里是 MyBatis3。
- defaultModelType 属性指定了生成代码时默认的模型类型，这里是 flat，表示生成的实体类是扁平化的。
```
property
```
标签用于配置一些属性。
- autoDelimitKeywords 属性设置为 true 表示自动检查关键字，为关键字增加反引号。
- beginningDelimiter 和 endingDelimiter 属性指定了起始和结束的引号。
- javaFileEncoding 属性指定了生成的 Java 文件的编码为 UTF-8。
commentGenerator 标签用于配置注释生成器，这里设置 suppressAllComments 属性为 true 表示不生成任何注释。
jdbcConnection 标签用于配置数据库连接信息，包括驱动类、连接 URL、用户名和密码。
javaTypeResolver 标签用于配置 Java 类型解析器，这里设置 forceBigDecimals 属性为 false 表示不强制将所有的数值类型映射为 Java 的 BigDecimal 类型。
javaModelGenerator 标签用于配置生成的 DO 实体类存放路径。
sqlMapGenerator 标签用于配置生成的 Mapper XML 文件存放路径。
javaClientGenerator 标签用于配置生成的 Mapper 接口存放路径。
```
table
```
标签用于指定需要生成的表和对应的实体类。
- tableName 属性指定了数据库中的表名。
- domainObjectName 属性指定了生成的实体类的名称。
- enableCountByExample、enableUpdateByExample、enableDeleteByExample、enableSelectByExample 属性用于指定是否启用相关方法的生成。
- selectByExampleQueryId 属性用于指定是否生成查询方法的 ID。

配置完成后，正常会看到下面标注的链接爆红，光标移动到上面，按 ALT + 回车键 ，点击 Fetch external resource 将资源下载下来, 这个时候，刚才 pom.xml 文件中插件爆红情况就消失了

4. 生成 DO 实体类、Mapper 接口、XML 映射文件

点击右侧栏 mybatis-generator 插件的 generate 方法，开始生成：

在这里插入图片描述

若在控制台看到 BUILD SUCCESS 信息，则表示生成成功了

5. 稍许修改

通过此插件生成的 DO 实体类，是没有使用 Lombok 注解的

手动对 DO 实体类的代码修改一下，如下：

get、set 方法删除掉，添加上相关 Lombok 注解；
Date 日期类型，换成 LocalDateTime JDK 1.8 新的日期 API;
其他类型的适配等等, 看情况而定；

TIP : Mapper 接口和 XML 映射文件，则不需要做修改

@Data
@AllArgsConstructor
@NoArgsConstructor
@Builder
public class UserDO {
    
    

    private Long id;

    private String username;

    private LocalDateTime createTime;

    private LocalDateTime updateTime;
}

再来看看生成的 Mapper 接口代码，会自动添加一下常用的增删改查方法，大致如下：



import com.quanxiaoha.xiaohashu.auth.domain.dataobject.UserDO;

public interface UserDOMapper {
    
    

    int deleteByPrimaryKey(Long id);

    int insert(UserDO record);

    int insertSelective(UserDO record);

    UserDO selectByPrimaryKey(Long id);

    int updateByPrimaryKeySelective(UserDO record);

    int updateByPrimaryKey(UserDO record);
}