mybatis-generator 自定义注释

最新推荐文章于 2022-10-09 13:28:14 发布

原创最新推荐文章于 2022-10-09 13:28:14 发布 · 494 阅读

CC 4.0 BY-SA版权

本文介绍如何使用MyBatis Generator 1.3.5版本来自定义生成的Java模型类注释。通过重写CommentGenerator类的addFieldComment方法，可以为每个字段添加详细的注释，包括字段名称、数据库类型等信息。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

本文根据mybatis-generator 1.3.5编写，其他版本可以参考
生成注释关键在于重写mybatis-generator的CommentGenerator我这里只重写了model生成的注解方法，其他还没研究，model注解需要重写addFieldComment方法

@Override
    public void addFieldComment(Field field, IntrospectedTable introspectedTable,IntrospectedColumn introspectedColumn) {
        if (suppressAllComments) {
            return;
        }
        StringBuilder sb = new StringBuilder();
        field.addJavaDocLine("/**");
        sb.append(" * ");
        //字段注释
        sb.append(introspectedColumn.getRemarks());
        //字段名
        sb.append(introspectedColumn.getActualColumnName());
        //字段的数据库类型
        sb.append(jdbcToJava(introspectedColumn.getJdbcTypeName()));
        field.addJavaDocLine(sb.toString().replace("\n", " "));
        field.addJavaDocLine(" */");
    }

修改generatorConfig.xml配置文件

//设置中文
<property name="javaFileEncoding" value="UTF-8"/>
//设置实现类地址
<commentGenerator type="com.package.MyCommentGenerator"></commentGenerator>
//被替换的属性
<!--<commentGenerator>
        <property name="suppressDate" value="true" />
        <property name="suppressAllComments" value="true" />
</commentGenerator>-->