mybatis 生成生成数据库中文注释

幸运的天才小驴
2,060 阅读1分钟

如果你进入本文，说明你也是想在mybatis generator 自动生成mapper xml model的时候，自动生成数据库字段的备注为注释信息。那么只要你阅读完本文，就可以帮助你实现你想要的。文章末尾会有源码的地址和jar.

下载mybatis-generator-core源码

其中下载过程各位可以自行Google，我这里有已经测试通过的maven工程，各位可以直接下载下来，导入自己的IDE中就可以了。
maven mybatis-generator-core 源码

导入成功之后的格式：

这里写图片描述
如果是直接下载的官方的源码，要修改pom.xml中的好多东西，各位有兴趣自己玩。我这里是解决好了之后的。
pom.xml



  4.0.0

  
    org.mybatis.generator
    mybatis-generator
    1.3.2
  

  org.mybatis.generator
  mybatis-generator-core
  
  1.3.2-fix
  jar

  
    UTF-8
  

  
    
    
      
        org.apache.maven.plugins
        maven-compiler-plugin
        
          1.7
          1.7
          UTF-8
        
      
      
        
        
        
          
            
            
              
            
          
        
      
      
        
        
        
          
            
            
              
            
          
        
      
      
        org.apache.maven.plugins
        maven-javadoc-plugin
        
          
            prepare-package
            
              jar
            
          
        
      
      
        
        
        
          
            
              
            
          
        
      
      
        
        
        
          
            
          
        
        
          
            
            
              
            
            
          
        
      
      
        
        
        
          
        
      
    
  

  
    
      
        org.codehaus.mojo
        jdepend-maven-plugin
        2.0
      
    
  

  
    
      log4j
      log4j
      provided
      true
    
    
      org.apache.ant
      ant
      provided
      true
    
    
      junit
      junit
      test
    
    
      org.hsqldb
      hsqldb
      test

源码的修改

这里写图片描述

我这里不修改默认的类DefaultCommentGenerator，而是新建一个自己的类 DG2CommentGenerator。按照自己的需求重写一些方法，主要有生成mapper接口的备注信息，生成model对象的注释。

package org.mybatis.generator.internal;

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.api.dom.java.Parameter;
import org.mybatis.generator.api.dom.xml.TextElement;
import org.mybatis.generator.api.dom.xml.XmlElement;
import org.mybatis.generator.config.MergeConstants;

import java.util.List;

/**
 * 自定义注解生成
 *
 * @author IT_donggua
 * @version V1.0
 * @create 2016-09-02 下午 06:28
        */
public class DG2CommentGenerator extends  DefaultCommentGenerator{

    public void addGeneralMethodComment(Method method, IntrospectedTable introspectedTable) {
        StringBuilder sb = new StringBuilder();
        method.addJavaDocLine("/**"); //$NON-NLS-1$
//        method.addJavaDocLine(" * This method was generated by MyBatis Generator."); //$NON-NLS-1$

//        sb.append(" * This method corresponds to the database table "); //$NON-NLS-1$
        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 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());
        }


        //        addJavadocTag(method, false);

        method.addJavaDocLine(" */"); //$NON-NLS-1$
    }

    @Override
    public void addClassComment(InnerClass innerClass, IntrospectedTable introspectedTable) {
        // 类注释，不管用
        String shortName = innerClass.getType().getShortName();
        innerClass.addJavaDocLine("/**");
        //innerClass.addJavaDocLine(" * 类注释");
        innerClass.addJavaDocLine(" * " + introspectedTable.getFullyQualifiedTable().getRemark());
        innerClass.addJavaDocLine(" * " + shortName);
        innerClass.addJavaDocLine(" * 数据库表：" + introspectedTable.getFullyQualifiedTable());
        // addJavadocTag(innerClass, false);
        innerClass.addJavaDocLine(" */");
    }

    @Override
    public void addClassComment(InnerClass innerClass, IntrospectedTable introspectedTable, boolean markAsDoNotDelete) {
        // 类注释，不管用
        String shortName = innerClass.getType().getShortName();
        innerClass.addJavaDocLine("/**");
        innerClass.addJavaDocLine(" * 类注释");
        innerClass.addJavaDocLine(" * " + shortName);
        innerClass.addJavaDocLine(" * 数据库表：" + introspectedTable.getFullyQualifiedTable());
        // addJavadocTag(innerClass, false);
        innerClass.addJavaDocLine(" */");
    }

    @Override
    public void addFieldComment(Field field, IntrospectedTable introspectedTable, IntrospectedColumn introspectedColumn) {
        // 添加字段注释
        StringBuffer sb = new StringBuffer();
        field.addJavaDocLine("/**");
        if (introspectedColumn.getRemarks() != null)
            field.addJavaDocLine(" * " + introspectedColumn.getRemarks());
        sb.append(" * 表字段 : ");
        sb.append(introspectedTable.getFullyQualifiedTable());
        sb.append('.');
        sb.append(introspectedColumn.getActualColumnName());
        field.addJavaDocLine(sb.toString());
        // addJavadocTag(field, false);
        field.addJavaDocLine(" */");
    }

    @Override
    public void addGetterComment(Method method,
                                 IntrospectedTable introspectedTable,
                                 IntrospectedColumn introspectedColumn) {
        StringBuilder sb = new StringBuilder();

        method.addJavaDocLine("/**"); //$NON-NLS-1$
//        method.addJavaDocLine(" * This method was generated by MyBatis Generator."); //$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());

//        addJavadocTag(method, false);

        method.addJavaDocLine(" */"); //$NON-NLS-1$
    }

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

        StringBuilder sb = new StringBuilder();

        method.addJavaDocLine("/**"); //$NON-NLS-1$
