MyBatis官方生成器教程：轻松入门指南

MyBatis Generator（简称MBG）是一个基于MyBatis框架的开源代码生成工具，用于自动生成MyBatis的映射文件、Mapper接口和实体类，大幅提高开发效率。本文详细介绍了MBG的安装、配置、使用方法以及常见问题的解决方法，帮助开发者快速掌握MyBatis官方生成器教程。

什么是MyBatis生成器

MyBatis Generator（简称MBG）是基于MyBatis框架的开源代码生成工具，用于自动生成MyBatis的映射文件（XML）以及Mapper接口。MBG提供了丰富的配置选项，可以按照用户的需求生成各种类型的代码。

MBG的主要功能包括：

• 生成映射文件：为数据库表生成MyBatis的映射文件。
• 生成Mapper接口：为数据库表生成对应的Mapper接口。
• 生成实体类：为数据库表生成对应的Java实体类。
• 生成SQL映射：为数据库表生成各种SQL语句，如插入、更新、删除等。

MyBatis生成器的作用与优势

MBG的主要作用在于自动化代码生成，减少开发人员手动编写代码的工作量，提高开发效率。其优势包括：

• 减少重复劳动：通过MBG可以自动生成映射文件、Mapper接口和实体类，减少开发人员的重复劳动。
• 一致性：生成的代码遵循统一的规范，保证代码的一致性和可维护性。
• 灵活性：提供丰富的配置选项，用户可以根据自己的需求定制生成的代码。
• 可扩展性：支持插件机制，可以扩展MBG的功能，满足更多的需求。

下载MyBatis Generator

要使用MyBatis Generator，首先需要从其GitHub仓库下载最新版本的MBG JAR包。进入Maven仓库下载页面，下载所需版本的jar包。下载完成后，将jar包放入项目的lib目录下，或者添加到项目的类路径中。

设置开发环境

1. 创建Maven项目：使用Maven构建工具，创建一个新的Maven项目。在pom.xml文件中，添加MyBatis和MyBatis Generator的依赖：

   <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.22</version>
       </dependency>
       <dependency>
           <groupId>org.mybatis</groupId>
           <artifactId>mybatis</artifactId>
           <version>3.5.6</version>
       </dependency>
   </dependencies>

2. 配置数据库连接信息：在项目的src/main/resources目录下，创建一个db.properties文件，用于保存数据库连接信息：

   driver=com.mysql.cj.jdbc.Driver
   url=jdbc:mysql://localhost:3306/mydatabase
   username=root
   password=root

3. 创建配置文件：在项目的src/main/resources目录下，创建一个名为GeneratorConfig.xml的文件，用于配置MBG的具体参数。下面是一个基本的配置文件示例：

   <generatorConfiguration>
       <classPathEntry location="lib/mysql-connector-java-8.0.22.jar"/>
       <context id="default" targetRuntime="MyBatis3">
           <commentGenerator>
               <property name="suppressDate" value="true"/>
               <property name="suppressSerialVersionUID" value="true"/>
           </commentGenerator>
           <jdbcConnection driverClass="com.mysql.cj.jdbc.Driver" 
                           connectionURL="jdbc:mysql://localhost:3306/mydatabase" 
                           userId="root" 
                           password="root"/>
           <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"/>
       </context>
   </generatorConfiguration>

配置生成器的XML文件

配置文件GeneratorConfig.xml是MBG的核心配置文件，它定义了生成代码的具体规则和参数。在配置文件中，关键配置项包括：

• commentGenerator：用于生成注释的配置。
  • suppressDate：是否生成日期注释，默认为false。
  • suppressSerialVersionUID：是否生成serialVersionUID注释，默认为false。
• jdbcConnection：数据库连接信息。
  • driverClass：数据库驱动类名。
  • connectionURL：数据库连接URL。
  • userId：数据库用户名。
  • password：数据库密码。
• javaModelGenerator：生成Java实体类的配置。
  • targetPackage：生成的实体类所在的包名。
  • targetProject：生成实体类所在的项目路径。
• sqlMapGenerator：生成SQL映射文件的配置。
  • targetPackage：生成的SQL映射文件所在的包名。
  • targetProject：生成SQL映射文件所在的项目路径。
• javaClientGenerator：生成Mapper接口的配置。
  • type：生成的Mapper接口类型，可以是ANNOTATION或XMLMAPPER。
  • targetPackage：生成的Mapper接口所在的包名。
  • targetProject：生成Mapper接口所在的项目路径。

解析XML配置项

在生成代码之前，确保配置文件中的各项设置正确无误。例如，可以通过下列配置选项来自定义生成规则：

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

实现高级配置

MBG还支持更高级的配置选项，例如配置字段类型映射规则、生成特定的字段注释等。以下是一些高级配置的示例：

