Mybatis官方生成器学习：快速入门指南

Mybatis生成器（Mybatis Generator）是一个强大的代码生成工具，能够自动生成与数据库相关的Java实体类、Mapper接口、SQL映射文件等。它通过提高开发效率、减少错误、保持代码一致性以及易于维护和扩展等优势，极大地方便了开发人员的工作。本文将详细介绍Mybatis官方生成器的学习内容，包括安装与环境配置、基本配置、代码生成以及自定义规则等步骤。此外，还将展示如何通过配置文件自定义生成规则以及如何修改模板文件以适应项目需求。

Mybatis生成器的作用和优势

Mybatis生成器（Mybatis Generator）是一个基于Mybatis的代码生成工具，它能够自动生成与数据库相关的Java实体类、Mapper接口、SQL映射文件等。Mybatis生成器的优势在于：

1. 提高开发效率： 通过自动化生成代码，节省了开发人员的时间和精力，可以更快地投入到业务逻辑的实现中。
2. 减少错误： 自动生成的代码通常经过测试和验证，减少了手动编写代码时可能出现的错误。
3. 保持一致性： 自动生成的代码遵循统一的编码规范，保持了一致性，使代码更加规范。
4. 易于维护： 当数据库结构发生变化时，可以方便地通过Mybatis生成器重新生成代码，而不需要手动修改大量的代码。
5. 易于扩展： Mybatis生成器支持自定义模板和插件，可以根据项目需求灵活扩展。

Mybatis生成器的基本概念

Mybatis生成器主要由以下几个部分组成：

1. XML配置文件： 用于配置生成器的基本设置，包括数据库连接信息、需要生成的表、生成的代码的输出路径等。
2. 模板文件： 模板文件定义了生成器生成的代码的结构和格式，支持自定义。
3. 插件： 插件可以扩展Mybatis生成器的功能，例如生成注解、添加特定的处理逻辑等。
4. 生成器执行流程： Mybatis生成器读取配置文件，解析数据库元数据，根据模板文件生成相应的代码。

搭建开发环境

为了能够使用Mybatis生成器，首先需要搭建Java开发环境，配置Maven作为项目构建工具。以下是搭建开发环境的步骤：

1. 安装JDK： 确保Java Development Kit（JDK）已安装。
2. 安装Maven： 从Maven官方网站下载并安装Maven。
3. 配置环境变量： 将Maven的bin目录添加到系统的PATH环境变量中。
4. 创建Maven项目： 使用IDE（如IntelliJ IDEA或Eclipse）创建一个新的Maven项目。

示例：创建Maven项目并添加依赖

<dependencies>
    <dependency>
        <groupId>org.mybatis.generator</groupId>
        <artifactId>mybatis-generator-core</artifactId>
        <version>1.3.7</version>
    </dependency>
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
        <version>8.0.23</version>
    </dependency>
    <dependency>
        <groupId>org.mybatis</groupId>
        <artifactId>mybatis</artifactId>
        <version>3.5.6</version>
    </dependency>
    <dependency>
        <groupId>org.mybatis</groupId>
        <artifactId>mybatis-spring</artifactId>
        <version>2.0.6</version>
    </dependency>
</dependencies>

上述代码中，mybatis-generator-core是Mybatis生成器的核心库，mysql-connector-java是MySQL连接驱动，mybatis和mybatis-spring是Mybatis相关的库。

配置XML文件详解

Mybatis生成器的配置文件通常是一个XML文件，其名称为generatorConfig.xml。该文件定义了生成器的所有配置，包括数据库连接信息、需要生成的表、生成的代码的输出路径等。以下是一个基本的配置文件示例：

<generatorConfiguration>
    <context id="DB2Tables" targetRuntime="MyBatis3">
        <commentGenerator>
            <property name="suppressDate" value="true"/>
        </commentGenerator>
        <classPathEntry location="path/to/mysql-connector-java.jar"/>
        <jdbcConnection driverClass="com.mysql.cj.jdbc.Driver"
                        connectionURL="jdbc:mysql://localhost:3306/mydatabase"
                        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="users" domainObjectName="User" enableCountByExample="false"
               enableUpdateByExample="false" enableDeleteByExample="false"
               enableSelectByExample="false" selectByExampleQueryId="false">
            <columnOverride column="id" jdbcType="INTEGER" javaType="Long"/>
        </table>
    </context>
