MyBatis Generator系列(二)----自定义CommentGenerator实现中文注释

àì夳堔傛蜴生んèń 2022-06-07 01:56 224阅读 0赞

**一、简介**

由于MyBatis Generator自带了生成注释的功能,但是,是英文的而且生成的根本无法理解,所以可以通过,修改他的源码来实现生成中文的注释,具体方式有以下几种:

1) 自定义CommentGenerator

2) 修改源码

3) PluginAdapter插件的形式

**二、自定义CommentGenerator实现中文注释**

**2.1、先创建Maven项目**

![20171005142947196][]

然后右键项目->new->source folder,输入src/main/resources,建好resources目录

![20171005143236948][]

然后在POM.XML中加入以下依赖:

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
      <modelVersion>4.0.0</modelVersion>
    
      <groupId>com.fendo</groupId>
      <artifactId>mybatis-generator-plus</artifactId>
      <version>0.0.1-SNAPSHOT</version>
      <packaging>jar</packaging>
    
      <name>mybatis-generator-plus</name>
      <url>http://maven.apache.org</url>
    
      <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
      </properties>
    
      <dependencies>
    	<dependency>
    	    <groupId>junit</groupId>
    	    <artifactId>junit</artifactId>
    	    <version>4.12</version>
    	    <scope>test</scope>
    	</dependency>
    	
    	<dependency>
    	    <groupId>org.mybatis.generator</groupId>
    	    <artifactId>mybatis-generator-core</artifactId>
    	    <version>1.3.5</version>
        </dependency>
    	<dependency>
    	     <groupId>com.oracle</groupId>
    	     <artifactId>ojdbc6</artifactId>
    	     <version>6.0</version>
    	</dependency>
    	<dependency>
    	     <groupId>mysql</groupId>
    	     <artifactId>mysql-connector-java</artifactId>
    	     <version>5.1.9</version>
    	</dependency>
    	
      </dependencies>
      <build>
        <finalName>mybatis-generator-plus</finalName>
        <plugins>
          	<plugin>
    	    	<groupId>org.apache.maven.plugins</groupId>
    	    	<artifactId>maven-compiler-plugin</artifactId>
    	    	<version>2.3.2</version>
    	    	<configuration>
    	    	  <source>1.8</source>
    	    	  <target>1.8</target>
    	    	</configuration>
    	    </plugin>
        </plugins>
       </build>
      
    </project>

引入了mybatis-generator-core1.3.5和mysql,oracle。

注意:

ojdbc6需要自己手动进行安装,下载ojdbc6之后，通过以下命令进行安装:

mvn install:install-file -Dfile=C:/Users/fendo/Downloads/ojdbc6.jar -DgroupId=com.oracle -DartifactId=ojdbc6 -Dversion=6.0 -Dpackaging=jar -DgeneratePom=true