• 字段类型映射规则：可以配置MyBatis如何将数据库字段类型映射到Java类型。

  <javaTypeResolver>
      <property name="forceBigDecimals" value="false"/>
      <property name="useCatalogForSchema" value="false"/>
      <property name="useDelimitedColumns" value="true"/>
  </javaTypeResolver>

• 生成特定的字段注释：可以为生成的实体类中的字段添加特定的注释。

  <javaModelGenerator targetPackage="com.example.model" targetProject="src/main/java">
      <property name="trimStrings" value="true"/>
      <property name="immutable" value="true"/>
      <property name="modelPackage" value="com.example.model"/>
      <property name="modelType" value="pojo"/>
      <contextAttribute>
          <property name="comments" value="Generated by MyBatis Generator"/>
      </contextAttribute>
  </javaModelGenerator>

生成Mapper接口

Mapper接口定义了对数据库表的操作方法，MBG可以根据数据库表的结构，自动生成相应的Mapper接口。例如，对于一个名为User的数据库表，MBG可以生成一个名为UserMapper的Mapper接口，其中包含了增删改查等操作方法。

配置示例：

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

生成Mapper XML文件

Mapper XML文件定义了具体的SQL操作语句，MBG会根据Mapper接口自动生成对应的XML文件。例如，对于UserMapper接口，MBG会生成一个名为UserMapper.xml的文件，其中包含了插入、更新、删除等SQL语句。

配置示例：

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

生成实体类

实体类是Java对象，用于表示数据库表中的数据。MBG可以根据数据库表的结构，自动生成相应的Java实体类。例如，对于一个名为User的数据库表，MBG会生成一个名为User的Java实体类，包含表中的所有字段及其getter和setter方法。

配置示例：

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

自定义配置选项

MBG提供了丰富的配置选项，用户可以根据自己的需求进行自定义配置。例如，可以设置生成的代码命名规则、字段类型映射规则等。

配置示例：

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

实现高级配置

MBG还支持更高级的配置选项，例如配置字段类型映射规则、生成特定的字段注释等。以下是一些高级配置的示例：

• 字段类型映射规则：可以配置MyBatis如何将数据库字段类型映射到Java类型。

  <javaTypeResolver>
      <property name="forceBigDecimals" value="false"/>
      <property name="useCatalogForSchema" value="false"/>
      <property name="useDelimitedColumns" value="true"/>
  </javaTypeResolver>

• 生成特定的字段注释：可以为生成的实体类中的字段添加特定的注释。

  <javaModelGenerator targetPackage="com.example.model" targetProject="src/main/java">
      <property name="trimStrings" value="true"/>
      <property name="immutable" value="true"/>
      <property name="modelPackage" value="com.example.model"/>
      <property name="modelType" value="pojo"/>
      <contextAttribute>
          <property name="comments" value="Generated by MyBatis Generator"/>
      </contextAttribute>
  </javaModelGenerator>

常见的错误与警告

在使用MBG的过程中，可能会遇到一些常见的错误和警告，例如配置文件错误、数据库连接失败等。以下是一些常见的错误及其解决方法：

1. 配置文件错误：

   • 问题描述：在运行MBG时，如果配置文件中存在错误，会抛出异常。
   • 解决方法：检查配置文件中的各项属性是否正确，确保数据库连接信息正确无误，XML格式正确。
2. 数据库连接失败：
   • 问题描述：如果数据库连接失败，MBG将无法生成代码。
   • 解决方法：检查数据库连接信息是否正确，确保数据库已启动并可访问。

解决方案与建议

1. 配置文件检查：

   • 使用IDE的XML编辑功能检查配置文件的语法是否正确。
   • 确认数据库连接信息无误，包括数据库URL、用户名和密码。

2. 数据库连接测试：

   • 使用数据库管理工具（如DBVisualizer、Navicat等）连接数据库，确认数据库服务是否正常运行。
   • 如果数据库在远程服务器上，确保网络连接正常，且远程服务器允许外部连接。

3. 配置文件示例：

   • 可以参考MBG的官方文档或示例配置文件，确保配置文件的格式和内容正确。

4. 调试日志：

   • 启动MBG时，可以开启调试日志，查看详细的错误信息。
   • 例如，在日志配置文件中添加日志级别配置，启用调试日志。

   <configuration>
       <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
           <encoder>
               <pattern>%d{yyyy-MM-dd HH:mm:ss} %-5level %logger{36} - %msg%n</pattern>
           </encoder>
       </appender>
       <root level="debug">
           <appender-ref ref="STDOUT" />
       </root>
   </configuration>

通过以上步骤，可以有效地解决MBG运行过程中遇到的常见问题，确保生成代码的准确性和可靠性。