</generatorConfiguration>

该配置文件中的各个标签含义如下：

• <context>：定义了一个生成器的上下文，可以包含多个上下文。
• <commentGenerator>：配置生成器生成注释的规则，suppressDate属性控制是否生成日期注释。
• <classPathEntry>：配置类路径，指定数据库驱动类的位置。
• <jdbcConnection>：配置数据库连接信息，包括驱动类、连接URL、用户名和密码。
• <javaModelGenerator>：配置Java模型类的生成，包括输出的包名和输出的目录。
• <sqlMapGenerator>：配置SQL映射文件的生成，包括输出的包名和输出的目录。
• <javaClientGenerator>：配置Mapper接口及其实现类的生成，包括输出的类型、包名和输出的目录。
• <table>：配置需要生成的数据库表，包括表名、生成的Java类名等。

模板配置和插件配置

Mybatis生成器支持使用自定义模板来生成代码，可以通过在generatorConfig.xml文件中配置模板路径来实现。模板文件通常放在src/main/resources目录下，文件名为templates。以下是一个模板文件配置示例：

<property name="fileOverwrite" value="true"/>
<property name="enableSubPackages" value="true"/>
<property name="targetProject" value="src/main/java"/>
<property name="targetPackage" value="com.example.mapper"/>
<property name="fileEncoding" value="UTF-8"/>
<property name="overwrite" value="true"/>
<property name="configurationFile" value="src/main/resources/generatorConfig.xml"/>

插件配置也可以在generatorConfig.xml文件中进行。插件通过<plugin>标签配置，可以扩展Mybatis生成器的功能。以下是一个插件的配置示例：

<plugin type="org.mybatis.generator.plugins.RowBoundsPlugin"/>

RowBoundsPlugin插件提供了对分页的支持。

生成Mapper接口和实现类

Mybatis生成器可以根据配置生成Mapper接口和实现类。通过<javaClientGenerator>标签来配置Mapper接口及其实现类的生成。以下是一个生成Mapper接口的示例：

<javaClientGenerator type="XMLMAPPER" targetPackage="com.example.mapper" targetProject="src/main/java"/>

该配置指定了生成的Mapper接口的包名和输出目录。

生成SQL映射文件

SQL映射文件定义了Mybatis的SQL语句，通过<sqlMapGenerator>标签来配置SQL映射文件的生成。以下是一个生成SQL映射文件的示例：

<sqlMapGenerator targetPackage="com.example.mapper" targetProject="src/main/resources"/>

该配置指定了生成的SQL映射文件的包名和输出目录。

修改模板文件以适应项目需求

模板文件定义了生成器生成代码的格式。通过修改模板文件，可以生成符合项目需求的代码。模板文件通常位于src/main/resources/templates目录下。以下是一个自定义模板文件的示例：

<template file="CustomMapperTemplate.xml" type="XMLMAPPER" targetPackage="com.example.mapper" targetProject="src/main/java"/>

该配置指定了使用自定义模板文件生成Mapper接口。

通过配置文件自定义生成规则

在generatorConfig.xml文件中，可以通过配置文件属性来自定义生成规则。例如，可以通过<property>标签指定生成器的行为。以下是一个配置示例：

<property name="enableSubPackages" value="true"/>
<property name="fileOverwrite" value="true"/>
<property name="fileEncoding" value="UTF-8"/>

这些配置分别控制了生成代码的包结构、是否覆盖已有文件和文件编码格式。

常见错误及解决方法

在使用Mybatis生成器时，可能会遇到一些常见的错误，以下是一些常见的错误及解决方法：

1. 数据库连接失败： 检查数据库连接URL、用户名和密码是否正确。
2. 模板文件不存在： 确保模板文件的路径和文件名正确。
3. 代码生成失败： 检查配置文件中的包名和输出目录是否正确。
4. 插件加载失败： 检查插件类的完整路径是否正确。

调试生成器配置

调试生成器配置可以通过以下步骤进行：

