springboot集成mybatis官方生成器

下面我会详细讲解“Spring Boot 集成 MyBatis 官方生成器”的完整攻略。

简介

在使用 MyBatis 进行开发时，为了提高开发效率、减少重复的代码编写，可以使用 MyBatis 官方生成器。而 Spring Boot 是一种优秀的 Java Web 开发框架，本文将会介绍如何在 Spring Boot 框架中集成 MyBatis 官方生成器。

步骤

以下是 Spring Boot 集成 MyBatis 官方生成器的步骤：

1. 首先需要在 pom.xml 文件中引入 MyBatis 和 MyBatis 官方生成器的依赖：

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

<!-- MyBatis 官方生成器 -->
<dependency>
    <groupId>org.mybatis.generator</groupId>
    <artifactId>mybatis-generator-core</artifactId>
    <version>1.4.0</version>
</dependency>

1. 然后需要在项目中配置 MyBatis 和 MyBatis 官方生成器的相关信息，可以在 application.yml 或 application.properties 文件中添加以下配置：

mybatis:
  # mapper接口包名
  mapper-locations: classpath*:mapper/*.xml
  # 实体类包名
  type-aliases-package: cn.xxxx.data.pojo
  # 配置MyBatis官方生成器的配置文件
  configuration:
    map-underscore-to-camel-case: true
    jdbc-type-for-null: NULL
    default-fetch-size: 100
    default-statement-timeout: 30
    use-generated-keys: true
    generate-key-before-insert: true
    # MyBatis官方生成器配置文件路径
    # 具体内容可以参考官方文档进行配置
    # 这里使用config文件夹下的generatorConfig.xml
    mappper-config-location: classpath:config/generatorConfig.xml

1. 配置完成后，需要创建 MyBatis 官方生成器的配置文件 generatorConfig.xml 并将其放置在 classpath 路径下的 config 文件夹中。配置文件可以如下所示：

<?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>
    <!-- 配置数据库驱动 -->
    <classPathEntry
            location="D:\Program Files\Java\jdk1.8.0_261\jre\lib\ext\mysql-connector-java-8.0.21.jar" />
    <!-- 配置映射信息 -->
    <context id="DB2Tables" targetRuntime="MyBatis3">
        <!-- 配置数据库连接 -->
        <jdbcConnection driverClass="com.mysql.cj.jdbc.Driver"
                        connectionURL="jdbc:mysql://localhost:3306/springboot?useSSL=false&amp;autoReconnect=true&amp;zeroDateTimeBehavior=convertToNull&amp;characterEncoding=utf8"
                        userId="root" password="123456">
        </jdbcConnection>
        <!-- 配置实体类生成规则 -->
        <javaModelGenerator targetPackage="cn.xxxx.data.pojo" targetProject="src/main/java">
            <property name="enableSubPackages" value="true"/>
            <property name="trimStrings" value="true"/>
        </javaModelGenerator>
        <!-- 配置Mapper接口生成规则 -->
        <sqlMapGenerator targetPackage="mapper" targetProject="src/main/resources">
            <property name="enableSubPackages" value="true"/>
        </sqlMapGenerator>
        <!-- 配置Mapper XML文件生成规则 -->
        <javaClientGenerator targetPackage="cn.xxxx.data.mapper" targetProject="src/main/java" type="XMLMAPPER">
            <property name="enableSubPackages" value="true"/>
        </javaClientGenerator>
        <!-- 配置表信息 -->
        <table schema="springboot"
               tableName="user"
               domainObjectName="UserDO"
               mapperName="UserMapper"
        />
    </context>
</generatorConfiguration>

其中，需要配置相应的数据库、实体类、Mapper 接口和 Mapper XML 文件的生成规则。上面的示例中只是一个简单的示例，可根据自己的需要进行修改。

1. 最后在 IDEA 的 Maven Projects 栏目中，选择 Plugins -> mybatis-generator -> mybatis-generator:generate 来运行 MyBatis 官方生成器。

2. 运行完成后，可以在指定的包中看到生成的实体类、Mapper 接口和 Mapper XML 文件。此时就可以在项目中调用这些类和接口，使用 MyBatis 进行数据库操作了。

示例代码：

@RestController
@RequestMapping("/user")
public class UserController {
    @Autowired
    private UserMapper userMapper;

    @GetMapping("/list")
    public List<UserDO> getUserList() {
        return userMapper.getUserList();
    }
}

<?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 XML文件 -->
<mapper namespace="cn.xxxx.data.mapper.UserMapper">
    <resultMap id="BaseResultMap" type="cn.xxxx.data.pojo.UserDO">
        <id column="id" property="id" jdbcType="BIGINT"/>
        <result column="name" property="name" jdbcType="VARCHAR"/>
        <result column="age" property="age" jdbcType="INTEGER"/>
    </resultMap>
    <select id="getUserList" resultMap="BaseResultMap">
        select * from user
    </select>
</mapper>

总结

使用 MyBatis 官方生成器可以帮助开发者快速生成实体类、Mapper 接口和 Mapper XML 文件，在开发过程中提高效率、减少重复的代码编写。在 Spring Boot 框架中集成 MyBatis 官方生成器，需要在 pom.xml 文件中引入相关的依赖，并进行一些配置。希望本文能够帮助开发者更好地使用 MyBatis 官方生成器。