使用DefaultCommentGenerator自定义Mybatis生成的model注释

公告：“业余草”微信公众号提供免费CSDN下载服务(只下Java资源)，关注业余草微信公众号，添加作者微信：xttblog2，发送下载链接帮助你免费下载！
本博客日IP超过2000，PV 3000 左右，急需赞助商。
极客时间所有课程通过我的二维码购买后返现24元微信红包，请加博主新的微信号：xttblog2，之前的微信号好友位已满，备注：返现
受密码保护的文章请关注“业余草”公众号，回复关键字“0”获得密码
所有面试题(java、前端、数据库、springboot等)一网打尽，请关注文末小程序

腾讯云】1核2G5M轻量应用服务器50元首年，高性价比，助您轻松上云

面试的时候，问有没有用过DefaultCommentGenerator，绝大部分程序员都不知道。其实它是用来生成model自定义注释的，本文就将介绍它的用法。

项目中的model，mapper以及mapper.xml基本都是用Mybatis Generator(以下简称为MBG)自动生成的，但是MBG自动生成的model的注释实在有点非人类，至少中国人是完全接受不了的，在配置中禁用掉注释吧，倒是简单了，可是生成的model类光秃秃的，啥都没有，字段方法没有注释，使用很不方便，别人看也不知道这个字段是啥含义。那么有没有办法优化自动生成model的注释呢？

答案当然是有，那就是使用DefaultCommentGenerator来自定义注释内容的生成。

首先我们需要继承DefaultCommentGenerator类：

package com.xttblog.plugin;
import org.mybatis.generator.api.IntrospectedColumn;
import org.mybatis.generator.api.IntrospectedTable;
import org.mybatis.generator.api.dom.java.Field;
import org.mybatis.generator.internal.DefaultCommentGenerator;
/**
 * 生成model中，字段增加注释
 */
public class CommentGenerator extends DefaultCommentGenerator {

	@Override
	public void addFieldComment(Field field, IntrospectedTable introspectedTable, IntrospectedColumn introspectedColumn) {
		super.addFieldComment(field, introspectedTable, introspectedColumn);
		if (introspectedColumn.getRemarks() != null && !introspectedColumn.getRemarks().equals("")) {
			field.addJavaDocLine("/**");
			field.addJavaDocLine(" * " + introspectedColumn.getRemarks());
			addJavadocTag(field, false);
			field.addJavaDocLine(" */");
		}
	}
}

然后再新建一个Xttblog类，运行Xttblog类就会直接生成model，mapper以及mapper.xml，类的代码如下:

package com.xttblog.test;
import java.io.File;
import java.io.IOException;
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;
public class Xttblog {
    public static void main(String[] args) throws URISyntaxException {
        try {
            List<String> warnings = new ArrayList<String>();
            boolean overwrite = true;
            //直接获取generatorConfig.xml的文件路径 根据具体情况查看
            File configFile = new File("E:\\WorkPlace\\xttblog\\src\\main\\resources\\generatorConfig.xml");
            ConfigurationParser cp = new ConfigurationParser(warnings);
            Configuration config = cp.parseConfiguration(configFile);
            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();
        }
    }
}

最后再修改一下generatorConfig.xml中的注释配置：

<commentGenerator type="com.xttblog.plugin.CommentGenerator">
   <!-- <property name="suppressDate" value="true"/>
	是否去除自动生成的注释 true：是 ： false:否
	<property name="suppressAllComments" value="false"/>-->
</commentGenerator>

commentGenerator 的type是你刚刚重写的DefaultCommentGenerator类的位置。

运行Xttblog，你会发现model，mapper以及mapper.xml都已经产生，实体类model中的注释非常的漂亮。

最后，欢迎关注我的个人微信公众号：业余草（yyucao）！可加作者微信号：xttblog2。备注：“1”，添加博主微信拉你进微信群。备注错误不会同意好友申请。再次感谢您的关注！后续有精彩内容会第一时间发给您！原创文章投稿请发送至532009913@qq.com邮箱。商务合作也可添加作者微信进行联系！

本文原文出处：业余草： » 使用DefaultCommentGenerator自定义Mybatis生成的model注释