1. 查看日志输出： Mybatis生成器提供了详细的日志输出，可以通过查看日志文件来定位问题。
2. 逐个修改配置： 逐一修改配置文件中的参数，观察生成结果的变化。
3. 手动测试： 手动测试数据库连接是否成功，确保数据库表结构正确。

通过上述步骤，可以有效地调试并解决生成器配置中的问题。

示例项目搭建

假设需要生成一个用户表的Mapper接口、实现类以及SQL映射文件，以下是具体步骤：

1. 创建表结构： 在数据库中创建一个用户表users，包含字段id、username和password。

CREATE TABLE users (
    id INT AUTO_INCREMENT PRIMARY KEY,
    username VARCHAR(50) NOT NULL UNIQUE,
    password VARCHAR(255) NOT NULL
);

1. 配置生成器： 编辑generatorConfig.xml文件，配置数据库连接和生成规则。

<generatorConfiguration>
    <context id="DB2Tables" targetRuntime="MyBatis3">
        <commentGenerator>
            <property name="suppressDate" value="true"/>
        </commentGenerator>
        <jdbcConnection driverClass="com.mysql.cj.jdbc.Driver"
                        connectionURL="jdbc:mysql://localhost:3306/mydatabase"
                        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="users" domainObjectName="User">
            <columnOverride column="id" jdbcType="INTEGER" javaType="Long"/>
        </table>
    </context>
</generatorConfiguration>

1. 运行生成器： 在Maven项目中运行生成器命令，生成代码。

mvn mybatis-generator:generate

1. 检查生成的代码： 检查生成的Mapper接口、实现类和SQL映射文件是否符合预期。

示例代码

以下是生成的代码示例：

User.java (实体类)

package com.example.model;

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

    public Long getId() {
        return id;
    }

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

    public String getUsername() {
        return username;
    }

    public void setUsername(String username) {
        this.username = username;
    }

    public String getPassword() {
        return password;
    }

    public void setPassword(String password) {
        this.password = password;
    }
}

UserMapper.java (Mapper接口)

package com.example.mapper;

import com.example.model.User;
import java.util.List;

public interface UserMapper {
    int insert(User record);

    int insertSelective(User record);

    User selectByPrimaryKey(Long id);

    int updateByPrimaryKeySelective(User record);

    int updateByPrimaryKey(User record);
}

UserMapper.xml (SQL映射文件)

<?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.mapper.UserMapper">
    <resultMap id="BaseResultMap" type="com.example.model.User">
        <id column="id" jdbcType="INTEGER" property="id" />
        <result column="username" jdbcType="VARCHAR" property="username" />
        <result column="password" jdbcType="VARCHAR" property="password" />
    </resultMap>
    <select id="selectByPrimaryKey" resultMap="BaseResultMap" parameterType="java.lang.Long">
        SELECT
            id,
            username,
            password
        FROM users
        WHERE id = #{id,jdbcType=INTEGER}
    </select>
    <insert id="insert" parameterType="com.example.model.User" useGeneratedKeys="true" keyProperty="id" keyColumn="id">
        INSERT INTO users (username, password)
        VALUES (#{username,jdbcType=VARCHAR}, #{password,jdbcType=VARCHAR})
    </insert>
    <update id="updateByPrimaryKey" parameterType="com.example.model.User">
        UPDATE users
        SET username = #{username,jdbcType=VARCHAR},
            password = #{password,jdbcType=VARCHAR}
        WHERE id = #{id,jdbcType=INTEGER}
    </update>
</mapper>

通过上述示例，可以清晰地看到Mybatis生成器如何自动生成实体类、Mapper接口、SQL映射文件，并且每个生成的文件都符合预期的格式和结构。

通过本文的学习，您应该已经掌握了如何使用Mybatis生成器自动生成Mybatis所需的代码。从搭建开发环境到安装Mybatis生成器，再到配置生成器生成Java代码和SQL映射文件，以及自定义生成规则和调试配置，每一个步骤都详细介绍了操作方法。希望本文能帮助您更加高效地使用Mybatis生成器进行开发。如果在实际操作中遇到问题，参考本文提供的常见问题解决方法和调试方法，可以帮助您快速定位和解决问题。