springboot项目使用generatorConfig生成pojo类

一、 本文内容

在搭建项目的pojo层时，我们要根据数据库中的表搭建一个个实体类，当实体类很多时，会很麻烦，这时我们使用generatorConfig生成pojo类，节约大量时间。
在扩展内容中，会重写方法，实现字段添加数据库注解。

二、实现过程

1. 添加pom.xml内容

    <dependency>
            <groupId>org.mybatis.generator</groupId>
            <artifactId>mybatis-generator-core</artifactId>
            <version>1.3.6</version>
        </dependency>
    </dependencies>
<build>
        <plugins>
            <!--mybatis自动生成代码插件-->
            <plugin>
                <groupId>org.mybatis.generator</groupId>
                <artifactId>mybatis-generator-maven-plugin</artifactId>
                <version>1.3.6</version>
                <configuration>
                    <!-- 是否覆盖，true表示会替换生成的JAVA文件，false则不覆盖 -->
                    <overwrite>true</overwrite>
                </configuration>
                <dependencies>
                    <!--mysql驱动包-->
                    <dependency>
                        <groupId>mysql</groupId>
                        <artifactId>mysql-connector-java</artifactId>
                        <version>5.1.45</version>
                    </dependency>
                </dependencies>
            </plugin>

            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

2. 在resources目录下添加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="MySql">
    <commentGenerator>
        <!-- 是否去除自动生成的注释 true：是 ： false:否 -->
        <property name="suppressAllComments" value="true"/>
        <!--生成的注释包含时间戳-->
        <property name="suppressDate" value="true"/>
    </commentGenerator>
    <!--数据库连接的信息：驱动类、连接地址、用户名、密码 -->
    <jdbcConnection
            driverClass="com.mysql.jdbc.Driver"
            connectionURL="jdbc:mysql://localhost:3306/huaweiyun?useUnicode=true&amp;characterEncoding=UTF8"
            userId="root"
            password="123"/>
    <!-- 生成模型的包名和位置-->
    <javaModelGenerator targetPackage="com.example.mybatispojo.pojo" targetProject="src/main/java"></javaModelGenerator>
    <!--useActualColumnNames为true代表与数据库字段名一样，false代表驼峰式命名-->
    <table tableName="user"><property  name="useActualColumnNames"  value="true" /></table>
    <table tableName="goods"><property  name="useActualColumnNames"  value="true" /></table>
    <table tableName="miaosha_goods"><property  name="useActualColumnNames"  value="true" /></table>
    <table tableName="order_info"><property  name="useActualColumnNames"  value="true" /></table>
</context>
</generatorConfiguration>

3. 生成pojo文件

点击右侧Maven中的Plugins下的mybatis-generator

4. 如果要自动生成dao层与映射文件

<!-- 生成映射文件的包名和位置-->
<?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="MySql">
    <commentGenerator>
        <!-- 是否去除自动生成的注释 true：是 ： false:否 -->
        <property name="suppressAllComments" value="true"/>
        <!--生成的注释包含时间戳-->
        <property name="suppressDate" value="true"/>
    </commentGenerator>
    <!--数据库连接的信息：驱动类、连接地址、用户名、密码 -->
    <jdbcConnection
            driverClass="com.mysql.jdbc.Driver"
            connectionURL="jdbc:mysql://localhost:3306/huaweiyun?useUnicode=true&amp;characterEncoding=UTF8"
            userId="root"
            password="123"/>

    <!-- 生成模型的包名和位置-->
    <javaModelGenerator targetPackage="com.example.mybatispojo.pojo" targetProject="src/main/java"></javaModelGenerator>

    <!-- 生成映射文件的包名和位置-->
    <sqlMapGenerator targetPackage="mapper" targetProject="src/main/resources">
        <property name="enableSubPackages" value="true"/>
    </sqlMapGenerator>
    <!-- 生成DAO的包名和位置-->
    <javaClientGenerator type="XMLMAPPER" targetPackage="com.example.mybatispojo.repository" targetProject="src/main/java">
        <property name="enableSubPackages" value="true"/>
    </javaClientGenerator>

    <!-- 要生成的表 tableName是数据库中的表名或视图名 domainObjectName是实体类名，不写默认与tableName相同-->
    <table tableName="user"></table>
    <table tableName="goods"></table>
    <table tableName="miaosha_goods"></table>
    <table tableName="order_info"></table>


</context>
</generatorConfiguration>

三、扩展

我发现generatorConfig自动生成的注解不会将数据库中的注解导入。为了解决这个问题，我们重写一下方法。

1. 重写CommentGenerator

package com.example.mybatispojo.util;

