MyBatis Generator系列(三)----修改源码实现中文注释

谁践踏了优雅 2022-06-07 02:12 332阅读 0赞

**1)导入源码**

再新建一个Maven项目,然后把mybatis-generator-core-1.3.5解压，复制org目录到eclipse中去，完整的项目如下:

![20171006105844784][]

此时，项目有可能会报错，因为有依赖包没有引入,缺少log4j和ant包,在pom.xml中添加上依赖,顺便添加了oracle和mysql的驱动程序

<dependency>
            <groupId>log4j</groupId>
            <artifactId>log4j</artifactId>
            <version>1.2.7</version>
        </dependency>
        <dependency>
            <groupId>org.apache.ant</groupId>
            <artifactId>ant</artifactId>
            <version>1.9.0</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.38</version>
        </dependency>

**2)修改源码**  
  
  
在源代码里找到 org.mybatis.generator.internal.DefaultCommentGenerator类进行修改，DefaultCommentGenerator也是实现了CommentGenerator接口:  
  
  
![20171006111522634][]

里面主要有以下方法:

addJavaFileComment(CompilationUnit compilationUnit)  Java文件加注释
    addComment(XmlElement xmlElement)  Mybatis的Mapper.xml文件里面的注释
    addRootComment(XmlElement rootElement) 为根元素的第一个子节点添加注释
    addJavadocTag(JavaElement javaElement,boolean markAsDoNotDelete) 添加自定义javadoc标签
    addClassComment(InnerClass innerClass,IntrospectedTable introspectedTable) 类注释
    addModelClassComment(TopLevelClass topLevelClass,IntrospectedTable introspectedTable) 模型类添加注释
    addEnumComment(InnerEnum innerEnum,IntrospectedTable introspectedTable) 枚举注释
    addFieldComment(Field field,IntrospectedTable introspectedTable,IntrospectedColumn introspectedColumn)  字段注释
    addFieldComment(Field field, IntrospectedTable introspectedTable) 字段注释
    addGeneralMethodComment(Method method,IntrospectedTable introspectedTable) 普通方法注释,mapper接口中方法
    addGetterComment(Method method,IntrospectedTable introspectedTable,IntrospectedColumn introspectedColumn) Getter方法注释
    addSetterComment(Method method,IntrospectedTable introspectedTable,IntrospectedColumn introspectedColumn) Setter方法注释
    addClassComment(InnerClass innerClass,IntrospectedTable introspectedTable, boolean markAsDoNotDelete) 类注释

具体修改方式参考了以下一些文章:

