SpringBoot集成MyMatis-Generator的使用方法

发布时间：2021-07-29 19:09:40 作者：chen
来源：亿速云阅读：289

SpringBoot集成MyBatis-Generator的使用方法

引言
MyBatis-Generator简介
SpringBoot集成MyBatis-Generator的准备工作
MyBatis-Generator配置文件详解
运行MyBatis-Generator生成代码
- 5.1 使用Maven插件运行
- 5.2 使用Java代码运行
生成的代码结构解析
自定义MyBatis-Generator生成代码
常见问题与解决方案
总结

引言

在现代Java开发中，SpringBoot和MyBatis是两个非常流行的框架。SpringBoot以其简洁的配置和快速的开发能力著称，而MyBatis则以其灵活的SQL映射和强大的ORM功能受到开发者的青睐。MyBatis-Generator是MyBatis官方提供的一个代码生成工具，它可以根据数据库表结构自动生成实体类、Mapper接口和XML映射文件，极大地提高了开发效率。

本文将详细介绍如何在SpringBoot项目中集成MyBatis-Generator，并通过实例演示如何使用MyBatis-Generator生成代码。同时，我们还将探讨如何自定义生成的代码，以及解决在使用过程中可能遇到的常见问题。

MyBatis-Generator简介

MyBatis-Generator（简称MBG）是MyBatis官方提供的一个代码生成工具，它可以根据数据库表结构自动生成实体类、Mapper接口和XML映射文件。MBG的主要功能包括：

生成与数据库表对应的实体类（POJO）。
生成与实体类对应的Mapper接口。
生成与Mapper接口对应的XML映射文件。

通过使用MBG，开发者可以避免手动编写大量的重复代码，从而将更多精力集中在业务逻辑的实现上。

SpringBoot集成MyBatis-Generator的准备工作

3.1 创建SpringBoot项目

首先，我们需要创建一个SpringBoot项目。可以使用Spring Initializr（https://start.spring.io/）快速生成一个SpringBoot项目。在创建项目时，选择以下依赖：

Spring Web
MyBatis Framework
MySQL Driver

3.2 添加MyBatis和MyBatis-Generator依赖

在创建好的SpringBoot项目中，打开pom.xml文件，添加MyBatis和MyBatis-Generator的依赖：

<dependencies>
    <!-- SpringBoot Starter Web -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>

    <!-- MyBatis SpringBoot Starter -->
    <dependency>
        <groupId>org.mybatis.spring.boot</groupId>
        <artifactId>mybatis-spring-boot-starter</artifactId>
        <version>2.2.0</version>
    </dependency>

    <!-- MySQL Driver -->
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
        <scope>runtime</scope>
    </dependency>

    <!-- MyBatis Generator -->
    <dependency>
        <groupId>org.mybatis.generator</groupId>
        <artifactId>mybatis-generator-core</artifactId>
        <version>1.4.0</version>
    </dependency>
</dependencies>

3.3 配置数据库连接

在application.properties文件中配置数据库连接信息：

spring.datasource.url=jdbc:mysql://localhost:3306/mybatis_generator_demo?useSSL=false&serverTimezone=UTC
spring.datasource.username=root
spring.datasource.password=123456
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver

MyBatis-Generator配置文件详解

4.1 generatorConfig.xml文件结构

MyBatis-Generator的配置文件通常命名为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="DB2Tables" targetRuntime="MyBatis3">
        <!-- 配置生成器 -->
        <!-- 配置表 -->
    </context>
</generatorConfiguration>

4.2 配置数据源

在generatorConfig.xml中配置数据源信息：

<context id="DB2Tables" targetRuntime="MyBatis3">
    <jdbcConnection driverClass="com.mysql.cj.jdbc.Driver"
                    connectionURL="jdbc:mysql://localhost:3306/mybatis_generator_demo?useSSL=false&serverTimezone=UTC"
                    userId="root"
                    password="123456">
    </jdbcConnection>
</context>

4.3 配置生成器

在generatorConfig.xml中配置生成器，指定生成的代码的包名和路径：

