Mybatis官方生成器资料详解与入门教程

本文详细介绍了Mybatis官方生成器（Mybatis Generator）的功能、作用、安装与集成方法，以及详细的配置和使用指南。通过实战案例，展示了从配置到生成代码的全过程，并讨论了高级配置选项和常见问题的解决方法。读者将全面了解并掌握Mybatis官方生成器的使用。

Mybatis官方生成器（Mybatis Generator）是一个强大的工具，用于生成Mybatis的映射文件（XML）以及Java实体类和Mapper接口。它的主要作用是简化开发流程，提高开发效率，降低手动编写这些文件的复杂度。

Mybatis官方生成器的作用

Mybatis官方生成器的核心功能包括：

1. 生成映射文件：根据数据库中的表自动生成Mybatis的XML映射文件，包括SQL语句、结果映射等配置。
2. 生成实体类：根据数据库表结构，自动生成对应的Java实体类。
3. 生成Mapper接口：自动生成对应的Mapper接口，这些接口定义了对数据库表的操作方法。
4. 维护映射关系：在表结构变更时，自动更新映射文件和实体类。

通过使用Mybatis官方生成器，开发人员可以省去大量手动编写和维护这些文件的繁琐工作，从而将更多精力集中在业务逻辑的实现上。

安装与环境准备

要使用Mybatis官方生成器，你需要有一些基本的环境准备：

1. JDK：Mybatis官方生成器运行在Java虚拟机上，因此需要安装JDK。确保你的JDK版本符合Mybatis官方生成器的兼容要求。
2. Maven：Mybatis官方生成器通常通过Maven插件来集成到项目中。确保你已经安装了Maven。
3. 数据库：需要一个数据库实例，如MySQL、Oracle等，以便生成器能够连接并读取数据库中的表结构信息。

如何下载并集成Mybatis官方生成器

要集成Mybatis官方生成器到项目中，可以通过Maven引入相关依赖。在项目的pom.xml文件中，添加以下依赖：

<dependencies>
    <dependency>
        <groupId>org.mybatis.generator</groupId>
       .
.
.
<dependencies>

此外，还需要配置Maven的构建插件（build plugin），以支持Mybatis Generator插件的运行。在pom.xml文件中的build标签内添加以下内容：

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

这里配置的插件版本可以根据官方文档选择其他版本，但确保与Mybatis Generator的核心版本兼容。configurationFile属性指向配置文件的具体路径。

在配置Mybatis官方生成器时，一个关键步骤是编写配置文件。配置文件通常以generatorConfig.xml的形式存在，它包含了所有必要的配置信息。

配置文件详解

generatorConfig.xml文件是配置Mybatis Generator的核心文件，它定义了生成器的行为和输出结果。下面是一份基本的配置文件示例：

<generatorConfiguration>
    <context id="testContext" targetRuntime="MyBatis3">
        <commentGenerator>
            <property name="suppressAllComments" value="true"/>
        </commentGenerator>

        <jdbcConnection driverClass="com.mysql.cj.jdbc.Driver"
                        connectionURL="jdbc:mysql://localhost:3306/dbname"
                        userId="root"
                        password="password">
        </jdbcConnection>

        <javaTypeResolver>
            <property name="unambiguousTypeMapping" value="true"/>
        </javaTypeResolver>

        <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="test_table" domainObjectName="TestTable" enableCountByExample="false" enableUpdateByExample="false" enableDeleteByExample="false" enableSelectByExample="false" selectByExampleQueryId="false"/>
    </context>
</generatorConfiguration>

如何配置数据库连接

在配置文件中，jdbcConnection标签用于指定数据库连接信息：

<jdbcConnection driverClass="com.mysql.cj.jdbc.Driver"
                connectionURL="jdbc:mysql://localhost:3306/dbname"
                userId="root"
                password="password">
</jdbcConnection>

这里需要填写具体的数据库驱动类名、连接URL、数据库用户名和密码。确保这些信息与你的数据库实际情况匹配。

实体类与Mapper接口生成规则

配置文件的其他标签定义了生成器的行为：

• javaModelGenerator：生成实体类的位置和包名。
• sqlMapGenerator：生成SQL映射文件的位置和包名。
• javaClientGenerator：生成Mapper接口的位置和包名。

例如：

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

这些标签定义了生成的文件将放置于指定的项目目录中，并使用指定的包名。

