Mybatis官方生成器教程介绍了如何使用Mybatis Generator简化开发流程，自动生成数据库操作代码。文章详细讲解了Mybatis生成器的功能、特点以及如何在项目中配置和使用。通过简单的步骤，开发者可以快速生成所需的Java类、Mapper接口和XML文件，提高开发效率。

Mybatis生成器的作用

Mybatis Generator (MBG) 是一个基于 Mybatis 的数据库逆向工程工具。它的主要作用是根据数据库表结构自动生成 Mybatis 中常用的 CRUD 操作代码，包括 Java 类（Model 类）、Mybatis XML 配置文件（Mapper XML 文件）和 Mapper 接口。通过 MBG，开发人员可以节省大量的编码时间，将更多精力放在业务逻辑的实现上。

Mybatis生成器的特点和优势

• 自动代码生成：MBG 可以自动根据数据库表结构生成 Mybatis 所需的 Java 类、Mapper 接口和 Mapper XML 文件，大幅减少了手写代码的工作量。
• 灵活配置：MBG 提供了丰富的配置选项，可以根据需要自定义生成的代码结构和样式。
• 兼容性：MBG 支持多种数据库，包括 MySQL、Oracle、SQL Server 等，可以与多种数据库环境无缝对接。
• 可扩展性：MBG 的插件机制允许开发人员根据需求自定义生成逻辑，增强了工具的灵活性和可定制性。

安装Mybatis

首先，需要在项目中引入 Mybatis 相关的依赖。以下是 Maven 项目的依赖配置示例：

<dependencies>
    <dependency>
        <groupId>org.mybatis</groupId>
        <artifactId>mybatis</artifactId>
        <version>3.5.6</version>
    </dependency>
    <dependency>
        <groupId>org.mybatis.generator</groupId>
        <artifactId>mybatis-generator-core</artifactId>
        <version>1.3.7</version>
    </dependency>
</dependencies>

准备数据库和表结构

接下来，需要准备一个数据库，并创建相应的表结构。假设我们使用的是 MySQL 数据库，创建一个简单的用户表 user，表结构如下：

CREATE TABLE `user` (
  `id` int(11) NOT NULL AUTO_INCREMENT,
  `username` varchar(255) DEFAULT NULL,
  `password` varchar(255) DEFAULT NULL,
  PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;

可以通过以下命令执行 SQL 语句：

# 示例：执行SQL语句
mysql -u root -p test < setup.sql

配置生成器插件

在 pom.xml 文件中配置 Mybatis Generator 插件，以允许通过 Maven 插件生成代码。

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

编写配置文件

在 src/main/resources 目录下创建 mybatis-generator.xml 配置文件，其中包含生成器的具体配置。以下是一个简单的配置示例：

<!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="DB2Tables" targetRuntime="MyBatis3">
        <commentGenerator>
            <property name="suppressAllComments" value="true"/>
        </commentGenerator>
        <jdbcConnection driverType="MySQL">
            <property name="connectionURL" value="jdbc:mysql://localhost:3306/test?useSSL=false&amp;useUnicode=true&amp;characterEncoding=UTF-8"/>
            <property name="driverClass" value="com.mysql.cj.jdbc.Driver"/>
            <property name="password" value="password"/>
            <property name="userId" value="root"/>
        </jdbcConnection>
        <javaTypeResolver>
            <property name="unambiguousTypeOverrides" 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="user" domainObjectName="User" enableCountByExample="false" enableUpdateByExample="false" enableDeleteByExample="false" enableSelectByExample="false" selectByExampleQueryId="false"/>
    </context>
</generatorConfiguration>

如何使用Mapper接口进行数据库操作

自动生成的 UserMapper.java 文件内容如下：

package com.example.mapper;

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

public interface UserMapper {
    int deleteByPrimaryKey(Integer id);

    int insert(User record);

    int insertSelective(User record);

    User selectByPrimaryKey(Integer id);

    List<User> selectAll();

    int updateByPrimaryKeySelective(User record);

    int updateByPrimaryKey(User record);
}

在实际项目中，可以通过 Mybatis 的 SqlSession 来获取 UserMapper 对象，并调用其方法进行数据库操作。以下是一个简单的示例：

import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;
import com.example.mapper.UserMapper;
import com.example.model.User;

public class MybatisExample {
    public static void main(String[] args) {
        // 创建 SqlSessionFactory 对象
        SqlSessionFactory factory = MybatisConfig.createSessionFactory();
        try (SqlSession session = factory.openSession()) {
            UserMapper mapper = session.getMapper(UserMapper.class);

            // 查询所有用户
            List<User> users = mapper.selectAll();
            for (User user : users) {
                System.out.println(user.getUsername());
            }

            // 插入新用户
            User newUser = new User();
            newUser.setUsername("newUser");
            newUser.setPassword("password");
            mapper.insert(newUser);

            // 更新用户信息
            User updateUser = new User();
            updateUser.setId(1);
            updateUser.setUsername("updatedUser");
            mapper.updateByPrimaryKeySelective(updateUser);

            // 删除用户
            mapper.deleteByPrimaryKey(1);
        }
    }
}

自动生成Model类

自动生成的 User.java 文件内容如下：

package com.example.model;

import java.util.Date;

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

    // Getter and Setter
    public Integer getId() {
        return id;
    }

    public void setId(Integer 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;
    }
}