Mybatis-generator源码学习和修改： [http://blog.csdn.net/wu6660563/article/details/52093364][http_blog.csdn.net_wu6660563_article_details_52093364]

大象修改博客：[http://www.blogjava.net/bolo/archive/2015/03/25/423826.html ][http_www.blogjava.net_bolo_archive_2015_03_25_423826.html]

[Mybatis Generator的model生成中文注释,支持oracle和mysql(通过修改源码的方式来实现)][Mybatis Generator_model_oracle_mysql]

[修改mybatis-generator源码生成中文注释][mybatis-generator]

我就按照上面的步骤操作，做了一些修改，仅供参考;

**1、Mapper.xml空格改成四个空格**

修改详情：  
  
org.mybatis.generator.api.dom.OutputUtilities  
  
OutputUtilities 这个类，它里面有个 xmlIndent 方法是用来控制生成的 xml 文件中空格的缩进，默认是两个空格在 sb.append( "  " ) 里面增加两个空格就可以了。

![20171006113950172][]

**2、修改dao包下的名称，由原来的XXXMapper改成XXXDao**  
  
修改详情：

org.mybatis.generator.api.IntrospectedTable  
  
calculateJavaClientAttributes方法(大概1335行)将sb.append("Mapper");注释掉改成 sb.append("Dao");

![20171006125123052][]

**3、修改Mybatis生成Model的字段注释内容：**

1)generatorConfig.xml配置里面设置成：<property name="suppressAllComments" value="false"/>

代码修改详情：

org.mybatis.generator.internal.DefaultCommentGenerator里面的addFieldComment方法添加注释代码去掉，改成

field.addJavaDocLine("/**");
            field.addJavaDocLine(" * @Fields "+field.getName()+" "+introspectedColumn.getRemarks());
            field.addJavaDocLine(" */");

![20171006135626341][]

**4、修改XXXDao.java(XXXMapper.java)的接口方法的Javadoc注释**

代码修改详情：

搜索org.mybatis.generator.internal.DefaultCommentGenerator如下方法，并注释方法里面内容

public void addGeneralMethodComment(Method method,IntrospectedTable introspectedTable)

改成：

if (suppressAllComments) {
                return;
            }
    		
    		        StringBuilder sb = new StringBuilder();
            method.addJavaDocLine("/**"); 
            sb.append(" * ");
            if (method.isConstructor()) {
                sb.append(" 构造查询条件");
            }
            String method_name = method.getName();
            if ("setOrderByClause".equals(method_name)) {
                sb.append(" 设置排序字段");
            } else if ("setDistinct".equals(method_name)) {
                sb.append(" 设置过滤重复数据");
            } else if ("getOredCriteria".equals(method_name)) {
                sb.append(" 获取当前的查询条件实例");
            } else if ("isDistinct".equals(method_name)) {
                sb.append(" 是否过滤重复数据");
            } else if ("getOrderByClause".equals(method_name)) {
                sb.append(" 获取排序字段");
            } else if ("createCriteria".equals(method_name)) {
                sb.append(" 创建一个查询条件");
            } else if ("createCriteriaInternal".equals(method_name)) {
                sb.append(" 内部构建查询条件对象");
            } else if ("clear".equals(method_name)) {
                sb.append(" 清除查询条件");
            } else if ("countByExample".equals(method_name)) {
                sb.append(" 根据指定的条件获取数据库记录数");
            } else if ("deleteByExample".equals(method_name)) {
                sb.append(" 根据指定的条件删除数据库符合条件的记录");
            } else if ("deleteByPrimaryKey".equals(method_name)) {
                sb.append(" 根据主键删除数据库的记录");
            } else if ("insert".equals(method_name)) {
                sb.append(" 新写入数据库记录");
            } else if ("insertSelective".equals(method_name)) {
                sb.append(" 动态字段,写入数据库记录");
            } else if ("selectByExample".equals(method_name)) {
                sb.append(" 根据指定的条件查询符合条件的数据库记录");
            } else if ("selectByPrimaryKey".equals(method_name)) {
                sb.append(" 根据指定主键获取一条数据库记录");
            } else if ("updateByExampleSelective".equals(method_name)) {
                sb.append(" 动态根据指定的条件来更新符合条件的数据库记录");
            } else if ("updateByExample".equals(method_name)) {
                sb.append(" 根据指定的条件来更新符合条件的数据库记录");
            } else if ("updateByPrimaryKeySelective".equals(method_name)) {
                sb.append(" 动态字段,根据主键来更新符合条件的数据库记录");
            } else if ("updateByPrimaryKey".equals(method_name)) {
                sb.append(" 根据主键来更新符合条件的数据库记录");
            }
            sb.append(":");
            sb.append(introspectedTable.getFullyQualifiedTable());
            method.addJavaDocLine(sb.toString());
    
            final List<Parameter> parameterList = method.getParameters();
            if (!parameterList.isEmpty()) {
                method.addJavaDocLine(" *");
                if ("or".equals(method_name)) {
                    sb.append(" 增加或者的查询条件,用于构建或者查询");
                }
            } else {
                if ("or".equals(method_name)) {
                    sb.append(" 创建一个新的或者查询条件");
                }
            }
            String paramterName;
            for (Parameter parameter : parameterList) {
                sb.setLength(0);
                sb.append(" * @param "); //$NON-NLS-1$
                paramterName = parameter.getName();
                sb.append(paramterName);
                if ("orderByClause".equals(paramterName)) {
                    sb.append(" 排序字段"); //$NON-NLS-1$
                } else if ("distinct".equals(paramterName)) {
                    sb.append(" 是否过滤重复数据");
                } else if ("criteria".equals(paramterName)) {
                    sb.append(" 过滤条件实例");
                }
                method.addJavaDocLine(sb.toString());
            }
    
            method.addJavaDocLine(" */");

**5、修改Model里面Getter和Setter方法的注释**

代码修改详情：

搜索org.mybatis.generator.internal.DefaultCommentGenerator修改其中的addGetterComment,addSetterComment方法

addGetterComment修改成如下:

StringBuilder sb = new StringBuilder();
          method.addJavaDocLine("/**"); //$NON-NLS-1$
          sb.append(" * 获取 "); //$NON-NLS-1$
          sb.append(introspectedColumn.getRemarks()).append(" 字段:");
          sb.append(introspectedTable.getFullyQualifiedTable());
          sb.append('.');
          sb.append(introspectedColumn.getActualColumnName());
          method.addJavaDocLine(sb.toString());
          method.addJavaDocLine(" *"); //$NON-NLS-1$
          sb.setLength(0);
          sb.append(" * @return "); //$NON-NLS-1$
          sb.append(introspectedTable.getFullyQualifiedTable());
          sb.append('.');
          sb.append(introspectedColumn.getActualColumnName());
          sb.append(", ");
          sb.append(introspectedColumn.getRemarks());
          method.addJavaDocLine(sb.toString());
          method.addJavaDocLine(" */"); //$NON-NLS-1$

addSetterComment方法修改成如下:

StringBuilder sb = new StringBuilder();
            method.addJavaDocLine("/**"); //$NON-NLS-1$
            sb.append(" * 设置 ");  //$NON-NLS-1$
            sb.append(introspectedColumn.getRemarks()).append(" 字段:");
            sb.append(introspectedTable.getFullyQualifiedTable());
            sb.append('.');
            sb.append(introspectedColumn.getActualColumnName());
            method.addJavaDocLine(sb.toString());
            method.addJavaDocLine(" *"); //$NON-NLS-1$
            Parameter parm = method.getParameters().get(0);
            sb.setLength(0);
            sb.append(" * @param "); //$NON-NLS-1$
            sb.append(parm.getName());
            sb.append(" the value for "); //$NON-NLS-1$
            sb.append(introspectedTable.getFullyQualifiedTable());
            sb.append('.');
            sb.append(introspectedColumn.getActualColumnName());
            sb.append(", ");
            sb.append(introspectedColumn.getRemarks());
            method.addJavaDocLine(sb.toString());
            method.addJavaDocLine(" */"); //$NON-NLS-1$

**6、注释掉Mapper.xml里面的,实际使用未用到**

代码修改详情：

搜索org.mybatis.generator.internal.DefaultCommentGenerator如下方法：

public void addComment(XmlElement xmlElement)

全部注释掉

![20171006140331954][]

**7、XML里面每个SQL增加一个换行**

代码修改详情：

org.mybatis.generator.api.dom.xml.XmlElement里面getFormattedContent里面加上：

if(indentLevel == 1) {
        //每个insert/update/select之间插入一个空行
        OutputUtilities.newLine(sb);
    }

![20171006140549354][]

**8、修改mybatis的mapper.xml文件里面insert和update不根据字段判断的非动态SQL**

代码修改详情：

org.mybatis.generator.codegen.mybatis3.xmlmapper.XMLMapperGenerator

里面的getSqlMapElement方法  
  
注释掉：

addInsertElement(answer);
    addUpdateByPrimaryKeyWithoutBLOBsElement(answer);

![20171006141242239][]  
  
对应的是mapper.xml里面的

**9、添加Java文件注释，版权信息**

代码修改详情：

找到

org.mybatis.generator.internal.DefaultCommentGenerator

修改addJavaFileComment方法，修改成如下:

SimpleDateFormat sdf=new SimpleDateFormat("yyyy-MM-dd");
        	compilationUnit.addFileCommentLine("/*");
        	compilationUnit.addFileCommentLine("* "+compilationUnit.getType().getShortName()+".java");
        	compilationUnit.addFileCommentLine("* Copyright(C) 2017-2020 fendo公司");
        	compilationUnit.addFileCommentLine("* @date "+sdf.format(new Date())+"");
        	compilationUnit.addFileCommentLine("*/");

10、添加类注释

在

org.mybatis.generator.internal.DefaultCommentGenerator

修改addClassComment方法，修改成如下:

innerClass.addJavaDocLine("/**");
        	innerClass.addJavaDocLine(" * @Title "+introspectedTable.getFullyQualifiedTable()+"表的实体类");
        	innerClass.addJavaDocLine(" * @Description "+introspectedTable.getFullyQualifiedTable().getRemarks());
        	innerClass.addJavaDocLine(" * @version 1.0");
        	innerClass.addJavaDocLine(" * @Author fendo");
        	innerClass.addJavaDocLine(" * @Date " + new SimpleDateFormat("yyyy-MM-dd HH:mm:ss").format(new Date()));
        	innerClass.addJavaDocLine(" */");

其中getRemarks()是获取数据库表注释的方法，需要单独在org.mybatis.generator.api.FullyQualifiedTable类中添加一个remarks字段，然后创建好get,set方法。

![20171006142025681][]

然后修改org.mybatis.generator.internal.db.DatabaseIntrospector的calculateIntrospectedTables方法添加以下代码

//设置数据库表的备注信息
       Statement stmt = this.databaseMetaData.getConnection().createStatement();
                ResultSet rs = stmt.executeQuery(new StringBuilder().append("SHOW TABLE STATUS LIKE '").append(atn.getTableName()).append("'").toString());
                while (rs.next())
                //将数据库表得备注信息设置到remark字段
                    table.setRemark(rs.getString("COMMENT"));
    
     closeResultSet(rs);

![20171006142429416][]

完整的DefaultCommentGenerator文件如下:

package org.mybatis.generator.internal;
    
    import static org.mybatis.generator.internal.util.StringUtility.isTrue;
    
    import java.text.SimpleDateFormat;
    import java.util.Date;
    import java.util.List;
    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.java.TopLevelClass;
    import org.mybatis.generator.api.dom.xml.TextElement;
    import org.mybatis.generator.api.dom.xml.XmlElement;
    import org.mybatis.generator.config.MergeConstants;
    import org.mybatis.generator.config.PropertyRegistry;
    import org.mybatis.generator.internal.util.StringUtility;
    
    /**
     * MyBatis的默认的注释生成器
     *
     * @author Jeff Butler
     */
    public class DefaultCommentGenerator implements CommentGenerator {
    
        /** 配置文件. */
        private Properties properties;
        
        /** 父类的时间. */
        private boolean suppressDate;
        
        /** 父类的所有注释. */
        private boolean suppressAllComments;
    
        /** 添加表格的注释。如果suppressAllComments为true，则忽略此选项*/
        private boolean addRemarkComments;
        
        /** 时间格式 **/
        private SimpleDateFormat dateFormat;
    
        /**
         * 构造方法
         */
        public DefaultCommentGenerator() {
            super();
            properties = new Properties();
            suppressDate = false;
            suppressAllComments = false;
            addRemarkComments = false;
        }
    
        /* 
         * Java文件加注释
         */
        public void addJavaFileComment(CompilationUnit compilationUnit) {
        	SimpleDateFormat sdf=new SimpleDateFormat("yyyy-MM-dd");
        	compilationUnit.addFileCommentLine("/*");
        	compilationUnit.addFileCommentLine("* "+compilationUnit.getType().getShortName()+".java");
        	compilationUnit.addFileCommentLine("* Copyright(C) 2017-2020 fendo公司");
        	compilationUnit.addFileCommentLine("* @date "+sdf.format(new Date())+"");
        	compilationUnit.addFileCommentLine("*/");
        }
    
        /**
         * Mybatis的Mapper.xml文件里面的注释。
         *
         * @param xmlElement
         *            the xml element
         */
        public void addComment(XmlElement xmlElement) {
            if (suppressAllComments) {
                return;
            } 
        }
    
        /*
         * 调用此方法为根元素的第一个子节点添加注释。 此方法可用于添加
         * 一般文件注释（如版权声明）。 但是，请注意，XML文件合并功能不会处理
         * 这个注释。 如果反复运行生成器，则只保留初始运行的注释。
         */
        public void addRootComment(XmlElement rootElement) {
            // add no document level comments by default
        }
    
        /* 
         * 从properties配置文件中添加此实例的属性
         * 
         */
        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));
    
            addRemarkComments = isTrue(properties
                    .getProperty(PropertyRegistry.COMMENT_GENERATOR_ADD_REMARK_COMMENTS));
            
            String dateFormatString = properties.getProperty(PropertyRegistry.COMMENT_GENERATOR_DATE_FORMAT);
            if (StringUtility.stringHasValue(dateFormatString)) {
                dateFormat = new SimpleDateFormat(dateFormatString);
            }
        }
    
        /**
    	 *	此方法用于添加自定义javadoc标签。 如果您不希望包含Javadoc标签，您可能不会执行任何操作 - 
         *  但是，如果不包含Javadoc标签，那么eclipse插件的Java合并功能就会中断。
         *
         * @param javaElement
         *            the java element
         * @param markAsDoNotDelete
         *            the mark as do not delete
         */
        protected void addJavadocTag(JavaElement javaElement,
                boolean markAsDoNotDelete) {
            javaElement.addJavaDocLine(" *"); //$NON-NLS-1$
            StringBuilder sb = new StringBuilder();
            sb.append(" * "); //$NON-NLS-1$
            sb.append(MergeConstants.NEW_ELEMENT_TAG);
            if (markAsDoNotDelete) {
                sb.append(" do_not_delete_during_merge"); //$NON-NLS-1$
            }
            String s = getDateString();
            if (s != null) {
                sb.append(' ');
                sb.append(s);
            }
            javaElement.addJavaDocLine(sb.toString());
        }
    
        /**
         * 获取时间
         * @return a string representing the current timestamp, or null
         */
        protected String getDateString() {
            if (suppressDate) {
                return null;
            } else if (dateFormat != null) {
                return dateFormat.format(new Date());
            } else {
                return new Date().toString();
            }
        }
    
        /*  
         * 类注释
         */
        public void addClassComment(InnerClass innerClass,
                IntrospectedTable introspectedTable) {
            if (suppressAllComments) {
                return;
            }
        	innerClass.addJavaDocLine("/**");
        	innerClass.addJavaDocLine(" * @Title "+introspectedTable.getFullyQualifiedTable()+"表的实体类");
        	innerClass.addJavaDocLine(" * @Description "+introspectedTable.getFullyQualifiedTable().getRemarks());
        	innerClass.addJavaDocLine(" * @version 1.0");
        	innerClass.addJavaDocLine(" * @Author fendo");
        	innerClass.addJavaDocLine(" * @Date " + new SimpleDateFormat("yyyy-MM-dd HH:mm:ss").format(new Date()));
        	innerClass.addJavaDocLine(" */");
            
        }
    
        /* 
         * 实体类注释
         * 
         *  为模型类添加注释。 Java代码合并应该
    	 *	通知不要删除整个class，万一有任何class
    	 *	已经做出了改变。 所以这个方法会永远使用“不要删除”注释。
         */
        @Override
        public void addModelClassComment(TopLevelClass topLevelClass,
                IntrospectedTable introspectedTable) {
            if (suppressAllComments  || !addRemarkComments) {
                return;
            }  
        }
    
        /* 
         * 枚举注释
         */
        public void addEnumComment(InnerEnum innerEnum,
                IntrospectedTable introspectedTable) {
            if (suppressAllComments) {
                return;
            }
    
            StringBuilder sb = new StringBuilder();
    
            innerEnum.addJavaDocLine("/**"); //$NON-NLS-1$
            innerEnum
                    .addJavaDocLine(" * This enum was generated by MyBatis Generator."); //$NON-NLS-1$
    
            sb.append(" * This enum corresponds to the database table "); //$NON-NLS-1$
            sb.append(introspectedTable.getFullyQualifiedTable());
            innerEnum.addJavaDocLine(sb.toString());
    
            addJavadocTag(innerEnum, false);
    
            innerEnum.addJavaDocLine(" */"); //$NON-NLS-1$
        }
    
        /* 
         * 字段注释
         */
        public void addFieldComment(Field field,
                IntrospectedTable introspectedTable,
                IntrospectedColumn introspectedColumn) {
            if (suppressAllComments) {
                return;
            }
            field.addJavaDocLine("/**");
            field.addJavaDocLine(" * @Fields "+field.getName()+" "+introspectedColumn.getRemarks());
            field.addJavaDocLine(" */");
            
        }
    
        /* 
         * 字段注释
         */
        public void addFieldComment(Field field, IntrospectedTable introspectedTable) {
            if (suppressAllComments) {
                return;
            }
        }
    
        /* 
         * 普通方法注释,mapper接口中方法
         */
        public void addGeneralMethodComment(Method method,
                IntrospectedTable introspectedTable) {
            if (suppressAllComments) {
                return;
            }
            StringBuilder sb = new StringBuilder();
            method.addJavaDocLine("/**"); 
            sb.append(" * ");
            if (method.isConstructor()) {
                sb.append(" 构造查询条件");
            }
            String method_name = method.getName();
            if ("setOrderByClause".equals(method_name)) {
                sb.append(" 设置排序字段");
            } else if ("setDistinct".equals(method_name)) {
                sb.append(" 设置过滤重复数据");
            } else if ("getOredCriteria".equals(method_name)) {
                sb.append(" 获取当前的查询条件实例");
            } else if ("isDistinct".equals(method_name)) {
                sb.append(" 是否过滤重复数据");
            } else if ("getOrderByClause".equals(method_name)) {
                sb.append(" 获取排序字段");
            } else if ("createCriteria".equals(method_name)) {
                sb.append(" 创建一个查询条件");
            } else if ("createCriteriaInternal".equals(method_name)) {
                sb.append(" 内部构建查询条件对象");
            } else if ("clear".equals(method_name)) {
                sb.append(" 清除查询条件");
            } else if ("countByExample".equals(method_name)) {
                sb.append(" 根据指定的条件获取数据库记录数");
            } else if ("deleteByExample".equals(method_name)) {
                sb.append(" 根据指定的条件删除数据库符合条件的记录");
            } else if ("deleteByPrimaryKey".equals(method_name)) {
                sb.append(" 根据主键删除数据库的记录");
            } else if ("insert".equals(method_name)) {
                sb.append(" 新写入数据库记录");
            } else if ("insertSelective".equals(method_name)) {
                sb.append(" 动态字段,写入数据库记录");
            } else if ("selectByExample".equals(method_name)) {
                sb.append(" 根据指定的条件查询符合条件的数据库记录");
            } else if ("selectByPrimaryKey".equals(method_name)) {
                sb.append(" 根据指定主键获取一条数据库记录");
            } else if ("updateByExampleSelective".equals(method_name)) {
                sb.append(" 动态根据指定的条件来更新符合条件的数据库记录");
            } else if ("updateByExample".equals(method_name)) {
                sb.append(" 根据指定的条件来更新符合条件的数据库记录");
            } else if ("updateByPrimaryKeySelective".equals(method_name)) {
                sb.append(" 动态字段,根据主键来更新符合条件的数据库记录");
            } else if ("updateByPrimaryKey".equals(method_name)) {
                sb.append(" 根据主键来更新符合条件的数据库记录");
            }
            sb.append(":");
            sb.append(introspectedTable.getFullyQualifiedTable());
            method.addJavaDocLine(sb.toString());
    
            final List<Parameter> parameterList = method.getParameters();
            if (!parameterList.isEmpty()) {
                method.addJavaDocLine(" *");
                if ("or".equals(method_name)) {
                    sb.append(" 增加或者的查询条件,用于构建或者查询");
                }
            } else {
                if ("or".equals(method_name)) {
                    sb.append(" 创建一个新的或者查询条件");
                }
            }
            String paramterName;
            for (Parameter parameter : parameterList) {
                sb.setLength(0);
                sb.append(" * @param "); //$NON-NLS-1$
                paramterName = parameter.getName();
                sb.append(paramterName);
                if ("orderByClause".equals(paramterName)) {
                    sb.append(" 排序字段"); //$NON-NLS-1$
                } else if ("distinct".equals(paramterName)) {
                    sb.append(" 是否过滤重复数据");
                } else if ("criteria".equals(paramterName)) {
                    sb.append(" 过滤条件实例");
                }
                method.addJavaDocLine(sb.toString());
            }
    
            method.addJavaDocLine(" */"); 
            
        }
    
        /* 
         * Getter方法注释
         */
        public void addGetterComment(Method method,IntrospectedTable introspectedTable,IntrospectedColumn introspectedColumn) {
            if (suppressAllComments) {
                return;
            }
          StringBuilder sb = new StringBuilder();
          method.addJavaDocLine("/**"); //$NON-NLS-1$
          sb.append(" * 获取 "); //$NON-NLS-1$
          sb.append(introspectedColumn.getRemarks()).append(" 字段:");
          sb.append(introspectedTable.getFullyQualifiedTable());
          sb.append('.');
          sb.append(introspectedColumn.getActualColumnName());
          method.addJavaDocLine(sb.toString());
          method.addJavaDocLine(" *"); //$NON-NLS-1$
          sb.setLength(0);
          sb.append(" * @return "); //$NON-NLS-1$
          sb.append(introspectedTable.getFullyQualifiedTable());
          sb.append('.');
          sb.append(introspectedColumn.getActualColumnName());
          sb.append(", ");
          sb.append(introspectedColumn.getRemarks());
          method.addJavaDocLine(sb.toString());
          method.addJavaDocLine(" */"); //$NON-NLS-1$
            
        }
    
        /**
         * Setter方法注释
         */
        public void addSetterComment(Method method,
                IntrospectedTable introspectedTable,
                IntrospectedColumn introspectedColumn) {
            if (suppressAllComments) {
                return;
            }
            StringBuilder sb = new StringBuilder();
            method.addJavaDocLine("/**"); //$NON-NLS-1$
            sb.append(" * 设置 ");  //$NON-NLS-1$
            sb.append(introspectedColumn.getRemarks()).append(" 字段:");
            sb.append(introspectedTable.getFullyQualifiedTable());
            sb.append('.');
            sb.append(introspectedColumn.getActualColumnName());
            method.addJavaDocLine(sb.toString());
            method.addJavaDocLine(" *"); //$NON-NLS-1$
            Parameter parm = method.getParameters().get(0);
            sb.setLength(0);
            sb.append(" * @param "); //$NON-NLS-1$
            sb.append(parm.getName());
            sb.append(" the value for "); //$NON-NLS-1$
            sb.append(introspectedTable.getFullyQualifiedTable());
            sb.append('.');
            sb.append(introspectedColumn.getActualColumnName());
            sb.append(", ");
            sb.append(introspectedColumn.getRemarks());
            method.addJavaDocLine(sb.toString());
            method.addJavaDocLine(" */"); //$NON-NLS-1$
            
        }
    
        /**
         * 类注释
         */
        public void addClassComment(InnerClass innerClass,
                IntrospectedTable introspectedTable, boolean markAsDoNotDelete) {
            if (suppressAllComments) {
                return;
            }
        	innerClass.addJavaDocLine("/**");
        	innerClass.addJavaDocLine(" * @Title "+introspectedTable.getFullyQualifiedTable()+"表的实体类");
        	innerClass.addJavaDocLine(" * @Description "+introspectedTable.getFullyQualifiedTable().getRemarks());
        	innerClass.addJavaDocLine(" * @version 1.0");
        	innerClass.addJavaDocLine(" * @Author fendo");
        	innerClass.addJavaDocLine(" * @Date " + new SimpleDateFormat("yyyy-MM-dd HH:mm:ss").format(new Date()));
        	innerClass.addJavaDocLine(" */");
            
        }
    }

