通过继承DefaultCommentGenerator的方式来设置mybatis自定义代码生成器中生成实体类的中文注释

         之前在工作时通过修改mybatis-generate源码实现实体类加上数据库字段的备注,本人将另一种通过继承

DefaultCommentGenerator的方式整理一个工具类如下:

1.创建一个类来继承DefaultCommentGenerator

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.Method;
import org.mybatis.generator.api.dom.xml.XmlElement;
import org.mybatis.generator.internal.DefaultCommentGenerator;
import org.mybatis.generator.internal.util.StringUtility;

/**
 * @author : ShiLei
 * @time ：2017年12月25日 下午5:42:34
 * @introduction : 通过继承DefaultCommentGenerator类 设置实体类对应数据库字段的中文注释
 */
public class RemarksCommentGenerator extends DefaultCommentGenerator {
	 
	// 定义一个是否使用修改后的模式的标识
        private boolean suppressAllComments= true;
    
	// 设置实体类 属性注释
	@Override 
	public void addFieldComment(Field field, IntrospectedTable introspectedTable, IntrospectedColumn introspectedColumn) { 
		
	  if (suppressAllComments) {
		if (StringUtility.stringHasValue(introspectedColumn.getRemarks())) { 
		    field.addJavaDocLine("//" + introspectedColumn.getRemarks()); 
		} 
          }else {
	       super.addFieldComment(field, introspectedTable, introspectedColumn);
	  }
	}
	
	// 设置实体类 getter注释
	@Override 
	public void addGetterComment(Method method, IntrospectedTable introspectedTable, IntrospectedColumn introspectedColumn) { 
	   if (suppressAllComments) {
		if (StringUtility.stringHasValue(introspectedColumn.getRemarks())) { 
		   method.addJavaDocLine("//获取:" + introspectedColumn.getRemarks()); 
		}
           }else {
	       super.addGetterComment(method, introspectedTable, introspectedColumn);
	   }
	}

	// 设置实体类 setter注释
	@Override
	public void addSetterComment(Method method, IntrospectedTable introspectedTable, IntrospectedColumn introspectedColumn) {
	     if (suppressAllComments) {
		if (StringUtility.stringHasValue(introspectedColumn.getRemarks())) { 
			method.addJavaDocLine("//设置:" + introspectedColumn.getRemarks()); 
		}
             }else {
		super.addSetterComment(method, introspectedTable, introspectedColumn);
	     }
	}
	
	// 去掉mapper原始注释 
	@Override
	public void addGeneralMethodComment(Method method,IntrospectedTable introspectedTable) {
	   if (suppressAllComments) {
               return;
           }else {
	       super.addGeneralMethodComment(method, introspectedTable);
	   }
	}
	
	// 去掉mapping原始注释 
	@Override
	public void addComment(XmlElement xmlElement) {
	   if (suppressAllComments) {
              return;
           }else {
              super.addComment(xmlElement);
	   }
	}
}

2.重新设置generatorConfig.xml

<commentGenerator type="com.sl.apimon.RemarksCommentGenerator"></commentGenerator>

深入了解:  http://www.zuidaima/blog/3414706113530880.htm

                 http://www.bubuko/infodetail-1947778.html

                 http://blog.csdn/userwyh/article/details/49764327