Mybatis官方生成器资料详解与实战教程

本文档详细介绍了Mybatis Generator这款开源工具的功能和优势，它能够自动生成Mybatis所需的持久层代码，提高开发效率并保证代码的一致性。文章不仅讲解了环境搭建、配置文件创建及常用参数说明，还提供了实战案例以加深理解。

什么是Mybatis官方生成器

Mybatis官方生成器（Mybatis Generator）是一个开源工具，用于根据数据库表自动生成Mybatis所需的所有持久层代码，包括Mapper接口、Mapper XML文件和实体类。这不仅提高了开发效率，还保证了代码的一致性和规范性。

Mybatis官方生成器的作用和优势

Mybatis官方生成器的主要作用是简化持久层开发。传统方式中，手动编写Mapper接口、Mapper XML文件和实体类会非常繁琐且容易出错。使用Mybatis Generator可以自动生成这些代码，减少开发者的重复劳动，提高开发效率。

• 提高开发效率：自动化生成持久层代码，省去了手动编写Mapper接口、Mapper XML文件和实体类的时间。
• 保证代码一致性：规范化的代码生成方式确保每个表的持久层代码都遵循相同的标准。
• 易于维护：当数据库表结构发生变化时，可以通过Mybatis Generator重新生成代码，简化了代码维护工作。
• 减少错误：通过工具自动生成代码，减少了人为的拼写错误或逻辑错误。

必要的软件环境

• JDK：需要安装JDK 1.8及以上版本。
• Maven：Mybatis Generator是基于Maven构建的，需要安装Maven 3.0及以上版本。
• 数据库：Mybatis Generator支持多种数据库，如MySQL、Oracle、DB2等，根据项目需求选择合适的数据库。

Maven项目的配置

为了使用Mybatis Generator，需要在Maven项目中添加相关依赖。以下是添加Mybatis Generator的Maven配置示例：

<dependencies>
    <dependency>
        <groupId>org.mybatis.generator</groupId>
        <artifactId>mybatis-generator-core</artifactId>
        <version>1.4.0</version>
    </dependency>
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
        <version>8.0.26</version>
    </dependency>
    <!-- 其他依赖 -->
</dependencies>

以上配置包括了Mybatis Generator的核心依赖和数据库驱动。根据实际项目需求，可能还需要添加其他相关依赖。

在pom.xml文件中，还需要配置Maven插件以支持Mybatis Generator：

<build>
    <plugins>
        <plugin>
            <groupId>org.mybatis.generator</groupId>
            <artifactId>mybatis-generator-maven-plugin</artifactId>
            <version>1.4.0</version>
            <configuration>
                <configurationFile>src/main/resources/mybatis-generator.xml</configurationFile>
                <overwrite>true</overwrite>
            </configuration>
            <dependencies>
                <dependency>
                    <groupId>mysql</groupId>
                    <artifactId>mysql-研发中心java-8.0.26</artifactId>
                    <version>8.0.26</version>
                </dependency>
            </dependencies>
        </plugin>
    </plugins>
</build>

上述配置中，configurationFile指定了Mybatis Generator配置文件的位置，overwrite表示覆盖原有文件。

安装和配置JDK、Maven和数据库

为了确保环境搭建顺利，以下是在Linux系统上安装和配置JDK、Maven和数据库的示例步骤：

1. 安装JDK：

   sudo apt update
   sudo apt install openjdk-11-jdk
   java -version

2. 安装Maven：

   sudo apt update
   sudo apt install maven
   mvn -v

3. 安装数据库（以MySQL为例）：

   sudo apt update
   sudo apt install mysql-server
   sudo mysql -u root -p

配置文件结构

Mybatis Generator的配置文件通常命名为mybatis-generator.xml，位于项目的resources目录下。配置文件的结构包括数据库连接信息、表映射规则、输出设置等。

以下是一个基本的配置文件示例：

<generatorConfiguration>
    <context id="DB2Tables" targetRuntime="MyBatis3">
        <commentGenerator>
            <property name="suppressAllComments" value="true"/>
        </commentGenerator>
        <classPathEntry override="false" path="lib/mysql-connector-java-8.0.26.jar"/>
        <jdbcConnection driverClass="com.mysql.cj.jdbc.Driver" connectionURL="jdbc:mysql://localhost:3306/test" userId="root" password="password"/>
        <javaModelGenerator targetPackage="com.example.model" targetProject="src/main/java"/>
        <sqlMapGenerator targetPackage="com.example.mapper" targetProject="src/main/resources"/>
        <javaClientGenerator type="XMLMAPPER" targetPackage="com.example.mapper" targetProject="src/main/java"/>
        <table tableName="user" domainObjectName="User" enableCountByExample="false" enableUpdateByExample="false" enableDeleteByExample="false" enableSelectByExample="false" selectByExampleQueryId="false"/>
    </context>
</generatorConfiguration>

常用配置参数说明

1. context: 定义生成器上下文，可以包含多个context。
2. commentGenerator: 配置生成器注释规则。例如，suppressAllComments设置为true表示不生成任何注释。
3. jdbcConnection: 配置数据库连接信息，包括驱动类、URL、用户名和密码。
4. javaModelGenerator: 生成Java实体类。targetPackage指定了实体类所在的包，targetProject指定了输出位置。
5. sqlMapGenerator: 生成Mapper XML文件。targetPackage指定了XML文件所在的包，targetProject指定了输出位置。
6. javaClientGenerator: 生成Mapper接口。type设置为XMLMAPPER表示生成XML方式的Mapper接口，targetPackage和targetProject同上。
7. table: 配置表映射规则。tableName指定了数据库表名，domainObjectName指定了实体类名。