<context id="DB2Tables" targetRuntime="MyBatis3">
    <jdbcConnection driverClass="com.mysql.cj.jdbc.Driver"
                    connectionURL="jdbc:mysql://localhost:3306/mybatis_generator_demo?useSSL=false&serverTimezone=UTC"
                    userId="root"
                    password="123456">
    </jdbcConnection>

    <javaModelGenerator targetPackage="com.example.demo.model" targetProject="src/main/java">
        <property name="enableSubPackages" value="true"/>
        <property name="trimStrings" value="true"/>
    </javaModelGenerator>

    <sqlMapGenerator targetPackage="mapper" targetProject="src/main/resources">
        <property name="enableSubPackages" value="true"/>
    </sqlMapGenerator>

    <javaClientGenerator type="XMLMAPPER" targetPackage="com.example.demo.mapper" targetProject="src/main/java">
        <property name="enableSubPackages" value="true"/>
    </javaClientGenerator>
</context>

4.4 配置表

在generatorConfig.xml中配置需要生成代码的表：

<context id="DB2Tables" targetRuntime="MyBatis3">
    <jdbcConnection driverClass="com.mysql.cj.jdbc.Driver"
                    connectionURL="jdbc:mysql://localhost:3306/mybatis_generator_demo?useSSL=false&serverTimezone=UTC"
                    userId="root"
                    password="123456">
    </jdbcConnection>

    <javaModelGenerator targetPackage="com.example.demo.model" targetProject="src/main/java">
        <property name="enableSubPackages" value="true"/>
        <property name="trimStrings" value="true"/>
    </javaModelGenerator>

    <sqlMapGenerator targetPackage="mapper" targetProject="src/main/resources">
        <property name="enableSubPackages" value="true"/>
    </sqlMapGenerator>

    <javaClientGenerator type="XMLMAPPER" targetPackage="com.example.demo.mapper" targetProject="src/main/java">
        <property name="enableSubPackages" value="true"/>
    </javaClientGenerator>

    <table tableName="user" domainObjectName="User"/>
</context>

运行MyBatis-Generator生成代码

5.1 使用Maven插件运行

在pom.xml中添加MyBatis-Generator的Maven插件配置：

<build>
    <plugins>
        <plugin>
            <groupId>org.mybatis.generator</groupId>
            <artifactId>mybatis-generator-maven-plugin</artifactId>
            <version>1.4.0</version>
            <configuration>
                <configurationFile>src/main/resources/generatorConfig.xml</configurationFile>
                <overwrite>true</overwrite>
                <verbose>true</verbose>
            </configuration>
            <dependencies>
                <dependency>
                    <groupId>mysql</groupId>
                    <artifactId>mysql-connector-java</artifactId>
                    <version>8.0.23</version>
                </dependency>
            </dependencies>
        </plugin>
    </plugins>
</build>

然后，在命令行中运行以下命令生成代码：

mvn mybatis-generator:generate

5.2 使用Java代码运行

除了使用Maven插件，还可以通过Java代码运行MyBatis-Generator。首先，创建一个Java类：

import org.mybatis.generator.api.ShellRunner;

public class MyBatisGenerator {
    public static void main(String[] args) {
        String config = MyBatisGenerator.class.getClassLoader().getResource("generatorConfig.xml").getFile();
        String[] arg = {"-configfile", config, "-overwrite"};
        ShellRunner.main(arg);
    }
}

然后，运行这个Java类即可生成代码。

生成的代码结构解析

6.1 实体类

MyBatis-Generator会根据数据库表生成对应的实体类。例如，对于user表，生成的实体类如下：

package com.example.demo.model;

public class User {
    private Integer id;
    private String username;
    private String password;

    // Getters and Setters
}

6.2 Mapper接口

MyBatis-Generator会生成与实体类对应的Mapper接口。例如，对于User实体类，生成的Mapper接口如下：

package com.example.demo.mapper;

import com.example.demo.model.User;

public interface UserMapper {
    int deleteByPrimaryKey(Integer id);
    int insert(User record);
    User selectByPrimaryKey(Integer id);
    int updateByPrimaryKey(User record);
}

6.3 XML映射文件

