一. 问题背景

IDE： IntelliJ IDEA
后台： SpringBoot 2.3
数据库： MySQL 5.7.25
数据库驱动： com.mysql.cj.jdbc.Driver

情况：本工程是由SpringBoot 2.3搭建起来。数据库表的字段太多（至少有20个），手动创建实体类的话，不知道要创建到什么时候，因此需要使用mybatis generator逆向工程根据数据库里面的表，自动生成对应的实体类、xxxMapper接口文件、xxxMapper.xml文件。

二. 参考博客

笔者未使用mybatis generator逆向工程之前仅仅是停留在了解层面，只知道有mybatis逆向工程这样一个技术可以自动生成实体类、xxxMapper.java文件、xxxMapper.xml文件。

当我想学习并使用mybatis逆向工程的时候，发现网上关于这方面的博客并不多，不知道是不是还有其他更热门、性能更好、更方便的技术栈来解决自动生成实体类方面的问题。

因此特别感谢维数不多的好博客给我的帮助，感谢以下博客：

1. IDEA中使用mybatis逆向工程。这篇适合新手，非常简单易懂，思路清晰
2. Mybatis Generator 逆向工程 POJO自定义注释。这篇适合生成自定义注释却不知道如何做
3. 逆向工程之实现CommentGenerator接口来实现生成自定义注解的实体类等。这篇适合实现了自定义注释，但是mybatis generator没有调用我的自定义注释

三. 效果图

在这里先放效果图，如果不是大家想找的博客可以不用再看下面了，本篇博客很长。效果图如下：

四. 搭建MyBatis逆向工程环境

4.1 前言

这里 使用的是依赖引入的方法，因此需要大家创建好maven工程环境或者SpringBoot环境，这里不赘述如何创建maven以及SpringBoot环境了。（PS：创建SpringBoot推荐使用这个连接创建https://start.aliyun.com/，拉取模块的速度非常快）

其次因为涉及数据库操作，因此需要自行搭建好mysql驱动依赖、mybatis依赖、数据源，总之搭好一个能成功操作数据库的环境

4.2 引入依赖

首先需要 引入mybatis generator依赖，大家可以自行去maven仓库搜索mybatis generator，版本建议使用1.3.5及上的，或者使用下面的：

<!-- mybatis generator逆向工程-->
<dependency>
	<groupId>org.mybatis.generator</groupId>
	<artifactId>mybatis-generator-core</artifactId>
	<version>1.4.0</version>
</dependency>

4.3 创建mybatis generator需要用的数据源

首先 创建mybatis generator的数据源文件generator.properties：

这里配置需要生成实体类的数据表所在 数据库的信息。大家根据情况自行修改信息：

jdbc.driver=com.mysql.cj.jdbc.Driver
jdbc.url=jdbc:mysql://localhost:3306/customer_marketing_icbc?characterEncoding=utf-8&useSSL=false&serverTimezone=Hongkong
jdbc.userId=数据库用户名
jdbc.pwd=数据库密码

（如果数据库版本比较低的话，driver驱动那里建议使用com.mysql.jdbc.Driver，否则后面启动生成实体类时会报错can not load）

4.4 配置genreatorConfig.xml文件

创建generatorConfig.xml文件，注意文件名一定要是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>
    <!--加载数据库数据源的资源文件-->
    <properties resource="generator.properties"></properties>

    <!--配置生成环境-->
    <context id="testTables" targetRuntime="MyBatis3">

        <!--实体类生成toString()-->
        <plugin type="org.mybatis.generator.plugins.ToStringPlugin" />
        <!--实体类实现序列化-->
        <plugin type="org.mybatis.generator.plugins.SerializablePlugin" />
        <!--加载自定义注释的类,必须是全类名-->
        <commentGenerator type="com.icbc.demo.config.MyCommentGenerator">
            <!--是否去除自动生成的注释 true是：false 否-->
            <property name="suppressAllComments" value="false"/>
        </commentGenerator>
        <!--数据库连接，如果没有配置数据源，则可以直接填上driverClass、url这些信息-->
        <jdbcConnection driverClass="${jdbc.driver}" connectionURL="${jdbc.url}" userId="${jdbc.userId}" password="${jdbc.pwd}"></jdbcConnection>
        <!-- 默认false，把JDBC DECIMAL 和 NUMERIC 类型解析为 Integer，为 true时把JDBC DECIMAL和NUMERIC类型解析为java.math.BigDecimal -->
        <javaTypeResolver>
            <property name="forceBigDecimals" value="false"/>
        </javaTypeResolver>
        <!--targetPackage目标包，生成实体类的位置-->
        <javaModelGenerator targetPackage="com.icbc.demo.entity" targetProject="src/main/java">
            <!--enableSubPackages,是否让schema作为包的后缀-->
            <property name="enableSubPackages" value="false"/>
            <!--从数据库返回的值被清除前后空格-->
            <property name="trimStrings" value="true"/>
        </javaModelGenerator>
        <!--targetProject:mapper映射文件生成的位置-->
        <sqlMapGenerator targetPackage="mapper" targetProject="./src/main/resources">
            <property name="enableSubPackages" value="false"></property>

        </sqlMapGenerator>
        <!--targetPackage:mapper接口生成的位置-->
        <javaClientGenerator type="XMLMAPPER" targetPackage="com.icbc.demo.mapper"
                             targetProject="src/main/java">
            <property name="enableSubPackages" value="false"/>
        </javaClientGenerator>
        <!--指定数据库表，要和数据库中进行对应，否则将会出错；-->
        <!--如果要生成多个数据表对应的多个实体类，则可以创建多个<table>-->
        <!--domainObjectName是生成实体类的类名-->
        <!--enableSelectByExample是否生成动态查询语句-->
        <table tableName="combine_train_set"  domainObjectName="CombineTrainSet"
               enableCountByExample="false" enableUpdateByExample="false"
               enableDeleteByExample="false" enableSelectByExample="false"
               selectByExampleQueryId="false"></table>
    </context>
