IDEA Maven Mybatis generator 自动生成代码(实例讲解)

下面是详细讲解“IDEA Maven Mybatis generator 自动生成代码(实例讲解)”的完整攻略。

简介

Maven Mybatis generator 是一种可以帮助开发者自动生成 Mybatis 相关代码的工具。它可以根据数据库表的结构，自动生成实体类、Mapper 接口以及 XML Mapper 文件，大大提高了代码编写的效率。

本攻略将会介绍如何使用 IDEA 和 Maven 集成 Mybatis generator 并生成相关模板代码。

步骤

配置 pom.xml 文件

在 pom.xml 文件中添加 Mybatis generator 相关依赖：

<dependencies>
  <!-- Mybatis -->
  <dependency>
    <groupId>org.mybatis</groupId>
    <artifactId>mybatis</artifactId>
    <version>3.5.7</version>
  </dependency>

  <!-- Mybatis generator -->
  <dependency>
    <groupId>org.mybatis.generator</groupId>
    <artifactId>mybatis-generator-core</artifactId>
    <version>1.4.0</version>
  </dependency>

  <!-- Mysql 驱动 -->
  <dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
    <version>8.0.23</version>
  </dependency>
</dependencies>

<build>
  <plugins>
    <!-- Mybatis generator 插件 -->
    <plugin>
      <groupId>org.mybatis.generator</groupId>
      <artifactId>mybatis-generator-maven-plugin</artifactId>
      <version>1.4.0</version>
      <dependencies>
        <dependency>
          <groupId>mysql</groupId>
          <artifactId>mysql-connector-java</artifactId>
          <version>8.0.23</version>
        </dependency>
      </dependencies>
    </plugin>
  </plugins>
</build>

其中，org.mybatis.generator:mybatis-generator-core 是 Mybatis generator 的核心依赖。

配置 generatorConfig.xml 文件

在 src/main/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="mysql" targetRuntime="MyBatis3">
    <jdbcConnection driverClass="com.mysql.jdbc.Driver"
      connectionURL="jdbc:mysql://localhost:3306/test?useUnicode=true&amp;characterEncoding=UTF-8&amp;useSSL=false"
      userId="root" password="root">
    </jdbcConnection>

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

    <sqlMapGenerator targetPackage="com.example.demo.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>
</generatorConfiguration>

其中，主要配置了以下内容：

• jdbcConnection：数据库连接信息；
• javaModelGenerator：生成实体类的相关信息；
• sqlMapGenerator：生成 XML Mapper 文件的相关信息；
• javaClientGenerator：生成 Mapper 接口的相关信息；
• table：指定需要生成代码的表名和对应的实体类名称。

在这里，我们生成了一个名为 user 的表的实体类、Mapper 接口和 XML Mapper 文件。

运行 Maven 命令自动生成代码

在 IDEA 中打开 Maven 工具窗口（View -> Tool Windows -> Maven），找到 mybatis-generator 插件的官方命令 mybatis-generator:generate。双击该命令并等待自动化代码生成完成。

另外，也可以通过命令行使用 mvn mybatis-generator:generate 命令来手动运行。

示例一：生成 user 对应的实体类

自动生成的实体类代码：

package com.example.demo.model;

public class User {
    private Integer id;

    private String name;

    private Integer age;

    public Integer getId() {
        return id;
    }

    public void setId(Integer id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name == null ? null : name.trim();
    }

    public Integer getAge() {
        return age;
    }

    public void setAge(Integer age) {
        this.age = age;
    }
}

示例二：生成 user 对应的 Mapper 接口和 XML Mapper 文件

自动生成的 Mapper 接口代码：

package com.example.demo.mapper;

import com.example.demo.model.User;
import com.example.demo.model.UserExample;
import java.util.List;
import org.apache.ibatis.annotations.Param;

public interface UserMapper {
    long countByExample(UserExample example);

    int deleteByExample(UserExample example);

    int deleteByPrimaryKey(Integer id);

    int insert(User record);

    int insertSelective(User record);

    List<User> selectByExample(UserExample example);

    User selectByPrimaryKey(Integer id);

    int updateByExampleSelective(@Param("record") User record, @Param("example") UserExample example);

    int updateByExample(@Param("record") User record, @Param("example") UserExample example);

    int updateByPrimaryKeySelective(User record);

    int updateByPrimaryKey(User record);
}

自动生成的 XML Mapper 文件代码：

<?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">

  <!--
    WARNING - @mbg.generated
    This element is automatically generated by MyBatis Generator, do not modify.
    This element was generated on Mar 29, 2021 at 9:07:50 PM GMT+08:00
  -->
  <resultMap id="BaseResultMap" type="com.example.demo.model.User">
    <id column="id" jdbcType="INTEGER" property="id" />
    <result column="name" jdbcType="VARCHAR" property="name" />
    <result column="age" jdbcType="INTEGER" property="age" />
  </resultMap>

  <!--
    WARNING - @mbg.generated
    This element is automatically generated by MyBatis Generator, do not modify.
    This element was generated on Mar 29, 2021 at 9:07:50 PM GMT+08:00
  -->
  <sql id="Base_Column_List">
    id, name, age
  </sql>

  <select id="selectByExample" resultMap="BaseResultMap" parameterType="com.example.demo.model.UserExample">
    select
    <include refid="Base_Column_List" />
    from user
    <if test="_parameter != null">
      <include refid="Example_Where_Clause" />
    </if>
    <if test="orderByClause != null">
      order by ${orderByClause}
    </if>
  </select>

  <!-- 省略其他自动生成的 SQL 语句 -->

</mapper>

总结

通过使用 Maven Mybatis generator 自动化生成代码，可以大大提高项目开发的效率。以上是整个过程的详细讲解，希望对您有所帮助。