mybatis generator

MyBatis Generator（简称MBG）是一个用于自动生成MyBatis框架相关代码的工具。它可以根据数据库表结构自动生成对应的Java实体类、Mapper接口以及XML映射文件，从而简化开发过程，提高开发效率。

基础概念

MyBatis Generator 是一个Java程序，它通过读取数据库表的结构信息，自动生成MyBatis所需的代码。生成的代码包括：

Java实体类：对应数据库中的每一张表，包含表中的所有字段。
Mapper接口：定义了对数据库表的基本操作方法。
XML映射文件：包含了SQL语句和结果映射配置。

优势

提高开发效率：减少了手动编写重复代码的工作量。
减少人为错误：自动生成的代码通常比手写代码更准确。
易于维护：当数据库结构发生变化时，只需重新运行MBG即可更新相关代码。

类型

MyBatis Generator支持多种数据库，包括但不限于MySQL、Oracle、PostgreSQL等。它还支持多种插件扩展，可以根据需求自定义生成的代码。

应用场景

快速原型开发：在新项目中快速搭建基础的数据访问层。
代码重构：在现有项目中优化数据访问层的代码结构。
团队协作：统一代码风格，减少因个人习惯差异导致的代码不一致问题。

常见问题及解决方法

问题1：生成的代码不符合预期

原因：可能是配置文件中的设置不正确，或者数据库表结构复杂导致MBG无法正确解析。

解决方法：

检查generatorConfig.xml配置文件，确保所有路径和参数设置正确。
使用插件扩展MBG功能，以处理复杂的数据表结构。

问题2：生成的代码与现有代码冲突

原因：新生成的代码可能与项目中已有的类名或方法名重复。

解决方法：

在generatorConfig.xml中设置唯一的targetPackage和targetProject。
使用MBG的插件功能自定义生成的类名和方法名。

示例代码

以下是一个简单的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_1_0.dtd">

<generatorConfiguration>
  <context id="DB2Tables" targetRuntime="MyBatis3">
    <jdbcConnection driverClass="com.mysql.jdbc.Driver"
                    connectionURL="jdbc:mysql://localhost:3306/mydatabase"
                    userId="root"
                    password="root">
    </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="user" domainObjectName="User"/>
  </context>
</generatorConfiguration>

运行MBG

可以通过命令行或者集成到构建工具（如Maven或Gradle）中运行MyBatis Generator。

命令行方式：

java -jar mybatis-generator-core-x.x.x.jar -configfile generatorConfig.xml -overwrite

Maven插件方式：在pom.xml中添加插件配置：

<build>
  <plugins>
    <plugin>
      <groupId>org.mybatis.generator</groupId>
      <artifactId>mybatis-generator-maven-plugin</artifactId>
      <version>1.4.0</version>
      <configuration>
        <configurationFile>src/main/resources/generatorConfig.xml</configurationFile>
        <overwrite>true</overwrite>
      </configuration>
    </plugin>
  </plugins>
</build>

然后运行：