</generatorConfiguration>

解释：

• 首先要修改<properties>，将数据源文件generator.properties的路径填正确。
• 实体类要 生成toString()或实体类需要序列化，则需要配置如下：

<!--实体类生成toString()-->
<plugin type="org.mybatis.generator.plugins.ToStringPlugin" />
<!--实体类实现序列化-->
<plugin type="org.mybatis.generator.plugins.SerializablePlugin" />

• 如果 需要自定义注释，就需要引入自定义注释的那个类，使得mybatis generator能识别到，如下：

 <!--加载自定义注释的类,必须是全类名-->
<commentGenerator type="com.icbc.demo.config.MyCommentGenerator">

• 目前这里还没讲述生成自定义注释（后面会详细讲述），因此 <commentGenerator >中的typ属性可以先去掉

• <jdbcConnection> 的信息要根据自己的数据库填正确，如果没有配置数据源，则可以直接在<jdbcConnection>填上值。

• <javaModelGenerator >、<sqlMapGenerator >、<javaClientGenerator >都要修改，按照上面代码中的注释修改成自己的位置

• 如果要通过多个数据表来创建 多个实体类，则需要创建多个<table>，其中domainObjectName是要生成实体类的名字

4.5 创建mybatis generator启动类

这里需要注意，启动mybatis generator有2种方式：插件启动；启动类启动。

鉴于插件启动对后面自定义注释有很多问题且暂时未找到解决方案，这里极力推荐使用启动类启动。因此插件启动方式这里不赘述了。

官方提供的启动方法如下：（第4行代码中需要填写自己generatorConfig.xml所在的路径）

List<String> warnings=new ArrayList<String>();
boolean overWriter=true;
//指向配置文件　　
File configFile=new File(MyGenerator.class.getResource("/generatorConfig.xml").getFile());
ConfigurationParser cp=new ConfigurationParser(warnings);
Configuration config=cp.parseConfiguration(configFile);
DefaultShellCallback callback=new DefaultShellCallback(overWriter);
MyBatisGenerator myBatisGenerator=new MyBatisGenerator(config,callback,warnings);
myBatisGenerator.generate(null);

完整的启动类如下：

/**
 * mybatis generator 启动类
 */
public class MyGenerator {
    

    public static void main(String[] args) throws Exception{
    
        new MyGenerator().generate();
    }

    //mybatis-generator 类方式启动
    public void generate() throws Exception{
    
        List<String> warnings=new ArrayList<String>();
        boolean overWriter=true;
        //指向配置文件　　
        File configFile=new File(MyGenerator.class.getResource("/generatorConfig.xml").getFile());
        ConfigurationParser cp=new ConfigurationParser(warnings);
        Configuration config=cp.parseConfiguration(configFile);
        DefaultShellCallback callback=new DefaultShellCallback(overWriter);
        MyBatisGenerator myBatisGenerator=new MyBatisGenerator(config,callback,warnings);
        myBatisGenerator.generate(null);
    }
}

只要能运行到官方提供的方法就可以启动了，这里我在main方法里面调用它，只要我启动main方法就可以生成实体类、xxxMapper.java、xxxMapper.xml文件了。

如果有报错问题的伙伴首先可以删除target文件夹下的classes文件夹，然后再启动试试（它会生成新的classes文件夹）。

如果仍报错，可以尝试更新mybatis-generator版本或者看看路径那些是否写正确了。有问题的小伙伴可留言

五. 生成自定义注释

5.1 问题背景

有时字段太多且无法从字面意思直到其存储的内容是什么意义，因此我们此时可以生成注释。但是 mybatis generator自动生成的注释都是以下这些无用的注释，如下：

/**
 * This class was generated by MyBatis Generator.
 * This class corresponds to the database table 
 * @mbg xxx xxx-xx-xx xx:xx:xx
 */

而 我们想要的是这些有用的、字段的注释：

 /**
  * id
  */
 private String individualid;

 /**
  * 姓名
  */
 private String name;

因此我们可以自定义注释，而且这些注释是从数据表的字段那个注释获取而来。

5.2 实现自定义注释

5.2.1 创建自定义注释的类

创建一个类（名字随意，这里我使用MyCommentGenerator）并实现CommentGenerator接口。这里首先拿一个很关键的方法来讲解，它的作用是给实体类的属性添加数据表字段的注释。代码如下（注意代码中的注释，完整代码后面会给出某些解释）：

/**
     * 给实体类的属性  添加注释
     * @param field
     * @param introspectedTable
     * @param introspectedColumn
     */
    public void addFieldComment(Field field, IntrospectedTable introspectedTable, IntrospectedColumn introspectedColumn) {
    
        if (!this.suppressAllComments) {
    
            field.addJavaDocLine("/**");
            String remarks = introspectedColumn.getRemarks();
            /*if (this.addRemarkComments && StringUtility.stringHasValue(remarks)) {
                field.addJavaDocLine(" * Database Column Remarks:");
                String[] remarkLines = remarks.split(System.getProperty("line.separator"));
                String[] var6 = remarkLines;
                int var7 = remarkLines.length;

                for(int var8 = 0; var8 < var7; ++var8) {
                    String remarkLine = var6[var8];
                    field.addJavaDocLine(" *   " + remarkLine);
                }
            }*/

            /*field.addJavaDocLine(" *");
            field.addJavaDocLine(" * This field was generated by MyBatis Generator.");*/
            StringBuilder sb = new StringBuilder();
            sb.append(" * " + remarks);//这个就是字段的注释
            /*sb.append(" * This field corresponds to the database column ");
            sb.append(introspectedTable.getFullyQualifiedTable());
            sb.append('.');
            sb.append(introspectedColumn.getActualColumnName());*/
            field.addJavaDocLine(sb.toString());
            /*this.addJavadocTag(field, false);*/
            field.addJavaDocLine(" */");
        }
    }