**3)测试**

新建测试类StartUp

package com.fendo.test;
    
    
    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();
            }
        }
    }

附上配置文件

<?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"/>
    	    
    	    <property name="suppressAllComments" value="false"/>
                
            <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.test" targetProject="src/main/java">  
                <property name="enableSubPackages" value="true"/>  
                <property name="trimStrings" value="true"/>  
            </javaModelGenerator>  
              
            <sqlMapGenerator targetPackage="com.fendo.test" targetProject="src/main/java">  
                <property name="enableSubPackages" value="true"/>  
            </sqlMapGenerator>  
              
            <javaClientGenerator type="XMLMAPPER" targetPackage="com.fendo.test" 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>

运行StartUp生成的文件如下:

![20171006145348541][]

Test文件

![20171006145437651][]

Dao文件

![20171006145458987][]

Mapper文件

![20171006145517156][]

**4)打包**

在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>

然后在文件中执行打包命令:

mvn clean package

执行成功会得到一个jar包

![20171006150243127][]

然后复制到一个文件下，测试下

![20171006163605585][]

可以自己新建cmd命令，或通过以下命令执行:

java -jar mybatis-generator-plus.jar -configfile generatorConfig.xml
       java -jar mybatis-generator-plus.jar -configfile generatorConfig.xml -overwrite
       java -cp mybatis-generator-plus.jar org.mybatis.generator.api.ShellRunner -configfile generatorConfig.xml
       java -cp mybatis-generator-plus.jar org.mybatis.generator.api.ShellRunner -configfile generatorConfig.xml -overwrite

