mybatis generator自定义model的代码注释

mbg相信大家都比较熟悉，可以自动化的生成数据库表对应的model，mapper。但是最近在使用mbg的时候遇到了这样的问题：

1、生成的model虽然可以根据数据库字段的comment生成注释，但这些注释仅对后端开发人员可见，如果想让前端人员通过swagger查看，仍需要手动添加注解，比如@ApiModelProperty；

2、手动添加@ApiModelProperty注解之后，如果数据库表有修改，当使用mbg重新生成之后，之前手工添加的@ApiModelProperty会被覆盖，又得重新添加。

针对以上问题，mybatis提供了解决方案，就是CommentGenerator，下面介绍下CommentGenerator的用法。

项目结构如下。

首先generator.properties文件中存放了数据库连接信息，类似这种：

jdbc.driverClass=com.mysql.cj.jdbc.Driver
jdbc.connectionURL=jdbc:mysql://localhost:3306/mysql?useUnicode=true&characterEncoding=utf-8&serverTimezone=Asia/Shanghai&useSSL=false
jdbc.userId=
jdbc.password=

然后看一下generatorConfig.xml文件。特别注意CommentGenerator标签指向的就是今天的主角。

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE generatorConfigurationPUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN""http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd"><generatorConfiguration><properties resource="generator.properties"/><context id="MySqlContext" targetRuntime="MyBatis3" defaultModelType="flat"><property name="beginningDelimiter" value="`"/><property name="endingDelimiter" value="`"/><property name="javaFileEncoding" value="UTF-8"/><!-- 为模型生成序列化方法--><plugin type="org.mybatis.generator.plugins.SerializablePlugin"/><!-- 为生成的Java模型创建一个toString方法 --><plugin type="org.mybatis.generator.plugins.ToStringPlugin"/><!--生成mapper.xml时覆盖原文件--><plugin type="org.mybatis.generator.plugins.UnmergeableXmlMappersPlugin" /><commentGenerator type="com.useless.matrix.data.CommentGenerator"><!-- 是否去除自动生成的注释 true：是 ： false:否 --><property name="suppressAllComments" value="true"/><property name="suppressDate" value="true"/><property name="addRemarkComments" value="true"/></commentGenerator><jdbcConnection driverClass="${jdbc.driverClass}"connectionURL="${jdbc.connectionURL}"userId="${jdbc.userId}"password="${jdbc.password}"><!--解决mysql驱动升级到8.0后不生成指定数据库代码的问题--><property name="nullCatalogMeansCurrent" value="true" /></jdbcConnection><javaModelGenerator targetPackage="com.useless.matrix.data.mbg.model" targetProject="matrix-data/src/main/java"/><sqlMapGenerator targetPackage="com.useless.matrix.data.mbg.mapper" targetProject="matrix-data/src/main/resources"/><javaClientGenerator type="XMLMAPPER" targetPackage="com.useless.matrix.data.mbg.mapper"targetProject="matrix-data/src/main/java"/><!--生成全部表tableName设为%--><table tableName="account"><generatedKey column="id" sqlStatement="MySql" identity="true"/></table></context>
</generatorConfiguration>

Generator类的main方法会读取generatorConfig.xml，生成model和mapper：

package com.useless.matrix.data;import org.mybatis.generator.api.MyBatisGenerator;
import org.mybatis.generator.config.Configuration;
import org.mybatis.generator.config.xml.ConfigurationParser;
import org.mybatis.generator.internal.DefaultShellCallback;import java.io.InputStream;
import java.util.ArrayList;
import java.util.List;public class Generator {public static void main(String[] args) throws Exception {//MBG 执行过程中的警告信息List<String> warnings = new ArrayList<String>();//当生成的代码重复时，覆盖原代码boolean overwrite = true;//读取我们的 MBG 配置文件InputStream is = Generator.class.getResourceAsStream("/generatorConfig.xml");ConfigurationParser cp = new ConfigurationParser(warnings);Configuration config = cp.parseConfiguration(is);is.close();DefaultShellCallback callback = new DefaultShellCallback(overwrite);//创建 MBGMyBatisGenerator myBatisGenerator = new MyBatisGenerator(config, callback, warnings);//执行生成代码myBatisGenerator.generate(null);//输出警告信息for (String warning : warnings) {System.out.println(warning);}}
}

下面有请主角CommentGenerator类：

package com.useless.matrix.data;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.FullyQualifiedJavaType;
import org.mybatis.generator.internal.DefaultCommentGenerator;
import org.mybatis.generator.internal.util.StringUtility;import java.util.Properties;/*** 自定义注释生成器*/
public class CommentGenerator extends DefaultCommentGenerator {private boolean addRemarkComments = false;private static final String EXAMPLE_SUFFIX="Example";private static final String MAPPER_SUFFIX="Mapper";private static final String API_MODEL_PROPERTY_FULL_CLASS_NAME="io.swagger.annotations.ApiModelProperty";private static final String JSON_FORMAT="com.fasterxml.jackson.annotation.JsonFormat";/*** 设置用户配置的参数*/@Overridepublic void addConfigurationProperties(Properties properties) {super.addConfigurationProperties(properties);this.addRemarkComments = StringUtility.isTrue(properties.getProperty("addRemarkComments"));}/*** 给字段添加注释*/@Overridepublic void addFieldComment(Field field, IntrospectedTable introspectedTable,IntrospectedColumn introspectedColumn) {String remarks = introspectedColumn.getRemarks();//根据参数和备注信息判断是否添加swagger注解信息if(addRemarkComments&&StringUtility.stringHasValue(remarks)){
//            addFieldJavaDoc(field, remarks);//数据库中特殊字符需要转义if(remarks.contains("\"")){remarks = remarks.replace("\"","'");}//A 给model的字段添加swagger注解field.addJavaDocLine("@ApiModelProperty(value = \""+remarks+"\")");System.out.println(field.getType());}//B 给时间字段规定格式if (field.getType().equals(FullyQualifiedJavaType.getDateInstance())) {field.addJavaDocLine("@JsonFormat(pattern = \"yyyy-MM-dd HH:mm:ss\",timezone = \"GMT+8\")");}}/*** 给model的字段添加注释*/private void addFieldJavaDoc(Field field, String remarks) {//文档注释开始field.addJavaDocLine("/**");//获取数据库字段的备注信息String[] remarkLines = remarks.split(System.getProperty("line.separator"));for(String remarkLine:remarkLines){field.addJavaDocLine(" * "+remarkLine);}addJavadocTag(field, false);field.addJavaDocLine(" */");}@Overridepublic void addJavaFileComment(CompilationUnit compilationUnit) {super.addJavaFileComment(compilationUnit);//只在model中添加swagger注解类的导入if(!compilationUnit.getType().getFullyQualifiedName().contains(MAPPER_SUFFIX)&&!compilationUnit.getType().getFullyQualifiedName().contains(EXAMPLE_SUFFIX)){compilationUnit.addImportedType(new FullyQualifiedJavaType(API_MODEL_PROPERTY_FULL_CLASS_NAME));compilationUnit.addImportedType(new FullyQualifiedJavaType(JSON_FORMAT));}}
}

注意到45行A处的代码，其实就是根据remark为生成的model加一行@ApiModelProperty代码。

51行B处的代码是为数据库中的Date格式的字段添加一行@JsonFormat代码，指定统一的格式。

这样还不够，我们还需要手动地添加注解对应的import，注意看addJavaFileComment方法：