**2.2、创建MyCommentGenerator类实现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.TopLevelClass;
    import org.mybatis.generator.api.dom.xml.TextElement;
    import org.mybatis.generator.api.dom.xml.XmlElement;
    import org.mybatis.generator.api.dom.java.Parameter;
    import org.mybatis.generator.config.MergeConstants;
    import org.mybatis.generator.config.PropertyRegistry;
    
    /**   
     * @Title: MyCommentGenerator.java 
     * @Package com.fendo.mybatis_generator_plus 
     * @Description:  mybatis generator 自定义comment生成器.
     *                基于MBG 1.3.5
     * @author fendo
     * @date 2017年10月5日 下午3:07:26 
     * @version V1.0   
    */
    public class MyCommentGenerator implements CommentGenerator{
    
        /**
          * properties配置文件
         */
        private Properties 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());
        }
        
        /**
         * Java类的类注释
         */
    	@Override
    	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(" */");
    	}
    
    	/**
    	 * 为类添加注释
    	 */
    	@Override
    	public void addClassComment(InnerClass innerClass, IntrospectedTable introspectedTable, boolean markAsDoNotDelete) {
    		if (suppressAllComments) {
                return;
            }
            StringBuilder sb = new StringBuilder();
            innerClass.addJavaDocLine("/**");
            sb.append(" * ");
            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(" */");
    	}
    
    	
    	/**
    	 * Mybatis的Mapper.xml文件里面的注释
    	 */
    	@Override
    	public void addComment(XmlElement xmlElement) {
    		
    	}
    
    	/**
    	 * 
    	 *@Title addConfigurationProperties 
    	 *@Description: 从该配置中的任何属性添加此实例的属性CommentGenerator配置。
    	 *              这个方法将在任何其他方法之前被调用。
    	 *@Author fendo
    	 *@Date 2017年10月5日 下午3:45:58
    	 *@return
    	 *@throws
    	 */
    	@Override
    	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));
    	}
    
    	/**
    	 * 
    	 *@Title getDateString 
    	 *@Description: 此方法返回格式化的日期字符串以包含在Javadoc标记中和XML注释。 如果您不想要日期，则可以返回null在这些文档元素中。
    	 *@Author fendo
    	 *@Date 2017年10月5日 下午3:45:58
    	 *@return
    	 *@throws
    	 */
        protected String getDateString() {
            String result = null;
            if (!suppressDate) {
                result = currentDateStr;
            }
            return result;
        }
        
        /**
         * 
         *@Title addJavadocTag 
         *@Description: 此方法为其添加了自定义javadoc标签。
         *@Author fendo
         *@Date 2017年10月5日 下午3:49:05
         *@param javaElement
         *@param markAsDoNotDelete
         *@throws
         */
    	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());
        }
    	
    	
    	/**
    	 * 为枚举添加注释
    	 */
    	@Override
    	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(" */");
    	}
    
    	/**
    	 * Java属性注释
    	 */
    	@Override
    	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(" */");
            
            
            
    	}
    
    	/**
    	 * 为字段添加注释
    	 */
    	@Override
    	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(" */");
    	}
    
    	/**
    	 * 普通方法的注释，这里主要是XXXMapper.java里面的接口方法的注释
    	 */
    	@Override
    	public void addGeneralMethodComment(Method method, IntrospectedTable introspectedTable) {
    	  if (suppressAllComments) {
            return;
          }
          method.addJavaDocLine("/**");
          addJavadocTag(method, false);
          method.addJavaDocLine(" */");
    	}
    
    	
    	/**
    	 * 给getter方法加注释
    	 */
    	@Override
    	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(" */");
    	}
    
    	/**
    	 * 给Java文件加注释，这个注释是在文件的顶部，也就是package上面。
    	 */
    	@Override
    	public void addJavaFileComment(CompilationUnit compilationUnit) {
        	SimpleDateFormat sdf=new SimpleDateFormat("yyyy-MM-dd");
        	compilationUnit.addFileCommentLine("/*");
        	compilationUnit.addFileCommentLine("*");
        	compilationUnit.addFileCommentLine("* "+compilationUnit.getType().getShortName()+".java");
        	compilationUnit.addFileCommentLine("* Copyright(C) 2017-2020 fendo公司");
        	compilationUnit.addFileCommentLine("* @date "+sdf.format(new Date())+"");
        	compilationUnit.addFileCommentLine("*/");
    	}
    
    	/**
    	 * 为模型类添加注释
    	 */
    	@Override
    	public void addModelClassComment(TopLevelClass arg0, IntrospectedTable arg1) {
    		
    	}
    
    	/**
    	 * 为调用此方法作为根元素的第一个子节点添加注释。
    	 */
    	@Override
    	public void addRootComment(XmlElement arg0) {
    		
    	}
    
    	
    	/**
    	 * 给setter方法加注释
    	 */
    	@Override
    	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(" */");
    	}
    
    }

配置generator.xml,修改其中的<commentGenerator>为如下形式:

注意type的值为MyCommentGenerator类的全路径，完整文件如下:

<?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>  
      
        <classPathEntry  location="D:\MavenRepository\mysql\mysql-connector-java\5.1.38\mysql-connector-java-5.1.38.jar"/>  
        <context id="DB2Tables"  targetRuntime="MyBatis3">  
    		
            <property name="javaFileEncoding" value="UTF-8"/>
            
            <commentGenerator type="com.fendo.generatorplus.MyCommentGenerator">
            </commentGenerator>
            
               
            <jdbcConnection driverClass="com.mysql.jdbc.Driver" connectionURL="jdbc:mysql://localhost:3306/test" userId="root" password="root">  
            </jdbcConnection>  
            <javaTypeResolver>  
                <property name="forceBigDecimals" value="false"/>  
            </javaTypeResolver>  
              
            <javaModelGenerator targetPackage="com.fendo.generatorplus.entity" targetProject="src/main/java">  
                <property name="enableSubPackages" value="true"/>  
                <property name="trimStrings" value="true"/>  
            </javaModelGenerator>  
              
            <sqlMapGenerator targetPackage="com.fendo.generatorplus.dao" targetProject="src/main/java">  
                <property name="enableSubPackages" value="true"/>  
            </sqlMapGenerator>  
              
            <javaClientGenerator type="XMLMAPPER" targetPackage="com.fendo.generatorplus.dao" targetProject="src/main/java">  
                <property name="enableSubPackages" value="true"/>  
            </javaClientGenerator>  
              
            <table tableName="test" domainObjectName="Test" enableCountByExample="false" enableUpdateByExample="false" enableDeleteByExample="false" enableSelectByExample="false" selectByExampleQueryId="false"></table>
        </context>  
    </generatorConfiguration>

**2.3、测试代码生成**

新建StartUp测试类

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;
    
    /**   
     * @Title: StartUp.java 
     * @Package com.fendo.mybatis_generator_plus 
     * @Description: TODO
     * @author fendo
     * @date 2017年10月5日 下午3:53:17 
     * @version V1.0   
    */
    public class StartUp {
    
    	public static void main(String[] args) throws URISyntaxException {
            try {
            	System.out.println("--------------------start generator-------------------");
                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);
            	System.out.println("--------------------end generator-------------------");
            } 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();
            }
        }
    }