完整项目:

[http://download.csdn.net/download/u011781521/10009090  
][http_download.csdn.net_download_u011781521_10009090]

有时会报莫名其妙的错误如下:

java.net.MalformedURLException
            at java.net.URL.<init>(URL.java:627)
            at java.net.URL.<init>(URL.java:490)
            at java.net.URL.<init>(URL.java:439)
            at com.sun.org.apache.xerces.internal.impl.XMLEntityManager.setupCurrentEntity(XMLEntityManager.java:620)
            at com.sun.org.apache.xerces.internal.impl.XMLEntityManager.startEntity(XMLEntityManager.java:1304)
            at com.sun.org.apache.xerces.internal.impl.XMLEntityManager.startDTDEntity(XMLEntityManager.java:1270)
            at com.sun.org.apache.xerces.internal.impl.XMLDTDScannerImpl.setInputSource(XMLDTDScannerImpl.java:264)
            at com.sun.org.apache.xerces.internal.impl.XMLDocumentScannerImpl$DTDDriver.dispatch(XMLDocumentScannerImpl.java:1161)
            at com.sun.org.apache.xerces.internal.impl.XMLDocumentScannerImpl$DTDDriver.next(XMLDocumentScannerImpl.java:1045)
            at com.sun.org.apache.xerces.internal.impl.XMLDocumentScannerImpl$PrologDriver.next(XMLDocumentScannerImpl.java:959)
            at com.sun.org.apache.xerces.internal.impl.XMLDocumentScannerImpl.next(XMLDocumentScannerImpl.java:602)
            at com.sun.org.apache.xerces.internal.impl.XMLDocumentFragmentScannerImpl.scanDocument(XMLDocumentFragmentScannerImpl.java:505)
            at com.sun.org.apache.xerces.internal.parsers.XML11Configuration.parse(XML11Configuration.java:841)
            at com.sun.org.apache.xerces.internal.parsers.XML11Configuration.parse(XML11Configuration.java:770)
            at com.sun.org.apache.xerces.internal.parsers.XMLParser.parse(XMLParser.java:141)
            at com.sun.org.apache.xerces.internal.parsers.DOMParser.parse(DOMParser.java:243)
            at com.sun.org.apache.xerces.internal.jaxp.DocumentBuilderImpl.parse(DocumentBuilderImpl.java:339)
            at org.mybatis.generator.config.xml.ConfigurationParser.parseConfiguration(ConfigurationParser.java:140)
            at org.mybatis.generator.config.xml.ConfigurationParser.parseConfiguration(ConfigurationParser.java:113)
            at org.mybatis.generator.config.xml.ConfigurationParser.parseConfiguration(ConfigurationParser.java:105)
            at org.mybatis.generator.api.ShellRunner.main(ShellRunner.java:107)
    Caused by: java.lang.NullPointerException
            at java.net.URL.<init>(URL.java:532)
            ... 20 more

