第一步：添加依赖

在 pom.xml 文件中添加需要的依赖，这里使用 mysql 数据库来操作，添加对应的依赖

<dependency>
   <groupId>org.mybatis.generator</groupId>
   <artifactId>mybatis-generator-core</artifactId>
   <version>1.3.7</version>
   <scope>test</scope>
</dependency>
<dependency>
   <groupId>mysql</groupId>
   <artifactId>mysql-connector-java</artifactId>
</dependency>

第二步：配置 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="MySqlContext" targetRuntime="MyBatis3" defaultModelType="flat">
       <property name="beginningDelimiter" value="`"/>
       <property name="endingDelimiter" value="`"/>
       <property name="javaFileEncoding" value="UTF-8"/>
       <!-- 为模型生成序列化方法-->
       <plugin type="org.mybatis.generator.plugins.SerializablePlugin"/>
       <!-- 为生成的Java模型创建一个toString方法 -->
       <plugin type="org.mybatis.generator.plugins.ToStringPlugin"/>
        <!-- 生成 mapper.xml时不 merge 直接覆盖原文件 -->
        <plugin type="org.mybatis.generator.plugins.UnmergeableXmlMappersPlugin"/>
       <commentGenerator type="com.stf.mybatis.CommentGenerator">
           <!-- 是否去除自动生成的注释 true：是 ： false:否 -->
           <property name="suppressAllComments" value="true"/>
           <property name="suppressDate" value="true"/>
           <property name="addRemarkComments" value="true"/>
       </commentGenerator>

       <jdbcConnection driverClass="com.mysql.cj.jdbc.Driver"
                       connectionURL="jdbc:mysql://localhost:3306/test?useUnicode=true&amp;characterEncoding=utf8&amp;zeroDateTimeBehavior=convertToNull&amp;useSSL=true&amp;serverTimezone=GMT%2B8"
                       userId="root"
                       password="test123456">
           <!--防止生成其他库同名表-->
           <property name="nullCatalogMeansCurrent" value="true" />
       </jdbcConnection>

       <!-- 生成 Entity 类存放位置，需要指明所在的包名，所在的项目地址：地址为本地的绝对路径，到项目的java目录 -->
       <javaModelGenerator targetPackage="com.stf.mbg.po" targetProject="D:\project\stf_develop\src\main\java"/>
       <!-- 生成映射xml文件存放位置 -->
       <sqlMapGenerator targetPackage="com.stf.mbg.mapper" targetProject="D:\project\stf_develop\src\main\resources"/>
       <!-- 生成 Dao 类存放位置 -->
       <javaClientGenerator type="XMLMAPPER" targetPackage="com.stf.mbg.mapper" targetProject="D:\project\stf_develop\src\main\java"/>

       <!-- 指定要生成的表名 -->
       <table tableName="app">
           <generatedKey column="id" sqlStatement="MySql" identity="true"/>
       </table>
   </context>
</generatorConfiguration>

需要注意的有以下几点：

UnmergeableXmlMappersPlugin 这个插件一定要配置。若不配置，当再次执行 Generator 生成相同的数据库文件时，mapper.xml 文件会自动 merge，导致出现多个 resultMap id="BaseResultMap" ，项目启动报错；配置该插件后，mapper.xml 文件会自动覆盖原文件，项目启动不会报错；
jdbcConnection 的配置中改为自己的数据库对应的配置，这里使用的是 mysql，如果是其他的数据库改为相应的数据库配置；
connectionURL 需要增加后面的字符以及时区的配置，否则会报错
nullCatalogMeansCurrent 需要配置，如果不加上该配置，会扫描到其他库的同名表，生成其他库的同名表对应的文件
javaModelGenerator 生成 Entity 类存放位置，需要指明所在的包名，所在的项目地址：地址为本地的绝对路径，到项目的java目录；
sqlMapGenerator 生成映射文件存放位置
javaClientGenerator 生成 Dao 类存放位置
table 指定要生成的表名 tableName，指定要生成实体的类名 domainObjectName, 指定表的自增ID generatedKey

第三步：添加一个注释生成器

package com.stf.mybatis;

import org.mybatis.generator.api.IntrospectedColumn;
import org.mybatis.generator.api.IntrospectedTable;
import org.mybatis.generator.api.dom.java.Field;
import org.mybatis.generator.internal.DefaultCommentGenerator;
import org.mybatis.generator.internal.util.StringUtility;

import java.util.Properties;

public class CommentGenerator extends DefaultCommentGenerator {
    private boolean addRemarkComments = false;

    /**
     * 设置用户配置的参数
     */
    @Override
    public void addConfigurationProperties(Properties properties) {
        super.addConfigurationProperties(properties);
        this.addRemarkComments = StringUtility.isTrue(properties.getProperty("addRemarkComments"));
    }

    /**
     * 给字段添加注释
     */
    @Override
    public void addFieldComment(Field field, IntrospectedTable introspectedTable,
                                IntrospectedColumn introspectedColumn) {
        String remarks = introspectedColumn.getRemarks();
        //根据参数和备注信息判断是否添加备注信息
        if(addRemarkComments&&StringUtility.stringHasValue(remarks)){
            //文档注释开始
            field.addJavaDocLine("/**");
            //获取数据库字段的备注信息
            String[] remarkLines = remarks.split(System.getProperty("line.separator"));
            for(String remarkLine:remarkLines){
                field.addJavaDocLine(" * "+remarkLine);
            }
            addJavadocTag(field, false);
            field.addJavaDocLine(" */");
        }
    }
}

这个类会将数据库 DDL 中的注释信息自动生成到 java 类中。

第四步：添加一个 Java 文件，执行生成代码

public class Generator {
    public static void main(String[] args) throws Exception {
        //MBG 执行过程中的警告信息
        List<String> warnings = new ArrayList<String>();
        //当生成的代码重复时 是否覆盖
        boolean overwrite = true;
        //读取我们的 MBG 配置文件
        InputStream is = Generator.class.getResourceAsStream("/generatorConfig.xml");
        ConfigurationParser cp = new ConfigurationParser(warnings);
        Configuration config = cp.parseConfiguration(is);
        is.close();
        DefaultShellCallback callback = new DefaultShellCallback(overwrite);
        //创建 MBG
        MyBatisGenerator myBatisGenerator = new MyBatisGenerator(config, callback, warnings);
        //执行生成代码
        myBatisGenerator.generate(null);
        //输出警告信息
        for (String warning : warnings) {
            System.out.println(warning);
        }
    }
}

执行该 Java 文件的 main 方法，即可生成指定的文件。
如下所示，会生成 4个 Java 文件：