//        method.addJavaDocLine(" * This method was generated by MyBatis Generator."); //$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());

//        addJavadocTag(method, false);

        method.addJavaDocLine(" */"); //$NON-NLS-1$
    }

    @Override
    public void addComment(XmlElement xmlElement) {
        xmlElement.addElement(new TextElement("")); //$NON-NLS-1$
    }
}

修改生成model对象类的注释

这里写图片描述

修改DatabaseIntrospector的calculateIntrospectedTables方法，添加一段获取数据库备注的代码

这里写图片描述

 //设置数据库表的备注信息
 //start
   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)
  stmt.close()
 //end

这里写图片描述

具体样式可以按自己的爱好设置。


    @Override
    public void addClassComment(InnerClass innerClass, IntrospectedTable introspectedTable) {
        
        String shortName = innerClass.getType().getShortName();
        innerClass.addJavaDocLine("/**");
        
        
        innerClass.addJavaDocLine(" * " + introspectedTable.getFullyQualifiedTable().getRemark());
        
        innerClass.addJavaDocLine(" * " + shortName);
        
        innerClass.addJavaDocLine(" * 数据库表：" + introspectedTable.getFullyQualifiedTable());
        
        innerClass.addJavaDocLine(" */");
    }

修改model对象中字段的注释

在IntrospectedColumn中添加remarks属性,用于保存数据库对应表中字段的备注信息，需要setter/getter

这里写图片描述

这里写图片描述

 
    @Override
    public void addFieldComment(Field field, IntrospectedTable introspectedTable, IntrospectedColumn introspectedColumn) {
        
        StringBuffer sb = new StringBuffer();
        field.addJavaDocLine("/**");
        
        if (introspectedColumn.getRemarks() != null)
            field.addJavaDocLine(" * " + introspectedColumn.getRemarks());
        sb.append(" * 表字段 : ");
        
        sb.append(introspectedTable.getFullyQualifiedTable());
        sb.append('.');
        
        sb.append(introspectedColumn.getActualColumnName());
        field.addJavaDocLine(sb.toString());
        
        field.addJavaDocLine(" */");
    }

修改model对象中setter/getter的注释

这个就直接上代码，没有源码修改。

getter方法

@Override
    public void addGetterComment(Method method,
                                 IntrospectedTable introspectedTable,
                                 IntrospectedColumn introspectedColumn) {
        StringBuilder sb = new StringBuilder()

        method.addJavaDocLine("/**")
//        method.addJavaDocLine(" * This method was generated by MyBatis Generator.")

        sb.append(" * 获取 ")
        sb.append(introspectedColumn.getRemarks()).append(" 字段:")
        sb.append(introspectedTable.getFullyQualifiedTable())
        sb.append('.')
        sb.append(introspectedColumn.getActualColumnName())
        method.addJavaDocLine(sb.toString())

        method.addJavaDocLine(" *")

        sb.setLength(0)
        sb.append(" * @return ")
        sb.append(introspectedTable.getFullyQualifiedTable())
        sb.append('.')
        sb.append(introspectedColumn.getActualColumnName())
        sb.append(", ")
        sb.append(introspectedColumn.getRemarks())
        method.addJavaDocLine(sb.toString())

//        addJavadocTag(method, false)

        method.addJavaDocLine(" */")
    }

setter方法

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

        StringBuilder sb = new StringBuilder()

        method.addJavaDocLine("/**")
//        method.addJavaDocLine(" * This method was generated by MyBatis Generator.")

        sb.append(" * 设置 ")
        sb.append(introspectedColumn.getRemarks()).append(" 字段:")
        sb.append(introspectedTable.getFullyQualifiedTable())
        sb.append('.')
        sb.append(introspectedColumn.getActualColumnName())
        method.addJavaDocLine(sb.toString())

        method.addJavaDocLine(" *")

        Parameter parm = 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())
        sb.append(", ")
        sb.append(introspectedColumn.getRemarks())
        method.addJavaDocLine(sb.toString())

//        addJavadocTag(method, false)

        method.addJavaDocLine(" */")
    }

修改生成mapper中的注释

修改mapper接口中的注释

public void addGeneralMethodComment(Method method, IntrospectedTable introspectedTable) {
        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 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 "); 
            paramterName = parameter.getName();
            sb.append(paramterName);
            if ("orderByClause".equals(paramterName)) {
                sb.append(" 排序字段"); 
            } else if ("distinct".equals(paramterName)) {
                sb.append(" 是否过滤重复数据");
            } else if ("criteria".equals(paramterName)) {
                sb.append(" 过滤条件实例");
            }
            method.addJavaDocLine(sb.toString());
        }


        

        method.addJavaDocLine(" */"); 
    }

删除mapper.xml中的注释

  @Override
    public void addComment(XmlElement xmlElement) {
        xmlElement.addElement(new TextElement("")); //$NON-NLS-1$
    }

maven工程的打包

clean install -Dmaven.test.skip=true

这里写图片描述

生成之后我的maven仓库中的jar如下：

这里写图片描述
这里写图片描述

如何在工程中引用

参照Intellij IDEA 2016学习系列之（二）mybatis-generator生成

需要修改generatorConfig.xml

替换为

需要修改pom.xml

将插件中的依赖


                
                    org.mybatis.generator
                    mybatis-generator-core
                    1.3.2

修改为


                    
                        org.mybatis.generator
                        mybatis-generator-core
                        
                        1.3.2-fix

至此，大功告成。请看生成之后的代码样式。
这里写图片描述
这里写图片描述
这里写图片描述
这里写图片描述

源码和jar下载

1.3.2-fix.jar:download.csdn.net/detail/liud…
1.3.2-fix源码：github.com/liudongdong…

avatar
文章
阅读
粉丝