这是由于在编译的时候，没有把以下两个文件编译进来，所有会提示上面的错误，debug了半天才发现了问题所在:

![20171016211839684][]

解决方法就是在POM.XML中加入以下内容:

<finalName>mybatis-generator-plus</finalName>
        <resources>  
            <resource>  
                <directory>src/main/resources</directory>  
                <includes>  
                    <include>**/*.properties</include>  
                    <include>**/*.xml</include>  
                    <include>**/*.tld</include> 
                    <include>**/*.dtd</include>  
                </includes>  
                <filtering>false</filtering>  
            </resource>  
            <resource>  
                <directory>src/main/java</directory>  
                <includes>  
                    <include>**/*.properties</include>  
                    <include>**/*.xml</include>  
                    <include>**/*.tld</include>  
                    <include>**/*.dtd</include>  
                </includes>  
                <filtering>false</filtering>  
            </resource>  
        </resources>

**5)注意**

**1、Mybatis Generator 获取不到字段注释**

Oracle 数据库

MySql 数据库  
  
方法1

方法2  
  
mysql的connectionURL中添加 useInformationSchema=true.大体上就是:

connectionURL="jdbc:mysql://127.0.0.1:3306/test?characterEncoding=UTF-8&useInformationSchema=true"

**2、mybatis generator 不能生成类注释**

