Mybatis官方生成器资料介绍了Mybatis Generator（MBG）的基本概念、作用和优势，涵盖了从安装配置到基本使用的全过程，并提供了详细的实战案例和常见问题解决策略。

Mybatis生成器的基本概念

Mybatis生成器（Mybatis Generator，简称MBG）是一个工具，主要用于生成Mybatis所需的各种代码，比如映射文件（Mapper XML）、Java实体类、DAO接口等。生成器可以极大地提高开发效率，减少重复的编码工作，同时也降低了出错的可能性。

生成器的作用和优势

MBG的主要作用是在开发过程中自动生成与数据库表结构匹配的代码，包括：

• 映射文件：自动生成每个表对应的Mapper XML文件。
• Java实体类：根据数据库表结构自动生成实体类。
• DAO接口：自动生成对应的DAO接口类。
• 注解配置：在一些特殊情况下，可以生成带有注解的实体类。

MBG的优势主要体现在以下几个方面：

• 减少开发时间：自动化生成代码，减少了手动编写代码的时间。
• 减少错误：减少了人为编写的错误，提高了代码的一致性和准确性。
• 代码维护性：通过生成器生成的代码易于维护，可以通过更新生成器配置来同步更新数据库表结构相关代码。
• 支持多种数据库：MBG支持多种数据库，如MySQL、Oracle、SQL Server等。

开发环境搭建

在使用Mybatis Generator之前，需要先搭建好开发环境。需要安装Java开发环境（JDK）和构建工具（Maven或Gradle），并确保环境变量配置正确。以下是详细的环境搭建步骤：

1. 安装JDK：

   • 下载JDK并安装，确保安装成功后配置好环境变量。
   • 设置JAVA_HOME，将JAVA_HOME/bin路径添加到系统的PATH中。
   • 检查安装是否成功，可以通过命令 java -version 来验证。
2. 安装Maven或Gradle：
   • 下载Maven或Gradle并解压到指定目录。
   • 设置Maven或Gradle的环境变量，将Maven或Gradle的bin路径添加到系统的PATH中。
   • 验证安装是否成功，可以通过命令 mvn -version 或 gradle -v 来验证。

设置环境变量的具体命令示例：

• 设置JAVA_HOME：
  • Windows: set JAVA_HOME=C:\Program Files\Java\jdk1.8.0_XXX
  • Linux/macOS: export JAVA_HOME=/usr/local/jdk1.8.0_XXX
• 验证环境变量设置是否成功：
  • Windows: 打开命令提示符并输入 java -version
  • Linux/macOS: 打开终端并输入 java -version

快速安装步骤

1. 添加依赖：

   • 在Maven项目中，在pom.xml文件中添加Mybatis Generator的依赖：

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

   • 在Gradle项目中，在build.gradle文件中添加依赖：

   dependencies {
      implementation 'org.mybatis.generator:mybatis-generator-core:1.3.7'
   }

2. 创建配置文件：

   • 创建Mybatis Generator的配置文件generatorConfig.xml，该文件用于定义生成器的配置信息。

3. 运行生成器：

   • 使用Maven或Gradle命令来运行生成器。例如，使用Maven：

   mvn mybatis-generator:generate

   • 或者使用Gradle：

   ./gradlew mybatisGeneratorGenerate

核心配置解析

Mybatis Generator的核心配置文件是generatorConfig.xml，该文件定义了生成器的行为。一些常见的配置项包括：

• context：定义生成器上下文，可以包含多个context。
• jdbcConnection：配置数据库连接信息，包括驱动、URL、用户名和密码。
• javaModelGenerator：定义Java实体类的生成配置，包括输出目录、包名等。
• sqlMapGenerator：定义Mapper XML的生成配置。
• javaClientGenerator：定义DAO接口的生成配置，通常生成Mapper接口。

示例配置文件generatorConfig.xml如下：

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

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

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

        <sqlMapGenerator targetPackage="com.example.mapper" targetProject="src/main/resources">
            <property name="enableSubPackages" value="true"/>
        </sqlMapGenerator>

        <javaClientGenerator type="XMLMAPPER" targetPackage="com.example.mapper" targetProject="src/main/java">
            <property name="enableSubPackages" value="true"/>
        </javaClientGenerator>

        <table tableName="users" domainObjectName="User" enableCounters="false"/>
    </context>
</generatorConfiguration>

生成器的简单配置方法

1. 创建配置文件：
   • 创建generatorConfig.xml文件，定义所需的生成器配置选项。

<generatorConfiguration>
    <context id="default" targetRuntime="MyBatis3" defaultModelType="flat">
        <jdbcConnection driverClass="com.mysql.cj.jdbc.Driver"
                        connectionURL="jdbc:mysql://localhost:3306/test"
                        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"/>
    </context>
</generatorConfiguration>