解释：

• 如上代码所示，根据数据表字段的注释生成注释的方法是有3个形参的addFieldComment(xx,xx,xx)，获取字段注释的关键方法是String remarks = introspectedColumn.getRemarks()，大家根据自己的需要可以将无用的代码注释掉（那些都是生成无用注释的代码），然后修改成自己想要的注释。

下面贴出 完整的自定义注释的类，大家可以直接copy，然后根据自己的需要去修改。比如有些方法是生成xxxMapper.java文件的注释，如果不想生成无用的注释，可以直接将if判断句注释掉或者删掉。代码如下：（下面代码中的注释解释了各个方法的作用）

package com.icbc.demo.config;//修改当前类所在的包名(修改成你自己所在的包)

/**
 * mybatis generator 自定义注释
 */
public class MyCommentGenerator implements CommentGenerator {
    
    private Properties properties = new Properties();
    private boolean suppressDate = false;
    private boolean suppressAllComments = false;
    private boolean addRemarkComments = false;
    private SimpleDateFormat dateFormat;

    public MyCommentGenerator() {
    
    }

    public void addJavaFileComment(CompilationUnit compilationUnit) {
    
    }

    /**
     * 生成xxxMapper.xml文件注释的方法
     * @param xmlElement
     */
    public void addComment(XmlElement xmlElement) {
    
//        if (!this.suppressAllComments) {
    
//            xmlElement.addElement(new TextElement("<!--"));
//            StringBuilder sb = new StringBuilder();
//            sb.append("  WARNING - ");
//            sb.append("@mbg.generated");
//            xmlElement.addElement(new TextElement(sb.toString()));
//            xmlElement.addElement(new TextElement("  This element is automatically generated by MyBatis Generator, do not modify."));
//            String s = this.getDateString();
//            if (s != null) {
    
//                sb.setLength(0);
//                sb.append("  This element was generated on ");
//                sb.append(s);
//                sb.append('.');
//                xmlElement.addElement(new TextElement(sb.toString()));
//            }
//
//            xmlElement.addElement(new TextElement("-->"));
//        }
    }

    public void addRootComment(XmlElement rootElement) {
    
    }

    /**
     * 在xxxMapper.java中的方法上 生成注解 的方法
     * @param method
     * @param introspectedTable
     * @param set
     */
    @Override
    public void addGeneralMethodAnnotation(Method method, IntrospectedTable introspectedTable, Set<FullyQualifiedJavaType> set) {
    

    }

    /**
     * 在xxxMapper.java中的方法上 生成注解 的方法
     * @param method
     * @param introspectedTable
     * @param set
     */
    @Override
    public void addGeneralMethodAnnotation(Method method, IntrospectedTable introspectedTable, IntrospectedColumn introspectedColumn, Set<FullyQualifiedJavaType> set) {
    

    }

    /**
     * 在实体类的属性上  生成注解  的方法
     * @param field
     * @param introspectedTable
     * @param set
     */
    @Override
    public void addFieldAnnotation(Field field, IntrospectedTable introspectedTable, Set<FullyQualifiedJavaType> set) {
    

    }

    /**
     * 在实体类的属性上  生成注解  的方法
     * @param field
     * @param introspectedTable
     * @param set
     */
    @Override
    public void addFieldAnnotation(Field field, IntrospectedTable introspectedTable, IntrospectedColumn introspectedColumn, Set<FullyQualifiedJavaType> set) {
    

    }

    /**
     * 在实体类上  生成类注解  的方法
     * @param innerClass
     * @param introspectedTable
     * @param set
     */
    @Override
    public void addClassAnnotation(InnerClass innerClass, IntrospectedTable introspectedTable, Set<FullyQualifiedJavaType> set) {
    

    }

    /**
     * 从generatorConfig.xml中获取相应的配置项
     * @param properties
     */
    public void addConfigurationProperties(Properties properties) {
    
        this.properties.putAll(properties);
        this.suppressDate = StringUtility.isTrue(properties.getProperty("suppressDate"));
        this.suppressAllComments = StringUtility.isTrue(properties.getProperty("suppressAllComments"));
        this.addRemarkComments = StringUtility.isTrue(properties.getProperty("addRemarkComments"));
        String dateFormatString = properties.getProperty("dateFormat");
        if (StringUtility.stringHasValue(dateFormatString)) {
    
            this.dateFormat = new SimpleDateFormat(dateFormatString);
        }

    }

    /**
     * 打上标签
     * @param javaElement
     * @param markAsDoNotDelete
     */
    protected void addJavadocTag(JavaElement javaElement, boolean markAsDoNotDelete) {
    
        javaElement.addJavaDocLine(" *");
        StringBuilder sb = new StringBuilder();
        sb.append(" * ");
        sb.append("@mbg.generated");
        if (markAsDoNotDelete) {
    
            sb.append(" do_not_delete_during_merge");
        }

        String s = this.getDateString();
        if (s != null) {
    
            sb.append(' ');
            sb.append(s);
        }

        javaElement.addJavaDocLine(sb.toString());
    }