在实际开发过程中，可能需要对生成的代码进行调试和优化。以下是一些常见的调试和优化方法：

调试 Mapper 接口

假设需要查看 UserMapper 接口的 SQL 语句执行情况，可以在 mybatis-config.xml 配置文件中启用日志功能：

<configuration>
    <settings>
        <setting name="logImpl" value="STDOUT_LOGGING"/>
    </settings>
</configuration>

启用日志功能后，执行 SQL 语句时，Mybatis 会在控制台输出详细的执行信息，方便调试。

优化生成的 SQL 语句

如果生成的 SQL 语句性能较差，可以通过自定义 XML 文件来优化 SQL 语句。例如，可以在 UserMapper.xml 中自定义 selectByPrimaryKey 方法的 SQL 语句：

<mapper namespace="com.example.mapper.UserMapper">
    <resultMap id="UserResult" type="com.example.model.User">
        <id column="id" property="id"/>
        <result column="username" property="username"/>
        <result column="password" property="password"/>
    </resultMap>

    <select id="selectByPrimaryKey" resultMap="UserResult">
        SELECT `id`, `username`, `password`
        FROM `user`
        WHERE `id` = #{id}
    </select>
</mapper>

自定义生成逻辑

如果默认生成的代码不符合需求，可以通过修改 mybatis-generator.xml 配置文件来自定义生成逻辑。例如，可以通过配置 table 标签来自定义生成的类名、表名等信息：

<table tableName="user" domainObjectName="User" enableCountByExample="false" enableUpdateByExample="false" enableDeleteByExample="false" enableSelectByExample="false" selectByExampleQueryId="false">
    <!-- 自定义生成的列 -->
    <columnOverride column="username" javaType="String" jdbcType="VARCHAR"/>
</table>

生成过程中可能遇到的问题

• 依赖冲突：在使用 Maven 时，可能会遇到依赖冲突的问题，导致生成器无法正常工作。
• 配置文件错误：配置文件中的路径、数据库连接信息等错误会导致生成器无法执行。
• 生成的代码不符合预期：由于配置错误或其他原因，生成的代码可能不符合预期，需要根据实际需求进行调整。

解决问题的常见方法和技巧

• 解决依赖冲突：可以通过 Maven 的 dependency:tree 命令查看项目中的依赖树，找出冲突的依赖并进行排除。例如：

<!-- 解决依赖冲突，排除冲突的依赖 -->
<dependency>
    <groupId>org.mybatis.generator</groupId>
    <artifactId>mybatis-generator-core</artifactId>
    <version>1.3.7</version>
    <exclusions>
        <exclusion>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j-api</artifactId>
        </exclusion>
    </exclusions>
</dependency>
``

- **检查配置文件**：仔细检查 `mybatis-generator.xml` 配置文件中的路径、数据库连接信息、表名等配置，确保配置正确。
- **调试生成器**：可以通过输出详细的日志信息来调试生成器，查看生成器的执行过程，找出问题所在。