MyBatis Generator 生成数据库自带中文注释

时间：2021-01-21 06:17:23

1. maven依赖

<!-- mybatis生成 jar包 -->

<dependency>

     <groupId>org.mybatis.generator</groupId>

     <artifactId>mybatis-generator-core</artifactId>

     <version>1.3.2</version>

</dependency>

<!-- oracle jar包 -->

<dependency>

     <groupId>com.oracle</groupId>

     <artifactId>ojdbc6</artifactId>

     <version>6.0</version>

</dependency>

<!-- mysql jar包 -->

<dependency>

     <groupId>mysql</groupId>

     <artifactId>mysql-connector-java</artifactId>

     <version>5.1.9</version>

</dependency>

2. 自定义的CommentGenerator类

package org.mybatis.generator;

import static org.mybatis.generator.internal.util.StringUtility.isTrue;

import java.text.SimpleDateFormat;

import java.util.Date;

import java.util.Properties;

import org.mybatis.generator.api.CommentGenerator;

import org.mybatis.generator.api.IntrospectedColumn;

import org.mybatis.generator.api.IntrospectedTable;

import org.mybatis.generator.api.dom.java.CompilationUnit;

import org.mybatis.generator.api.dom.java.Field;

import org.mybatis.generator.api.dom.java.InnerClass;

import org.mybatis.generator.api.dom.java.InnerEnum;

import org.mybatis.generator.api.dom.java.JavaElement;

import org.mybatis.generator.api.dom.java.Method;

import org.mybatis.generator.api.dom.java.Parameter;

import org.mybatis.generator.api.dom.xml.XmlElement;

import org.mybatis.generator.config.MergeConstants;

import org.mybatis.generator.config.PropertyRegistry;

/**

 * @作者：wangbing

 * @修改记录：

 */

public class MyCommentGenerator implements CommentGenerator{

    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 addJavaFileComment(CompilationUnit compilationUnit) {

        // add no file level comments by default

        return;

    }

    /**

     * Adds a suitable comment to warn users that the element was generated, and

     * when it was generated.

     */

    public void addComment(XmlElement xmlElement) {

        return;

    }

    public void addRootComment(XmlElement rootElement) {

        // add no document level comments by default

        return;

    }

    public void addConfigurationProperties(Properties properties) {

        this.properties.putAll(properties);

        suppressDate = isTrue(properties.getProperty(PropertyRegistry.COMMENT_GENERATOR_SUPPRESS_DATE));

        suppressAllComments = isTrue(properties.getProperty(PropertyRegistry.COMMENT_GENERATOR_SUPPRESS_ALL_COMMENTS));

    }

    /**

     * This method adds the custom javadoc tag for. You may do nothing if you do

     * not wish to include the Javadoc tag - however, if you do not include the

     * Javadoc tag then the Java merge capability of the eclipse plugin will

     * break.

     *

     * @param javaElement

     *            the java element

     */

    protected void addJavadocTag(JavaElement javaElement, boolean markAsDoNotDelete) {

        javaElement.addJavaDocLine(" *");

        StringBuilder sb = new StringBuilder();

        sb.append(" * ");

        sb.append(MergeConstants.NEW_ELEMENT_TAG);

        if (markAsDoNotDelete) {

            sb.append(" do_not_delete_during_merge");

        }

        String s = getDateString();

        if (s != null) {

            sb.append(' ');

            sb.append(s);

        }

        javaElement.addJavaDocLine(sb.toString());

    }

    /**

     * This method returns a formated date string to include in the Javadoc tag

     * and XML comments. You may return null if you do not want the date in

     * these documentation elements.

     *

     * @return a string representing the current timestamp, or null

     */

    protected String getDateString() {

        String result = null;

        if (!suppressDate) {

            result = currentDateStr;

        }

        return result;

    }

    public void addClassComment(InnerClass innerClass, IntrospectedTable introspectedTable) {

        if (suppressAllComments) {

            return;

        }

        StringBuilder sb = new StringBuilder();

        innerClass.addJavaDocLine("/**");

        sb.append(" * ");

        sb.append(introspectedTable.getFullyQualifiedTable());

        sb.append(" ");

        sb.append(getDateString());

        innerClass.addJavaDocLine(sb.toString().replace("\n", " "));

        innerClass.addJavaDocLine(" */");

    }