然后运行StartUp文件,就会自动生成代码了,生成的bean代码如下:

![20171005165250083][]

生成的Mapper如下

![20171005165354813][]

能生成中文注释了，但是好像类的注释并没有生成，而且mapper中的注释生成的有点无视。。。这些问题，在修改源码实现中文注释中，得以解决，下一步，就是，把这个项目，打包成JAR，这样才好使用，要使依赖包被打包到最后的jar包中,要在pom.xml中进行相应的配置:

<plugin>
                  
                  <artifactId>maven-assembly-plugin</artifactId>
                  <version>2.6</version>
                  <configuration>
                      
                      <appendAssemblyId>false</appendAssemblyId>
                      <archive>
                          <manifest>
                              
                              <mainClass>org.mybatis.generator.api.ShellRunner</mainClass>
                          </manifest>
                      </archive>
                      <descriptorRefs>
                          <descriptorRef>jar-with-dependencies</descriptorRef>
                      </descriptorRefs>
                  </configuration>
                  <executions>
                      <execution>
                          <id>make-assembly</id>
                          <phase>package</phase>
                          <goals>
                              <goal>single</goal>
                          </goals>
                      </execution>
                  </executions>
              </plugin>

由于使用了Generator的ShellRunner,所以在打包JAR的时候,可以删了StartUp和generatorConfig.xml文件，然后在项目根路径使用打包命令

mvn clean package

来打包成jar文件,生成如下的jar包

![20171005171200935][]

然后把mybatis-generator-plus.jar复制到一个目录下,同时新建一个generatorConfig.xml配置文件，以及一个cmd文件

![20171005190637209][]

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>  
      
        <classPathEntry  location="D:\MavenRepository\mysql\mysql-connector-java\5.1.38\mysql-connector-java-5.1.38.jar"/>  
        <context id="DB2Tables"  targetRuntime="MyBatis3">  
    		
            <property name="javaFileEncoding" value="UTF-8"/>
            
            <commentGenerator type="org.mybatis.generator.MyCommentGenerator">
            </commentGenerator>
            
               
            <jdbcConnection driverClass="com.mysql.jdbc.Driver" connectionURL="jdbc:mysql://localhost:3306/test" userId="root" password="root">  
            </jdbcConnection>  
            <javaTypeResolver>  
                <property name="forceBigDecimals" value="false"/>  
            </javaTypeResolver>  
              
            <javaModelGenerator targetPackage="com.fendo.generatorplus.entity" targetProject="src/main/java">  
                <property name="enableSubPackages" value="true"/>  
                <property name="trimStrings" value="true"/>  
            </javaModelGenerator>  
              
            <sqlMapGenerator targetPackage="com.fendo.generatorplus.dao" targetProject="src/main/java">  
                <property name="enableSubPackages" value="true"/>  
            </sqlMapGenerator>  
              
            <javaClientGenerator type="XMLMAPPER" targetPackage="com.fendo.generatorplus.dao" targetProject="src/main/java">  
                <property name="enableSubPackages" value="true"/>  
            </javaClientGenerator>  
              
            <table tableName="test" domainObjectName="Test" enableCountByExample="false" enableUpdateByExample="false" enableDeleteByExample="false" enableSelectByExample="false" selectByExampleQueryId="false"></table>
        </context>  
    </generatorConfiguration>

cmd内容如下:

echo off
    set JAVA_HOME=C:\work\java\jdk1.8.0_102
    set M2_HOME=C:\work\Java\apache-maven-3.0.3
    
    set PATHP=%PATH%
    set PATH=%PATH%;%M2_HOME%\bin;%ANT_HOME%\bin
    
    Java -jar mybatis-generator-plus.jar -configfile generatorConfig.xml -overwrite
    
    set PATHP=%PATH%

然后一运行就cmd文件就会自动生成代码了。

完整项目:[http://download.csdn.net/download/u011781521/10008156][http_download.csdn.net_download_u011781521_10008156]

[20171005142947196]: /images/20220607/e694ebb576a348f6a81693388dbf28d8.png
[20171005143236948]: /images/20220607/7d3a2ce5d56a47f9b1a0debdc7182957.png
[20171005165250083]: /images/20220607/e19c7f1dcdbf46cfbbcd39e89cef1487.png
[20171005165354813]: /images/20220607/d0d54324757041848f747a834ab8d9a8.png
[20171005171200935]: /images/20220607/3f1ef6d31a94421c91996c3a021a1e32.png
[20171005190637209]: /images/20220607/8c149964a4c0410489c1bbfb1cc2598a.png
[http_download.csdn.net_download_u011781521_10008156]: http://download.csdn.net/download/u011781521/10008156