自动生成Mapper接口

生成器会根据表名自动生成对应的Mapper接口。例如，对于表user，生成器会生成一个名为UserMapper的接口。

public interface UserMapper {
    // 自动生成的方法签名
}

自动生成Mapper XML文件

生成器会根据表名自动生成对应的Mapper XML文件。例如，对于表user，生成器会生成一个名为UserMapper.xml的文件。

<mapper namespace="com.example.mapper.UserMapper">
    <select id="selectByPrimaryKey" resultMap="BaseResultMap" parameterType="com.example.model.User">
        SELECT
        <include refid="SelectAllColumnsFromUser"/>
        FROM
        `user`
        WHERE
        `id` = #{id,jdbcType=INTEGER}
    </select>
    <!-- 自动生成的其他SQL语句 -->
</mapper>

自动生成实体类

生成器会根据表名自动生成对应的实体类。例如，对于表user，生成器会生成一个名为User的类。

public class User {
    private Integer id;
    private String name;
    private String email;

    // 自动生成的getter和setter方法
    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;
    }

    public String getEmail() {
        return email;
    }

    public void setEmail(String email) {
        this.email = email;
    }
}

配置不生效的常见原因

1. 配置文件路径错误：确保配置文件路径正确，且文件格式无误。
2. 数据库连接信息错误：检查数据库连接信息是否正确，包括驱动类、URL、用户名和密码。
3. Maven插件配置错误：检查Maven插件配置是否正确。
4. 插件版本不匹配：确保Mybatis Generator的版本与项目依赖版本兼容。

生成代码出现错误的解决方法

1. 检查表名：确保配置文件中的表名与数据库中的表名一致。
2. 检查字段名：确保配置文件中的字段名与数据库中的字段名一致。
3. 清理缓存：尝试清理Maven缓存，重新构建项目。
4. 日志查看：查看生成器的日志输出，定位具体错误信息。

具体解决示例

如果遇到配置文件路径错误的问题，可以通过以下步骤解决：

1. 检查mybatis-generator.xml文件路径：

   mvn mybatis-generator:generate -DgeneratorConfig=src/main/resources/mybatis-generator.xml

2. 检查pom.xml文件配置：

   <configuration>
       <configurationFile>src/main/resources/mybatis-generator.xml</configurationFile>
       <overwrite>true</overwrite>
   </configuration>

3. 运行命令生成代码：

   mvn mybatis-generator:generate

案例背景介绍

为了更好地理解Mybatis Generator的使用，我们假设一个简单的用户管理项目。该项目需要一个持久层来操作用户表，包括用户的增删改查操作。

详细操作步骤

1. 创建数据库表：首先在数据库中创建一个用户表user。

   CREATE TABLE `user` (
       `id` INT PRIMARY KEY AUTO_INCREMENT,
       `name` VARCHAR(50),
       `email` VARCHAR(100)
   );

2. 配置Mybatis Generator：在项目的resources目录下创建mybatis-generator.xml配置文件，配置数据库连接和表映射规则。

   <generatorConfiguration>
       <context id="DB2Tables" targetRuntime="MyBatis3">
           <commentGenerator>
               <property name="suppressAllComments" value="true"/>
           </commentGenerator>
           <jdbcConnection driverClass="com.mysql.cj.jdbc.Driver" connectionURL="jdbc:mysql://localhost:3306/test" userId="root" password="password"/>
           <javaModelGenerator targetPackage="com.example.model" targetProject="src/main/java"/>
           <sqlMapGenerator targetPackage="com.example.mapper" targetProject="src/main/resources"/>
           <javaClientGenerator type="XMLMAPPER" targetPackage="com.example.mapper" targetProject="src/main/java"/>
           <table tableName="user" domainObjectName="User" enableCountByExample="false" enableUpdateByExample="false" enableDeleteByExample="false" enableSelectByExample="false" selectByExampleQueryId="false"/>
       </context>
   </generatorConfiguration>

3. 运行生成器：在Maven项目中运行mvn mybatis-generator:generate命令，生成持久层代码。

   mvn mybatis-generator:generate

4. 检查生成的代码：生成器会根据配置生成对应的Mapper接口、Mapper XML文件和实体类。检查这些文件是否生成成功，确保代码结构符合预期。

5. 使用生成的持久层代码：在项目中引用生成的Mapper接口和实体类，进行用户数据的操作。

   public class UserService {
       private UserMapper userMapper;
   
       public void addUser(User user) {
           userMapper.insert(user);
       }
   
       public User getUserById(int id) {
           return userMapper.selectByPrimaryKey(id);
       }
   
       public List<User> getAllUsers() {
           return userMapper.selectAll();
       }
   
       public void updateUser(User user) {
           userMapper.updateByPrimaryKey(user);
       }
   
       public void deleteUser(int id) {
           userMapper.deleteByPrimaryKey(id);
       }
   }

通过以上步骤，可以快速搭建一个简单的用户管理项目，利用Mybatis Generator简化持久层开发。