import org.mybatis.generator.api.IntrospectedColumn;
import org.mybatis.generator.api.IntrospectedTable;
import org.mybatis.generator.api.dom.java.Field;
import org.mybatis.generator.api.dom.java.InnerClass;
import org.mybatis.generator.api.dom.java.Method;
import org.mybatis.generator.internal.DefaultCommentGenerator;

import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.Properties;

/**
 * mybatis generator生成注释插件
 */
public class MyCommentGenerator extends DefaultCommentGenerator {
    private Properties properties;
    private Properties systemPro;
    private boolean suppressDate;
    private boolean suppressAllComments;
    private String currentDateStr;

    public MyCommentGenerator() {
        super();
        properties = new Properties();
        systemPro = System.getProperties();
        suppressDate = false;
        suppressAllComments = false;
        currentDateStr = (new SimpleDateFormat("yyyy-MM-dd")).format(new Date());
    }


    public void addFieldComment(Field field, IntrospectedTable introspectedTable,
                                IntrospectedColumn introspectedColumn) {
        if (suppressAllComments) {
            return;
        }
        StringBuilder sb = new StringBuilder();
        field.addJavaDocLine("/**");
        sb.append(" * ");
        sb.append(introspectedColumn.getRemarks());
        field.addJavaDocLine(sb.toString().replace("\n", " "));
        field.addJavaDocLine(" */");
    }

    public void addFieldComment(Field field, IntrospectedTable introspectedTable) {

    }

    public void addGeneralMethodComment(Method method, IntrospectedTable introspectedTable) {

    }

    public void addGetterComment(Method method, IntrospectedTable introspectedTable,
                                 IntrospectedColumn introspectedColumn) {

    }

    public void addSetterComment(Method method, IntrospectedTable introspectedTable,
                                 IntrospectedColumn introspectedColumn) {

    }

    public void addClassComment(InnerClass innerClass, IntrospectedTable introspectedTable, boolean markAsDoNotDelete) {

    }

    public void addClassComment(InnerClass innerClass, IntrospectedTable introspectedTable) {
    }


}

2. 添加启动方法

注意：这次不用maven的插件生成pojo类，因为插件是一个独立的环境，我们重写了jar包中的方法，但插件用的是自己的jar包，与我们重写的jar包不是同一个，所以会报错。

    package com.example.mybatispojo.util;

import org.mybatis.generator.api.MyBatisGenerator;
import org.mybatis.generator.config.Configuration;
import org.mybatis.generator.config.xml.ConfigurationParser;
import org.mybatis.generator.internal.DefaultShellCallback;

import java.io.InputStream;
import java.util.ArrayList;
import java.util.List;

/**
 * 运行此方法生成mybatis代码
 * 生成代码自动放入对应目录
 * 配置文件targetProject应从项目名称开始到要生成到的classpath
 */
public class MyBatisGeneratorRun {

    public static void main(String[] args) throws Exception{
        MyBatisGeneratorRun app = new MyBatisGeneratorRun();

        System.out.println(app.getClass().getResource("/").getPath());
        app.generator();
        System.out.println(System.getProperty("user.dir"));
    }

    public void generator() throws Exception{

        List<String> warnings = new ArrayList<String>();
        boolean overwrite = true;
        InputStream resourceAsStream = this.getClass().getClassLoader().getResourceAsStream("generatorConfig.xml");
        ConfigurationParser cp = new ConfigurationParser(warnings);
        Configuration config = cp.parseConfiguration(resourceAsStream);
        DefaultShellCallback callback = new DefaultShellCallback(overwrite);
        MyBatisGenerator myBatisGenerator = new MyBatisGenerator(config, callback, warnings);
        myBatisGenerator.generate(null);

        for(String warning:warnings){
            System.out.println(warning);
        }
    }
}

3.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="MySql">

    <!-- 使用自定义的插件 -->
    <commentGenerator type="com.example.mybatispojo.util.MyCommentGenerator">

    </commentGenerator>
    <!--数据库连接的信息：驱动类、连接地址、用户名、密码 -->
    <jdbcConnection
            driverClass="com.mysql.cj.jdbc.Driver"
            connectionURL="jdbc:mysql://localhost:3306/huaweiyun?useUnicode=true&amp;characterEncoding=UTF8"
            userId="root"
            password="123">
    <property name="nullCatalogMeansCurrent" value="true"/>
    </jdbcConnection>

    <!-- 生成模型的包名和位置-->
    <javaModelGenerator targetPackage="com.example.mybatispojo.pojo" targetProject="src/main/java"></javaModelGenerator>


    <!-- 要生成的表 tableName是数据库中的表名或视图名 domainObjectName是实体类名，不写默认与tableName相同-->
    <table tableName="user"></table>
    <table tableName="goods"></table>
    <table tableName="miaosha_goods"></table>
    <table tableName="order_info"></table>
    <table tableName="miaosha_order"></table>
    <table tableName="test_table"></table>

</context>
</generatorConfiguration>