    /**
     * 获取时间
     * @return
     */
    protected String getDateString() {
    
        if (this.suppressDate) {
    
            return null;
        } else {
    
            return this.dateFormat != null ? this.dateFormat.format(new Date()) : (new Date()).toString();
        }
    }

    /**
     * 给实体类 添加 类注释
     * @param innerClass
     * @param introspectedTable
     */
    public void addClassComment(InnerClass innerClass, IntrospectedTable introspectedTable) {
    
        if (!this.suppressAllComments) {
    
            StringBuilder sb = new StringBuilder();
            innerClass.addJavaDocLine("/**");
            innerClass.addJavaDocLine(" * This class was generated by MyBatis Generator.");
            sb.append(" * This class corresponds to the database table ");
            sb.append(introspectedTable.getFullyQualifiedTable());
            innerClass.addJavaDocLine(sb.toString());
            this.addJavadocTag(innerClass, false);
            innerClass.addJavaDocLine(" */");
        }
    }

    /**
     * 给创建数据库表对应的实体类 添加 注释
     * @param topLevelClass
     * @param introspectedTable
     */
    public void addModelClassComment(TopLevelClass topLevelClass, IntrospectedTable introspectedTable) {
    
        if (!this.suppressAllComments && this.addRemarkComments) {
    
            StringBuilder sb = new StringBuilder();
            topLevelClass.addJavaDocLine("/**");
            String remarks = introspectedTable.getRemarks();
            if (this.addRemarkComments && StringUtility.stringHasValue(remarks)) {
    
                topLevelClass.addJavaDocLine(" * Database Table Remarks:");
                String[] remarkLines = remarks.split(System.getProperty("line.separator"));
                String[] var6 = remarkLines;
                int var7 = remarkLines.length;

                for(int var8 = 0; var8 < var7; ++var8) {
    
                    String remarkLine = var6[var8];
                    topLevelClass.addJavaDocLine(" *   " + remarkLine);
                }
            }

            topLevelClass.addJavaDocLine(" *");
            topLevelClass.addJavaDocLine(" * This class was generated by MyBatis Generator.");
            sb.append(" * This class corresponds to the database table ");
            sb.append(introspectedTable.getFullyQualifiedTable());
            topLevelClass.addJavaDocLine(sb.toString());
            this.addJavadocTag(topLevelClass, true);
            topLevelClass.addJavaDocLine(" */");
        }
    }

    /**
     * 给实体类的枚举类型  添加注释
     * @param innerEnum
     * @param introspectedTable
     */
    public void addEnumComment(InnerEnum innerEnum, IntrospectedTable introspectedTable) {
    
        if (!this.suppressAllComments) {
    
            StringBuilder sb = new StringBuilder();
            innerEnum.addJavaDocLine("/**");
            innerEnum.addJavaDocLine(" * This enum was generated by MyBatis Generator.");
            sb.append(" * This enum corresponds to the database table ");
            sb.append(introspectedTable.getFullyQualifiedTable());
            innerEnum.addJavaDocLine(sb.toString());
            this.addJavadocTag(innerEnum, false);
            innerEnum.addJavaDocLine(" */");
        }
    }

    /**
     * 给实体类的属性  添加注释
     * @param field
     * @param introspectedTable
     * @param introspectedColumn
     */
    public void addFieldComment(Field field, IntrospectedTable introspectedTable, IntrospectedColumn introspectedColumn) {
    
        if (!this.suppressAllComments) {
    
            field.addJavaDocLine("/**");
            String remarks = introspectedColumn.getRemarks();
            /*if (this.addRemarkComments && StringUtility.stringHasValue(remarks)) {
                field.addJavaDocLine(" * Database Column Remarks:");
                String[] remarkLines = remarks.split(System.getProperty("line.separator"));
                String[] var6 = remarkLines;
                int var7 = remarkLines.length;

                for(int var8 = 0; var8 < var7; ++var8) {
                    String remarkLine = var6[var8];
                    field.addJavaDocLine(" *   " + remarkLine);
                }
            }*/

            /*field.addJavaDocLine(" *");
            field.addJavaDocLine(" * This field was generated by MyBatis Generator.");*/
            StringBuilder sb = new StringBuilder();
            sb.append(" * " + remarks);//这个就是字段的注释
            /*sb.append(" * This field corresponds to the database column ");
            sb.append(introspectedTable.getFullyQualifiedTable());
            sb.append('.');
            sb.append(introspectedColumn.getActualColumnName());*/
            field.addJavaDocLine(sb.toString());
            /*this.addJavadocTag(field, false);*/
            field.addJavaDocLine(" */");
        }
    }

    /**
     * 给实体类的属性  添加注释
     * @param field
     * @param introspectedTable
     */
    public void addFieldComment(Field field, IntrospectedTable introspectedTable) {
    
//        if (!this.suppressAllComments) {
    
//            StringBuilder sb = new StringBuilder();
//            field.addJavaDocLine("/**");
//            field.addJavaDocLine(" * This field was generated by MyBatis Generator.");
//            sb.append(" * This field corresponds to the database table ");
//            sb.append(introspectedTable.getFullyQualifiedTable());
//            field.addJavaDocLine(sb.toString());
//            this.addJavadocTag(field, false);
//            field.addJavaDocLine(" */");
//        }
    }