使用Mybatis官方生成器生成代码，需要编写配置文件并在项目中进行调用。以下是具体步骤：

如何启动生成器生成代码

在配置好generatorConfig.xml文件后，可以通过Maven命令来启动生成器生成代码。在命令行中，使用以下命令：

mvn mybatis-generator:generate

这将解析配置文件并根据配置生成相应的Java文件。

自定义生成的代码

可以通过修改配置文件来自定义生成的代码。例如，你可以调整生成的实体类的字段名、Mapper接口的方法名等。在配置文件中找到对应的标签进行调整：

<table tableName="test_table" domainObjectName="TestTable">
    <property name="useActualColumnNames" value="true"/>
</table>

这里配置了使用实际的字段名，而不是默认的驼峰命名。

常见问题解答

1. 如何解决生成器无法连接数据库的问题？
   确保数据库连接信息正确无误，包括驱动类名、连接URL、用户名和密码。

2. 生成的代码与数据库表结构不符怎么办？
   重新执行生成器，确保数据库表结构是最新的。如果仍然有问题，检查配置文件中的表名是否正确。

3. 如何生成更复杂的SQL语句？
   可以在配置文件中指定更复杂的SQL语句模板，例如使用example标签来定义查询示例。

生成器在项目中的应用

在实际项目中，Mybatis官方生成器可以帮助团队快速搭建基础的数据库访问层。例如，一个典型的电商项目可能需要对用户表、订单表等多个数据库表进行操作，通过Mybatis Generator可以快速生成对应的实体类和Mapper接口。

实战演示：从配置到代码生成全过程

假设我们有一个用户表users，结构如下：

CREATE TABLE users (
    id INT PRIMARY KEY,
    name VARCHAR(100),
    email VARCHAR(100),
    created_at TIMESTAMP
);

配置文件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.dtd">
<generatorConfiguration>
    <context id="testContext" targetRuntime="MyBatis3">
        <commentGenerator>
            <property name="suppressAllComments" value="true"/>
        </commentGenerator>

        <jdbcConnection driverClass="com.mysql.cj.jdbc.Driver"
                        connectionURL="jdbc:mysql://localhost:3306/mydb"
                        userId="root"
                        password="password">
        </jdbcConnection>

        <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"/>
    </context>
</generatorConfiguration>

执行Maven命令：

mvn mybatis-generator:generate

生成的代码如下：

实体类User.java

package com.example.model;

public class User {
    private int id;
    private String name;
    private String email;
    private java.sql.Timestamp createdAt;

    // Getters and Setters
}

Mapper接口UserMapper.java

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(Integer id);

    int updateByPrimaryKeySelective(User record);

    int updateByPrimaryKey(User record);
}