1. 运行生成器：
   • 使用Maven或Gradle命令运行生成器，生成对应的代码文件。

表与字段的映射配置

在配置文件中可以通过<table>标签来配置需要生成代码的表，以及表的名称和对应的实体类名。

1. 基本配置：
   • 通过tableName属性定义表名。
   • 通过domainObjectName属性定义生成的实体类名称。

<table tableName="users" domainObjectName="User"/>

1. 复杂配置：
   • 可以通过<columnOverride>标签来覆盖某些字段的配置。
   • 例如，如果需要将某些字段映射为不同的类型，可以定义<columnOverride>标签：

<table tableName="users" domainObjectName="User">
    <columnOverride column="email" javaType="String" jdbcType="VARCHAR"/>
</table>

实体类的自动生成

实体类的生成配置通常包含在<javaModelGenerator>标签中。通过该标签定义实体类的生成配置，如输出路径、包名等。

1. 基本配置：
   • 通过targetPackage属性定义实体类的包名。
   • 通过targetProject属性定义实体类的输出路径。

<javaModelGenerator targetPackage="com.example.model" targetProject="src/main/java"/>

1. 复杂配置：
   • 可以通过enableSubPackages属性来启用子包生成，这可以将实体类根据数据库表名的前缀进行分类。
   • 通过trimStrings属性可以设置实体类中字符串类型的trim方法。

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

生成器的具体应用场景

通过MBG生成器生成Mybatis所需的各种代码，例如：

• 实体类：根据数据库表结构自动生成实体类。
• Mapper XML：生成对应的Mapper XML文件。
• Mapper接口：生成Mapper接口类。

例如，假设有一个数据库表users，包含以下字段：

CREATE TABLE users (
    id INT AUTO_INCREMENT PRIMARY KEY,
    name VARCHAR(255),
    email VARCHAR(255)
);

可以通过配置MBG生成器来自动生成实体类、Mapper XML和Mapper接口。

1. 配置文件generatorConfig.xml：

<generatorConfiguration>
    <context id="default" targetRuntime="MyBatis3" defaultModelType="flat">
        <jdbcConnection driverClass="com.mysql.cj.jdbc.Driver"
                        connectionURL="jdbc:mysql://localhost:3306/test"
                        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"/>
    </context>
</generatorConfiguration>

1. 执行生成器：

mvn mybatis-generator:generate

1. 生成结果：

   • 实体类User.java：

     package com.example.model;
     
     public class User {
      private Integer id;
      private String name;
      private String email;
     
      // Getter and Setter methods
     }

   • Mapper XML文件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">
      <select id="selectByPrimaryKey" resultMap="ResultMap" parameterType="int">
          SELECT id, name, email FROM users WHERE id = #{id}
      </select>
     </mapper>

   • Mapper接口类UserMapper.java：

     package com.example.mapper;
     
     import com.example.model.User;
     
     public interface UserMapper {
      User selectByPrimaryKey(Integer id);
     }

生成器的优势展示

通过Mybatis Generator生成器，可以显著提高开发效率，减少手动编码的时间和错误。例如，手动编写实体类、Mapper XML和Mapper接口可能会引入一些错误，而使用生成器可以确保代码的一致性和正确性。此外，当数据库表结构发生变化时，可以通过修改生成器配置文件重新生成代码，从而保持代码与数据库表结构的一致性。

常见错误及解决办法

1. 配置文件错误：

   • 问题：配置文件中的路径或属性错误，导致生成器无法找到正确的配置信息。
   • 解决办法：检查配置文件中的路径和属性是否正确，确保数据库连接信息、输出路径等配置正确。

2. 数据库连接问题：

   • 问题：数据库连接失败，导致生成器无法连接到数据库。
   • 解决办法：检查数据库连接信息是否正确，确保数据库服务已经启动，并且数据库用户名和密码正确。
3. 生成器版本问题：
   • 问题：使用不同版本的Mybatis Generator生成的代码与当前版本的Mybatis不兼容。
   • 解决办法：确保使用的Mybatis Generator版本与Mybatis版本兼容，可以在pom.xml或build.gradle文件中指定版本。

生成器的优化建议

1. 使用注释生成器：

   • 通过配置注释生成器，可以自动生成数据库表结构的注释信息，提高代码可读性。
   • 在generatorConfig.xml中配置注释生成器：

   <commentGenerator>
      <property name="suppressAllComments" value="false"/>
   </commentGenerator>

2. 启用子包生成：

   • 使用enableSubPackages属性启用子包生成，将实体类根据数据库表名的前缀进行分类。
   • 例如，假设有一个数据库表order，可以通过配置生成器生成子包com.example.model.order：

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

3. 优化生成的代码：

   • 通过配置生成器的属性，如trimStrings、useActualColumnNames等，可以优化生成的代码。
   • 例如，设置trimStrings属性为true，可以确保生成的实体类中字符串类型的trim方法：

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