    /**
     * 给xxxMapper.java的方法添加注释
     * @param method
     * @param introspectedTable
     */
    public void addGeneralMethodComment(Method method, IntrospectedTable introspectedTable) {
    
//        if (!this.suppressAllComments) {
    
//            StringBuilder sb = new StringBuilder();
//            method.addJavaDocLine("/**");
//            method.addJavaDocLine(" * This method was generated by MyBatis Generator.");
//            sb.append(" * This method corresponds to the database table ");
//            sb.append(introspectedTable.getFullyQualifiedTable());
//            method.addJavaDocLine(sb.toString());
//            this.addJavadocTag(method, false);
//            method.addJavaDocLine(" */");
//        }
    }

    /**
     * 给实体类的getter方法添加注释
     * @param method
     * @param introspectedTable
     * @param introspectedColumn
     */
    public void addGetterComment(Method method, IntrospectedTable introspectedTable, IntrospectedColumn introspectedColumn) {
    
//        if (!this.suppressAllComments) {
    
//            StringBuilder sb = new StringBuilder();
//            method.addJavaDocLine("/**");
//            method.addJavaDocLine(" * This method was generated by MyBatis Generator.");
//            sb.append(" * This method returns the value of the database column ");
//            sb.append(introspectedTable.getFullyQualifiedTable());
//            sb.append('.');
//            sb.append(introspectedColumn.getActualColumnName());
//            method.addJavaDocLine(sb.toString());
//            method.addJavaDocLine(" *");
//            sb.setLength(0);
//            sb.append(" * @return the value of ");
//            sb.append(introspectedTable.getFullyQualifiedTable());
//            sb.append('.');
//            sb.append(introspectedColumn.getActualColumnName());
//            method.addJavaDocLine(sb.toString());
//            this.addJavadocTag(method, false);
//            method.addJavaDocLine(" */");
//        }
    }

    /**
     * 给实体类的setter方法添加注释
     * @param method
     * @param introspectedTable
     * @param introspectedColumn
     */
    public void addSetterComment(Method method, IntrospectedTable introspectedTable, IntrospectedColumn introspectedColumn) {
    
//        if (!this.suppressAllComments) {
    
//            StringBuilder sb = new StringBuilder();
//            method.addJavaDocLine("/**");
//            method.addJavaDocLine(" * This method was generated by MyBatis Generator.");
//            sb.append(" * This method sets the value of the database column ");
//            sb.append(introspectedTable.getFullyQualifiedTable());
//            sb.append('.');
//            sb.append(introspectedColumn.getActualColumnName());
//            method.addJavaDocLine(sb.toString());
//            method.addJavaDocLine(" *");
//            Parameter parm = (Parameter)method.getParameters().get(0);
//            sb.setLength(0);
//            sb.append(" * @param ");
//            sb.append(parm.getName());
//            sb.append(" the value for ");
//            sb.append(introspectedTable.getFullyQualifiedTable());
//            sb.append('.');
//            sb.append(introspectedColumn.getActualColumnName());
//            method.addJavaDocLine(sb.toString());
//            this.addJavadocTag(method, false);
//            method.addJavaDocLine(" */");
//        }
    }

    /**
     * 给实体类添加类注释
     * @param innerClass
     * @param introspectedTable
     * @param markAsDoNotDelete
     */
    public void addClassComment(InnerClass innerClass, IntrospectedTable introspectedTable, boolean markAsDoNotDelete) {
    
        if (!this.suppressAllComments) {
    
            StringBuilder sb = new StringBuilder();
            innerClass.addJavaDocLine("/**");
            innerClass.addJavaDocLine(" * This class was generated by MyBatis Generator.");
            sb.append(" * This class corresponds to the database table ");
            sb.append(introspectedTable.getFullyQualifiedTable());
            innerClass.addJavaDocLine(sb.toString());
            this.addJavadocTag(innerClass, markAsDoNotDelete);
            innerClass.addJavaDocLine(" */");
        }
    }
}

5.2.2 引入自定义注释的类

定义好类后，需要将该类让mybatis generator知道，只需在generatorConfig.xml中配置如下：

<!--加载自定义注释的类,必须是全类名-->
<commentGenerator type="com.icbc.demo.config.MyCommentGenerator">
    <!--是否去除自动生成的注释 true是：false 否-->
    <property name="suppressAllComments" value="false"/>
</commentGenerator>

解释：type的值要使用全类名，suppressAllComments的value要为false才能开启生成注释。

5.2.3 启动mybatis generator

由于前面生成过了实体类、xxxMapper.java、xxxMapper.xml，因此 启动前要删除他们。删除完后可以启动那个main方法了。有问题的伙伴可留言。

5.3 自定义注释的原理

mybatis generator官方提供了接口给我们。原本mybatis generator就是使用DefaultCommentGenerator实现CommentGenerator接口来实现生成注释的。 如下：

因此我们实现CommetGenerator接口即可，可以将DefaultCommentGenerator中的代码全部复制过来到自己定义的类中，然后再修改成自己想要的效果。

DefaultCommentGenerator中每个方法都是通过进入if语句判断suppressAllComments是否为false，为false才能执行方法的内容，因此我们要在generatorConfig.xml中配置suppressAllComments的value为false。要想mybatis generator能调用到我们的自定义类，也需要在generatorConfig.xml中配置commentGenerator的type的值为自定义类的全类名，如下：

<!--加载自定义注释的类,必须是全类名-->
<commentGenerator type="com.icbc.demo.config.MyCommentGenerator">
    <!--是否去除自动生成的注释 true是：false 否-->
    <property name="suppressAllComments" value="false"/>
</commentGenerator>