在源代码里找到 org.mybatis.generator.internal.DefaultCommentGenerator类，这个类中addClassComment这个方法 是标注中文注释的。为了使addClassComment生效,还得找到org.mybatis.generator.codegen.mybatis3.model.BaseRecordGenerator类,在大约60行的地方,在

commentGenerator.addJavaFileComment(topLevelClass);

后加一句:

commentGenerator.addClassComment(topLevelClass, introspectedTable,false);

这样方法就调用到了。

[20171006105844784]: /images/20220607/ed0c42df2b724420a4e6b4513b9737e1.png
[20171006111522634]: /images/20220607/d265e2272d1d457aa5ed32d1644ade50.png
[http_blog.csdn.net_wu6660563_article_details_52093364]: http://blog.csdn.net/wu6660563/article/details/52093364
[http_www.blogjava.net_bolo_archive_2015_03_25_423826.html]: http://www.blogjava.net/bolo/archive/2015/03/25/423826.html
[Mybatis Generator_model_oracle_mysql]: http://www.cnblogs.com/NieXiaoHui/p/6100895.html
[mybatis-generator]: http://blog.csdn.net/liudongdong0909/article/details/52427967
[20171006113950172]: /images/20220607/87f54ac5d476409e9b2137e3eb4fa80f.png
[20171006125123052]: /images/20220607/4bf61031d6884882ba0cea656c34c72c.png
[20171006135626341]: /images/20220607/f25a5b38be2a4d9b9d7a041fd2fc2536.png
[20171006140331954]: /images/20220607/3a4ac02faa63472396ba16ee1b1f289e.png
[20171006140549354]: /images/20220607/7d2991b362234561a360ab4f73a24668.png
[20171006141242239]: /images/20220607/91b166c6f84f455282ffe7584a0dd0d1.png
[20171006142025681]: /images/20220607/33fdcbafba2e49ab971d4a1f7838541e.png
[20171006142429416]: /images/20220607/7363f8761d00490884bce3397bbaec36.png
[20171006145348541]: /images/20220607/41de2e9a64e944f59369697de797d3f8.png
[20171006145437651]: /images/20220607/e4cfbf9ea1fa44d2b517f632e124fd55.png
[20171006145458987]: /images/20220607/b9e7cc7d39ef4752a499dd13c9ab0601.png
[20171006145517156]: /images/20220607/ebf17ae93d65439aaedfffb51717f67a.png
[20171006150243127]: /images/20220607/1f3a06e097854af88cc0e4c27c697581.png
[20171006163605585]: /images/20220607/974043e94f9241baa551492a9dbebd45.png
[http_download.csdn.net_download_u011781521_10009090]: http://download.csdn.net/download/u011781521/10009090
[20171016211839684]: /images/20220607/7cd0ae97375d4e85b4090368661e8a38.png