MyBatis-Generator会生成与Mapper接口对应的XML映射文件。例如，对于UserMapper接口，生成的XML映射文件如下：

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper
  PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
  "http://mybatis.org/dtd/mybatis-3-mapper.dtd">

<mapper namespace="com.example.demo.mapper.UserMapper">
  <resultMap id="BaseResultMap" type="com.example.demo.model.User">
    <id column="id" jdbcType="INTEGER" property="id" />
    <result column="username" jdbcType="VARCHAR" property="username" />
    <result column="password" jdbcType="VARCHAR" property="password" />
  </resultMap>

  <sql id="Base_Column_List">
    id, username, password
  </sql>

  <select id="selectByPrimaryKey" parameterType="java.lang.Integer" resultMap="BaseResultMap">
    select 
    <include refid="Base_Column_List" />
    from user
    where id = #{id,jdbcType=INTEGER}
  </select>

  <delete id="deleteByPrimaryKey" parameterType="java.lang.Integer">
    delete from user
    where id = #{id,jdbcType=INTEGER}
  </delete>

  <insert id="insert" parameterType="com.example.demo.model.User">
    insert into user (id, username, password)
    values (#{id,jdbcType=INTEGER}, #{username,jdbcType=VARCHAR}, #{password,jdbcType=VARCHAR})
  </insert>

  <update id="updateByPrimaryKey" parameterType="com.example.demo.model.User">
    update user
    set username = #{username,jdbcType=VARCHAR},
      password = #{password,jdbcType=VARCHAR}
    where id = #{id,jdbcType=INTEGER}
  </update>
</mapper>

自定义MyBatis-Generator生成代码

7.1 自定义实体类

可以通过在generatorConfig.xml中配置javaModelGenerator的property来自定义实体类。例如，可以为实体类添加toString方法：

<javaModelGenerator targetPackage="com.example.demo.model" targetProject="src/main/java">
    <property name="enableSubPackages" value="true"/>
    <property name="trimStrings" value="true"/>
    <property name="rootClass" value="com.example.demo.model.BaseEntity"/>
</javaModelGenerator>

7.2 自定义Mapper接口

可以通过在generatorConfig.xml中配置javaClientGenerator的property来自定义Mapper接口。例如，可以为Mapper接口添加自定义方法：

<javaClientGenerator type="XMLMAPPER" targetPackage="com.example.demo.mapper" targetProject="src/main/java">
    <property name="enableSubPackages" value="true"/>
    <property name="rootInterface" value="com.example.demo.mapper.BaseMapper"/>
</javaClientGenerator>

7.3 自定义XML映射文件

可以通过在generatorConfig.xml中配置sqlMapGenerator的property来自定义XML映射文件。例如，可以为XML映射文件添加自定义SQL语句：

<sqlMapGenerator targetPackage="mapper" targetProject="src/main/resources">
    <property name="enableSubPackages" value="true"/>
    <property name="rootClass" value="com.example.demo.mapper.BaseMapper"/>
</sqlMapGenerator>

常见问题与解决方案

8.1 生成代码时出现错误

如果在生成代码时出现错误，首先检查generatorConfig.xml文件中的配置是否正确，特别是数据源配置和表名配置。如果配置正确，可以尝试清理项目并重新生成代码。

8.2 生成的代码不符合预期

如果生成的代码不符合预期，可以检查generatorConfig.xml文件中的配置，特别是javaModelGenerator、sqlMapGenerator和javaClientGenerator的配置。还可以通过自定义插件来进一步控制生成的代码。

8.3 数据库表结构变化后如何重新生成代码

如果数据库表结构发生变化，可以重新运行MyBatis-Generator生成代码。在重新生成代码之前，建议备份原有的代码，以免覆盖自定义的代码。

总结

本文详细介绍了如何在SpringBoot项目中集成MyBatis-Generator，并通过实例演示了如何使用MyBatis-Generator生成代码。通过使用MyBatis-Generator，开发者可以极大地提高开发效率，避免手动编写大量的重复代码。同时，本文还探讨了如何自定义生成的代码，以及解决在使用过程中可能遇到的常见问题。希望本文能帮助读者更好地理解和使用MyBatis-Generator。