六. 官方提供的完整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>
    <!-- 可以用于加载配置项或者配置文件，在整个配置文件中就可以使用${propertyKey}的方式来引用配置项
        resource：配置资源加载地址，使用resource，MBG从classpath开始找，比如com/myproject/generatorConfig.properties
        url：配置资源加载地质，使用URL的方式，比如file:///C:/myfolder/generatorConfig.properties.
        注意，两个属性只能选址一个;
 
        另外，如果使用了mybatis-generator-maven-plugin，那么在pom.xml中定义的properties都可以直接在generatorConfig.xml中使用
    <properties resource="" url="" />
     -->
 
    <!-- 在MBG工作的时候，需要额外加载的依赖包
       location属性指明加载jar/zip包的全路径
   <classPathEntry location="/Program Files/IBM/SQLLIB/java/db2java.zip" />
     -->
 
    <!--
        context:生成一组对象的环境
        id:必选，上下文id，用于在生成错误时提示
        defaultModelType:指定生成对象的样式
            1，conditional：类似hierarchical；
            2，flat：所有内容（主键，blob）等全部生成在一个对象中；
            3，hierarchical：主键生成一个XXKey对象(key class)，Blob等单独生成一个对象，其他简单属性在一个对象中(record class)
        targetRuntime:
            1，MyBatis3：默认的值，生成基于MyBatis3.x以上版本的内容，包括XXXBySample；
            2，MyBatis3Simple：类似MyBatis3，只是不生成XXXBySample；
        introspectedColumnImpl：类全限定名，用于扩展MBG
    -->
    <context id="mysql" defaultModelType="hierarchical" targetRuntime="MyBatis3Simple" >
 
        <!-- 自动识别数据库关键字，默认false，如果设置为true，根据SqlReservedWords中定义的关键字列表；
            一般保留默认值，遇到数据库关键字（Java关键字），使用columnOverride覆盖
         -->
        <property name="autoDelimitKeywords" value="false"/>
        <!-- 生成的Java文件的编码 -->
        <property name="javaFileEncoding" value="UTF-8"/>
        <!-- 格式化java代码 -->
        <property name="javaFormatter" value="org.mybatis.generator.api.dom.DefaultJavaFormatter"/>
        <!-- 格式化XML代码 -->
        <property name="xmlFormatter" value="org.mybatis.generator.api.dom.DefaultXmlFormatter"/>
 
        <!-- beginningDelimiter和endingDelimiter：指明数据库的用于标记数据库对象名的符号，比如ORACLE就是双引号，MYSQL默认是`反引号； -->
        <property name="beginningDelimiter" value="`"/>
        <property name="endingDelimiter" value="`"/>
 
        <!-- 必须要有的，使用这个配置链接数据库
            @TODO:是否可以扩展
         -->
        <jdbcConnection driverClass="com.mysql.jdbc.Driver" connectionURL="jdbc:mysql:///pss" userId="root" password="admin">
            <!-- 这里面可以设置property属性，每一个property属性都设置到配置的Driver上 -->
        </jdbcConnection>
 
        <!-- java类型处理器
            用于处理DB中的类型到Java中的类型，默认使用JavaTypeResolverDefaultImpl；
            注意一点，默认会先尝试使用Integer，Long，Short等来对应DECIMAL和 NUMERIC数据类型；
        -->
        <javaTypeResolver type="org.mybatis.generator.internal.types.JavaTypeResolverDefaultImpl">
            <!--
                true：使用BigDecimal对应DECIMAL和 NUMERIC数据类型
                false：默认,
                    scale>0;length>18：使用BigDecimal;
                    scale=0;length[10,18]：使用Long；
                    scale=0;length[5,9]：使用Integer；
                    scale=0;length<5：使用Short；
             -->
            <property name="forceBigDecimals" value="false"/>
        </javaTypeResolver>
 
 
        <!-- java模型创建器，是必须要的元素
            负责：1，key类（见context的defaultModelType）；2，java类；3，查询类
            targetPackage：生成的类要放的包，真实的包受enableSubPackages属性控制；
            targetProject：目标项目，指定一个存在的目录下，生成的内容会放到指定目录中，如果目录不存在，MBG不会自动建目录
         -->
        <javaModelGenerator targetPackage="com._520it.mybatis.domain" targetProject="src/main/java">
            <!--  for MyBatis3/MyBatis3Simple
                自动为每一个生成的类创建一个构造方法，构造方法包含了所有的field；而不是使用setter；
             -->
            <property name="constructorBased" value="false"/>
 
            <!-- 在targetPackage的基础上，根据数据库的schema再生成一层package，最终生成的类放在这个package下，默认为false -->
            <property name="enableSubPackages" value="true"/>
 
            <!-- for MyBatis3 / MyBatis3Simple
                是否创建一个不可变的类，如果为true，
                那么MBG会创建一个没有setter方法的类，取而代之的是类似constructorBased的类
             -->
            <property name="immutable" value="false"/>
 
            <!-- 设置一个根对象，
                如果设置了这个根对象，那么生成的keyClass或者recordClass会继承这个类；在Table的rootClass属性中可以覆盖该选项
                注意：如果在key class或者record class中有root class相同的属性，MBG就不会重新生成这些属性了，包括：
                    1，属性名相同，类型相同，有相同的getter/setter方法；
             -->
            <property name="rootClass" value="com._520it.mybatis.domain.BaseDomain"/>
 
            <!-- 设置是否在getter方法中，对String类型字段调用trim()方法 -->
            <property name="trimStrings" value="true"/>
        </javaModelGenerator>
 
 
        <!-- 生成SQL map的XML文件生成器，
            注意，在Mybatis3之后，我们可以使用mapper.xml文件+Mapper接口（或者不用mapper接口），
                或者只使用Mapper接口+Annotation，所以，如果 javaClientGenerator配置中配置了需要生成XML的话，这个元素就必须配置
            targetPackage/targetProject:同javaModelGenerator
         -->
        <sqlMapGenerator targetPackage="com._520it.mybatis.mapper" targetProject="src/main/resources">
            <!-- 在targetPackage的基础上，根据数据库的schema再生成一层package，最终生成的类放在这个package下，默认为false -->
            <property name="enableSubPackages" value="true"/>
        </sqlMapGenerator>
 
 
        <!-- 对于mybatis来说，即生成Mapper接口，注意，如果没有配置该元素，那么默认不会生成Mapper接口
            targetPackage/targetProject:同javaModelGenerator
            type：选择怎么生成mapper接口（在MyBatis3/MyBatis3Simple下）：
                1，ANNOTATEDMAPPER：会生成使用Mapper接口+Annotation的方式创建（SQL生成在annotation中），不会生成对应的XML；
                2，MIXEDMAPPER：使用混合配置，会生成Mapper接口，并适当添加合适的Annotation，但是XML会生成在XML中；
                3，XMLMAPPER：会生成Mapper接口，接口完全依赖XML；
            注意，如果context是MyBatis3Simple：只支持ANNOTATEDMAPPER和XMLMAPPER
        -->
        <javaClientGenerator targetPackage="com._520it.mybatis.mapper" type="ANNOTATEDMAPPER" targetProject="src/main/java">
            <!-- 在targetPackage的基础上，根据数据库的schema再生成一层package，最终生成的类放在这个package下，默认为false -->
            <property name="enableSubPackages" value="true"/>
 
            <!-- 可以为所有生成的接口添加一个父接口，但是MBG只负责生成，不负责检查
            <property name="rootInterface" value=""/>
             -->
        </javaClientGenerator>
 
        <!-- 选择一个table来生成相关文件，可以有一个或多个table，必须要有table元素
            选择的table会生成一下文件：
            1，SQL map文件
            2，生成一个主键类；
            3，除了BLOB和主键的其他字段的类；
            4，包含BLOB的类；
            5，一个用户生成动态查询的条件类（selectByExample, deleteByExample），可选；
            6，Mapper接口（可选）
 
            tableName（必要）：要生成对象的表名；
            注意：大小写敏感问题。正常情况下，MBG会自动的去识别数据库标识符的大小写敏感度，在一般情况下，MBG会
                根据设置的schema，catalog或tablename去查询数据表，按照下面的流程：
                1，如果schema，catalog或tablename中有空格，那么设置的是什么格式，就精确的使用指定的大小写格式去查询；
                2，否则，如果数据库的标识符使用大写的，那么MBG自动把表名变成大写再查找；
                3，否则，如果数据库的标识符使用小写的，那么MBG自动把表名变成小写再查找；
                4，否则，使用指定的大小写格式查询；
            另外的，如果在创建表的时候，使用的""把数据库对象规定大小写，就算数据库标识符是使用的大写，在这种情况下也会使用给定的大小写来创建表名；
            这个时候，请设置delimitIdentifiers="true"即可保留大小写格式；
 
            可选：
            1，schema：数据库的schema；
            2，catalog：数据库的catalog；
            3，alias：为数据表设置的别名，如果设置了alias，那么生成的所有的SELECT SQL语句中，列名会变成：alias_actualColumnName
            4，domainObjectName：生成的domain类的名字，如果不设置，直接使用表名作为domain类的名字；可以设置为somepck.domainName，那么会自动把domainName类再放到somepck包里面；
            5，enableInsert（默认true）：指定是否生成insert语句；
            6，enableSelectByPrimaryKey（默认true）：指定是否生成按照主键查询对象的语句（就是getById或get）；
            7，enableSelectByExample（默认true）：MyBatis3Simple为false，指定是否生成动态查询语句；
            8，enableUpdateByPrimaryKey（默认true）：指定是否生成按照主键修改对象的语句（即update)；
            9，enableDeleteByPrimaryKey（默认true）：指定是否生成按照主键删除对象的语句（即delete）；
            10，enableDeleteByExample（默认true）：MyBatis3Simple为false，指定是否生成动态删除语句；
            11，enableCountByExample（默认true）：MyBatis3Simple为false，指定是否生成动态查询总条数语句（用于分页的总条数查询）；
            12，enableUpdateByExample（默认true）：MyBatis3Simple为false，指定是否生成动态修改语句（只修改对象中不为空的属性）；
            13，modelType：参考context元素的defaultModelType，相当于覆盖；
            14，delimitIdentifiers：参考tableName的解释，注意，默认的delimitIdentifiers是双引号，如果类似MYSQL这样的数据库，使用的是`（反引号，那么还需要设置context的beginningDelimiter和endingDelimiter属性）
            15，delimitAllColumns：设置是否所有生成的SQL中的列名都使用标识符引起来。默认为false，delimitIdentifiers参考context的属性
 
            注意，table里面很多参数都是对javaModelGenerator，context等元素的默认属性的一个复写；
         -->
        <table tableName="userinfo" >
 
            <!-- 参考 javaModelGenerator 的 constructorBased属性-->
            <property name="constructorBased" value="false"/>
 
            <!-- 默认为false，如果设置为true，在生成的SQL中，table名字不会加上catalog或schema； -->
            <property name="ignoreQualifiersAtRuntime" value="false"/>
 
            <!-- 参考 javaModelGenerator 的 immutable 属性 -->
            <property name="immutable" value="false"/>
 
            <!-- 指定是否只生成domain类，如果设置为true，只生成domain类，如果还配置了sqlMapGenerator，那么在mapper XML文件中，只生成resultMap元素 -->
            <property name="modelOnly" value="false"/>
 
            <!-- 参考 javaModelGenerator 的 rootClass 属性
            <property name="rootClass" value=""/>
             -->
 
            <!-- 参考javaClientGenerator 的  rootInterface 属性
            <property name="rootInterface" value=""/>
            -->
 
            <!-- 如果设置了runtimeCatalog，那么在生成的SQL中，使用该指定的catalog，而不是table元素上的catalog
            <property name="runtimeCatalog" value=""/>
            -->
 
            <!-- 如果设置了runtimeSchema，那么在生成的SQL中，使用该指定的schema，而不是table元素上的schema
            <property name="runtimeSchema" value=""/>
            -->
 
            <!-- 如果设置了runtimeTableName，那么在生成的SQL中，使用该指定的tablename，而不是table元素上的tablename
            <property name="runtimeTableName" value=""/>
            -->
 
            <!-- 注意，该属性只针对MyBatis3Simple有用；
                如果选择的runtime是MyBatis3Simple，那么会生成一个SelectAll方法，如果指定了selectAllOrderByClause，那么会在该SQL中添加指定的这个order条件；
             -->
            <property name="selectAllOrderByClause" value="age desc,username asc"/>
 
            <!-- 如果设置为true，生成的model类会直接使用column本身的名字，而不会再使用驼峰命名方法，比如BORN_DATE，生成的属性名字就是BORN_DATE,而不会是bornDate -->
            <property name="useActualColumnNames" value="false"/>
 
 
            <!-- generatedKey用于生成生成主键的方法，
                如果设置了该元素，MBG会在生成的<insert>元素中生成一条正确的<selectKey>元素，该元素可选
                column:主键的列名；
                sqlStatement：要生成的selectKey语句，有以下可选项：
                    Cloudscape:相当于selectKey的SQL为： VALUES IDENTITY_VAL_LOCAL()
                    DB2       :相当于selectKey的SQL为： VALUES IDENTITY_VAL_LOCAL()
                    DB2_MF    :相当于selectKey的SQL为：SELECT IDENTITY_VAL_LOCAL() FROM SYSIBM.SYSDUMMY1
                    Derby     :相当于selectKey的SQL为：VALUES IDENTITY_VAL_LOCAL()
                    HSQLDB    :相当于selectKey的SQL为：CALL IDENTITY()
                    Informix  :相当于selectKey的SQL为：select dbinfo('sqlca.sqlerrd1') from systables where tabid=1
                    MySql     :相当于selectKey的SQL为：SELECT LAST_INSERT_ID()
                    SqlServer :相当于selectKey的SQL为：SELECT SCOPE_IDENTITY()
                    SYBASE    :相当于selectKey的SQL为：SELECT @@IDENTITY
                    JDBC      :相当于在生成的insert元素上添加useGeneratedKeys="true"和keyProperty属性
            <generatedKey column="" sqlStatement=""/>
             -->
 
            <!--
                该元素会在根据表中列名计算对象属性名之前先重命名列名，非常适合用于表中的列都有公用的前缀字符串的时候，
                比如列名为：CUST_ID,CUST_NAME,CUST_EMAIL,CUST_ADDRESS等；
                那么就可以设置searchString为"^CUST_"，并使用空白替换，那么生成的Customer对象中的属性名称就不是
                custId,custName等，而是先被替换为ID,NAME,EMAIL,然后变成属性：id，name，email；
 
                注意，MBG是使用java.util.regex.Matcher.replaceAll来替换searchString和replaceString的，
                如果使用了columnOverride元素，该属性无效；
 
            <columnRenamingRule searchString="" replaceString=""/>
             -->
 
 
            <!-- 用来修改表中某个列的属性，MBG会使用修改后的列来生成domain的属性；
               column:要重新设置的列名；
               注意，一个table元素中可以有多个columnOverride元素哈~
             -->
            <columnOverride column="username">
                <!-- 使用property属性来指定列要生成的属性名称 -->
                <property name="property" value="userName"/>
 
                <!-- javaType用于指定生成的domain的属性类型，使用类型的全限定名
                <property name="javaType" value=""/>
                 -->
 
                <!-- jdbcType用于指定该列的JDBC类型
                <property name="jdbcType" value=""/>
                 -->
 
                <!-- typeHandler 用于指定该列使用到的TypeHandler，如果要指定，配置类型处理器的全限定名
                    注意，mybatis中，不会生成到mybatis-config.xml中的typeHandler
                    只会生成类似：where id = #{id,jdbcType=BIGINT,typeHandler=com._520it.mybatis.MyTypeHandler}的参数描述
                <property name="jdbcType" value=""/>
                -->
 
                <!-- 参考table元素的delimitAllColumns配置，默认为false
                <property name="delimitedColumnName" value=""/>
                 -->
            </columnOverride>
 
            <!-- ignoreColumn设置一个MGB忽略的列，如果设置了改列，那么在生成的domain中，生成的SQL中，都不会有该列出现
               column:指定要忽略的列的名字；
               delimitedColumnName：参考table元素的delimitAllColumns配置，默认为false
 
               注意，一个table元素中可以有多个ignoreColumn元素
            <ignoreColumn column="deptId" delimitedColumnName=""/>
            -->
        </table>
 
    </context>
 
</generatorConfiguration>

有问题的伙伴可留言。