    public void addEnumComment(InnerEnum innerEnum, IntrospectedTable introspectedTable) {

        if (suppressAllComments) {

            return;

        }

        StringBuilder sb = new StringBuilder();

        innerEnum.addJavaDocLine("/**");

        sb.append(" * ");

        sb.append(introspectedTable.getFullyQualifiedTable());

        innerEnum.addJavaDocLine(sb.toString().replace("\n", " "));

        innerEnum.addJavaDocLine(" */");

    }

    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) {

        if (suppressAllComments) {

            return;

        }

        StringBuilder sb = new StringBuilder();

        field.addJavaDocLine("/**");

        sb.append(" * ");

        sb.append(introspectedTable.getFullyQualifiedTable());

        field.addJavaDocLine(sb.toString().replace("\n", " "));

        field.addJavaDocLine(" */");

    }

    public void addGeneralMethodComment(Method method, IntrospectedTable introspectedTable) {

        if (suppressAllComments) {

            return;

        }

      method.addJavaDocLine("/**");

      addJavadocTag(method, false);

      method.addJavaDocLine(" */");

    }

    public void addGetterComment(Method method, IntrospectedTable introspectedTable,

            IntrospectedColumn introspectedColumn) {

        if (suppressAllComments) {

            return;

        }

        method.addJavaDocLine("/**");

        StringBuilder sb = new StringBuilder();

        sb.append(" * ");

        sb.append(introspectedColumn.getRemarks());

        method.addJavaDocLine(sb.toString().replace("\n", " "));

        sb.setLength(0);

        sb.append(" * @return ");

        sb.append(introspectedColumn.getActualColumnName());

        sb.append(" ");

        sb.append(introspectedColumn.getRemarks());

        method.addJavaDocLine(sb.toString().replace("\n", " "));

        method.addJavaDocLine(" */");

    }

    public void addSetterComment(Method method, IntrospectedTable introspectedTable,

            IntrospectedColumn introspectedColumn) {

        if (suppressAllComments) {

            return;

        }

        method.addJavaDocLine("/**");

        StringBuilder sb = new StringBuilder();

        sb.append(" * ");

        sb.append(introspectedColumn.getRemarks());

        method.addJavaDocLine(sb.toString().replace("\n", " "));

        Parameter parm = method.getParameters().get(0);

        sb.setLength(0);

        sb.append(" * @param ");

        sb.append(parm.getName());

        sb.append(" ");

        sb.append(introspectedColumn.getRemarks());

        method.addJavaDocLine(sb.toString().replace("\n", " "));

        method.addJavaDocLine(" */");

    }

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

        if (suppressAllComments) {

            return;

        }

        StringBuilder sb = new StringBuilder();

        innerClass.addJavaDocLine("/**");

        sb.append(" * ");

        sb.append(introspectedTable.getFullyQualifiedTable());

        innerClass.addJavaDocLine(sb.toString().replace("\n", " "));

        sb.setLength(0);

        sb.append(" * @author ");

        sb.append(systemPro.getProperty("user.name"));

        sb.append(" ");

        sb.append(currentDateStr);

        innerClass.addJavaDocLine(" */");

    }

}

生成注释相关类

MyCommentGenerator

3. 入口，执行类文

package org.mybatis.generator;

import java.io.IOException;

import java.io.InputStream;

import java.net.URISyntaxException;

import java.sql.SQLException;

import java.util.ArrayList;

import java.util.List;

import org.mybatis.generator.api.MyBatisGenerator;

import org.mybatis.generator.config.Configuration;

import org.mybatis.generator.config.xml.ConfigurationParser;

import org.mybatis.generator.exception.InvalidConfigurationException;

import org.mybatis.generator.exception.XMLParserException;

import org.mybatis.generator.internal.DefaultShellCallback;

/**

 * @作者：wangbing

 */

public class StartUp {

    public static void main(String[] args) throws URISyntaxException {

        try {

            List<String> warnings = new ArrayList<String>();

            boolean overwrite = true;

            ClassLoader classloader = Thread.currentThread().getContextClassLoader();

            InputStream is = classloader.getResourceAsStream("generatorConfig.xml");

            ConfigurationParser cp = new ConfigurationParser(warnings);

            Configuration config = cp.parseConfiguration(is);

            DefaultShellCallback callback = new DefaultShellCallback(overwrite);

            MyBatisGenerator myBatisGenerator = new MyBatisGenerator(config, callback, warnings);

            myBatisGenerator.generate(null);

        } catch (SQLException e) {

            e.printStackTrace();

        } catch (IOException e) {

            e.printStackTrace();

        } catch (InterruptedException e) {

            e.printStackTrace();

        } catch (InvalidConfigurationException e) {

            e.printStackTrace();

        } catch (XMLParserException e) {

            e.printStackTrace();

        }

    }

}

main方法，执行入口

Generator启动类

4. 配置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">

        <commentGenerator type="com.wormpex.study.mybatisgenerator.MyCommentGenerator">

            <!--<property name="suppressDate" value="true"/>

            <property name="suppressAllComments" value="true"/>-->

        </commentGenerator>

        <!--数据库链接地址账号密码-->

        <jdbcConnection driverClass="com.mysql.jdbc.Driver" connectionURL="jdbc:mysql://10.255.207.84:33006/team8" userId="dev" password="21758e78331b20e4">

        </jdbcConnection>

        <javaTypeResolver>

            <property name="forceBigDecimals" value="false"/>

        </javaTypeResolver>

        <!--生成Model类存放位置-->

        <javaModelGenerator targetPackage="com.wormpex.study.entity" targetProject="src/main/java">

            <property name="enableSubPackages" value="true"/>

            <property name="trimStrings" value="true"/>

        </javaModelGenerator>

        <!--生成映射文件存放位置-->

        <sqlMapGenerator targetPackage="com.wormpex.study.mapper" targetProject="src/main/java">

            <property name="enableSubPackages" value="true"/>

        </sqlMapGenerator>

        <!--生成Dao类存放位置-->

        <!-- 客户端代码，生成易于使用的针对Model对象和XML配置文件 的代码

                type="ANNOTATEDMAPPER",生成Java Model 和基于注解的Mapper对象

                type="MIXEDMAPPER",生成基于注解的Java Model 和相应的Mapper对象

                type="XMLMAPPER",生成SQLMap XML文件和独立的Mapper接口

        -->

        <javaClientGenerator type="XMLMAPPER" targetPackage="com.wormpex.study.dao" targetProject="src/main/java">

            <property name="enableSubPackages" value="true"/>

        </javaClientGenerator>

        <!--生成对应表及类名-->

        <table tableName="product" domainObjectName="product" enableCountByExample="false" enableUpdateByExample="false" enableDeleteByExample="false" enableSelectByExample="false" selectByExampleQueryId="false"></table>

    </context>

</generatorConfiguration>

generatorConfig.xml

相关文章