1、概述：

MyBatis Generator 是一个用于MyBatis的代码生成器。它将为MyBatis的所有版本以及2.2.0之后的版本生成代码。它将关联一个数据库表(或多个表)，并生成可用于访问该表的类代码。MBG根据数据库表结构自动生成绝大部分简单CRUD(创建、检索、更新、删除)数据库操作。
详见：http://www.mybatis.org/generator/

2、使用步骤

本文主要讲解在idea下如何使用mybatis-generator的步骤。
若不知如何创建maven项目，推荐阅读：idea maven项目搭建教程

2.1、在项目的pom.xml文件中引入mybatis-generator插件

<build>
      <plugins>
          <plugin>
              <groupId>org.mybatis.generator</groupId>
              <artifactId>mybatis-generator-maven-plugin</artifactId>
              <version>1.3.7</version>
              <configuration>
                  <!--配置文件的位置-->
                  <configurationFile>${basedir}/src/main/resources/mybatis-generator.xml</configurationFile>
                  <overwrite>true</overwrite>
                  <verbose>true</verbose>
              </configuration>
              <dependencies>
                  <dependency>
                      <groupId>mysql</groupId>
                      <artifactId>mysql-connector-java</artifactId>
                      <version>5.1.46</version>
                  </dependency>
              </dependencies>
          </plugin>
      </plugins>
    </build>

2.2、在项目的resources文件下创建mybatis-generator.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>

    <!--mysql 连接数据库jar 选择自己本地位置(由于这里使用了maven的直接引入，所以可以忽略，见pom.xml)-->
    <!--<classPathEntry location="src/main/lib/mysql-connector-java-5.1.46-bin.jar" />-->

    <context id="testTables" targetRuntime="MyBatis3">
        <commentGenerator>
            <property name="suppressDate" value="true" />
            <!-- 是否去除自动生成的注释 true：是 ： false:否 -->
            <property name="suppressAllComments" value="false"/>
        </commentGenerator>

        <!--数据库连接的信息：驱动类、连接地址、用户名、密码 -->
        <jdbcConnection driverClass="com.mysql.jdbc.Driver"
                        connectionURL="jdbc:mysql://127.0.0.1:3306/world?useUnicode=true&amp;characterEncoding=utf8"
                        userId="root"
                        password="123456">
        </jdbcConnection>

        <!-- java类型处理器
         用于处理DB中的类型到Java中的类型，默认使用JavaTypeResolverDefaultImpl；
         注意一点，默认会先尝试使用Integer，Long，Short等来对应DECIMAL和 NUMERIC数据类型；-->
        <javaTypeResolver>
            <property name="forceBigDecimals" value="false" />
        </javaTypeResolver>

        <!-- 生成实体类的位置 -->
        <javaModelGenerator targetPackage="com.mybatis.generator.entity" targetProject="src/main/java">
            <property name="enableSubPackages" value="false" />
            <!-- 是否去除前后的空格 -->
            <property name="trimStrings" value="true" />
        </javaModelGenerator>

        <!-- 生成.xml映射文件位置-->
        <sqlMapGenerator targetPackage="mapper" targetProject="src/main/resources">
        <!-- 在targetPackage的基础上，根据数据库的schema再生成一层package，最终生成的类放在这个package下，默认为false -->
            <property name="enableSubPackages" value="true" />
        </sqlMapGenerator>

        <!-- 生成dao层接口的位置-->
        <javaClientGenerator type="XMLMAPPER" targetPackage="com.mybatis.generator.repository" targetProject="src/main/java">
         <!-- 在targetPackage的基础上，根据数据库的schema再生成一层package，最终生成的类放在这个package下，默认为false -->
            <property name="enableSubPackages" value="true" />
        </javaClientGenerator>

        <!-- 要生成的表 tableName是数据库中的表名 domainObjectName是生成后的类名-->
        <table tableName="country" domainObjectName="Country" enableCountByExample="false"
               enableUpdateByExample="false" enableDeleteByExample="false" enableSelectByExample="false"
               selectByExampleQueryId="false" />
    </context>
</generatorConfiguration>

配置文件需要修改的地方：
1、数据库连接的信息：驱动类、连接地址、用户名、密码
2、javaModelGenerator：生成实体类的位置
3、sqlMapGenerator：生成映射文件.xml的位置
4、javaClientGenerator：生成dao层接口的位置
5、table：生成所对应的类名等信息的配置
更多属性配置请查看官网或阅读：Mybatis Generator最完整配置详解

2.3、运行

2.3.1 直接使用maven运行:mvn mybatis-generator:generate -e

image.png

2.3.1 使用java代码调用命令执行，代码如下

package com.mybatis.generator;
import java.io.IOException;

public class Application {
    public static void main( String[] args ) {
        Runtime runtime=Runtime.getRuntime();
        // 获取当前项目的根目录位置
        String basePath = Application.class.getResource("").getPath().replaceAll("target.*|^/","");
        try {
            runtime.exec("cmd /c " + basePath);
            runtime.exec("cmd /c start mvn mybatis-generator:generate -e");
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

最后：即可在mybatis-generator所配置的生成位置下看到所生成的代码。