SQL映射文件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.mapper.UserMapper">
    <resultMap id="BaseResultMap" type="com.example.model.User">
        <id column="id" property="id" jdbcType="INTEGER"/>
        <result column="name" property="name" jdbcType="VARCHAR"/>
        <result column="email" property="email" jdbcType="VARCHAR"/>
        <result column="created_at" property="createdAt" jdbcType="TIMESTAMP"/>
    </resultMap>

    <sql id="Base_Column_List">
        id, name, email, created_at
    </sql>

    <insert id="insert" parameterType="com.example.model.User">
        insert into users (id, name, email, created_at)
        values (#{id,jdbcType=INTEGER}, #{name,jdbcType=VARCHAR}, #{email,jdbcType=VARCHAR}, #{createdAt,jdbcType=TIMESTAMP})
    </insert>

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

    <update id="updateByPrimaryKeySelective" parameterType="com.example.model.User">
        update users
        <set>
            <if test="name != null">
                name = #{name,jdbcType=VARCHAR},
            </if>
            <if test="email != null">
                email = #{email,jdbcType=VARCHAR},
            </if>
            <if test="createdAt != null">
                created_at = #{createdAt,jdbcType=TIMESTAMP},
            </if>
        </set>
        where id = #{id,jdbcType=INTEGER}
    </update>

    <update id="updateByPrimaryKey" parameterType="com.example.model.User">
        update users
        set name = #{name,jdbcType=VARCHAR},
            email = #{email,jdbcType=VARCHAR},
            created_at = #{createdAt,jdbcType=TIMESTAMP}
        where id = #{id,jdbcType=INTEGER}
    </update>
</mapper>

生成器与其他工具的结合使用

Mybatis官方生成器可以与其他工具结合使用，例如Spring Boot。在Spring Boot项目中，可以将生成的Mapper接口和映射文件直接集成到Spring的@Mapper注解中，简化数据库访问的配置。

例如，在Spring Boot项目中，可以通过@Mapper注解自动扫描并配置生成的Mapper接口：

package com.example.mapper;

import com.example.model.User;
import org.apache.ibatis.annotations.Mapper;

@Mapper
public interface UserMapper {
    // Methods generated by MyBatis Generator
}

高级配置选项

Mybatis官方生成器提供了许多高级配置选项，以满足更复杂的需求。例如，可以配置生成不同类型的字段映射、生成特定的SQL语句等。

1. 字段映射：通过配置javaTypeResolver标签来控制字段的类型映射规则。

<javaTypeResolver>
    <property name="unambiguousTypeMapping" value="true"/>
</javaTypeResolver>

1. 生成特定的SQL语句：可以定义复杂的SQL语句模板，生成更灵活的查询和操作。

<sqlExample id="getUsersByAge">
    select * from users where age > #{age}
</sqlExample>

如何针对不同的数据库进行优化

Mybatis官方生成器支持多种数据库，每种数据库都有特定的优化选项。例如，对于MySQL数据库，可以使用<databaseType>标签来选择适当的优化配置：

<context id="testContext" targetRuntime="MyBatis3" databaseType="MYSQL">

这会根据MySQL的特点来生成更合适的SQL语句。

生成器插件的使用介绍

Mybatis官方生成器支持插件扩展，允许开发人员编写自定义的插件来扩展生成器的功能。例如，可以编写插件来自定义生成的代码结构、处理特定的数据库类型等。

要使用插件，可以在配置文件中添加插件配置：

<context id="testContext" targetRuntime="MyBatis3">
    <plugin type="com.example.MyCustomPlugin">
        <property name="property1" value="value1"/>
        <property name="property2" value="value2"/>
    </plugin>
</context>

插件类需要实现org.mybatis.generator.api.PluginAdapter接口，并重写相关的方法来实现自定义逻辑。

插件类示例

package com.example.plugins;

import org.mybatis.generator.api.IntrospectedColumn;
import org.mybatis.generator.api.IntrospectedTable;
import org.mybatis.generator.api.PluginAdapter;
import org.mybatis.generator.api.dom.java.Field;
import org.mybatis.generator.api.dom.java.TopLevelClass;

public class MyCustomPlugin extends PluginAdapter {
    @Override
    public boolean validate(List<String> warnings) {
        return true;
    }

    @Override
    public boolean clientGenerated(Interface interfaze, TopLevelClass topLevelClass, IntrospectedTable introspectedTable) {
        // 自定义代码生成逻辑
        return true;
    }

    @Override
    public boolean modelBaseRecordClassGenerated(TopLevelClass topLevelClass, IntrospectedTable introspectedTable) {
        // 自定义代码生成逻辑
        return true;
    }

    @Override
    public boolean modelPrimaryKeyClassGenerated(TopLevelClass topLevelClass, IntrospectedTable introspectedTable) {
        // 自定义代码生成逻辑
        return true;
    }

    @Override
    public boolean modelRecordWithBLOBsClassGenerated(TopLevelClass topLevelClass, IntrospectedTable introspectedTable) {
        // 自定义代码生成逻辑
        return true;
    }
}

常见问题汇总

1. 生成器无法连接数据库：检查数据库连接信息的正确性。
2. 生成的代码与数据库表结构不符：确保表结构是最新的，重新执行生成器。
3. 生成的代码不符合期望：检查配置文件中的规则是否正确，调整生成器的配置。

常见错误排查方法

1. 数据库驱动问题：确保使用的数据库驱动类名正确，并且该驱动类已经在项目的依赖库中。
2. 数据库连接信息问题：检查数据库URL、用户名和密码是否正确。
3. 配置文件错误：仔细检查配置文件中的每个标签和属性是否正确。

使用生成器时的注意事项

1. 保持配置文件的版本兼容性：确保配置文件中的版本与Mybatis Generator的版本兼容。
2. 确保数据库表结构的稳定性：频繁修改表结构可能会影响生成器的正常使用，尽量保持表结构的稳定性。
3. 合理利用自定义插件：通过编写插件来自定义生成器的功能，以适应特定的需求。