Mybatis-generator自动生成代码时提取自定义注释

最新推荐文章于 2022-05-10 12:29:59 发布
最新推荐文章于 2022-05-10 12:29:59 发布
阅读量572 收藏 1
点赞数
分类专栏： mybatis generator 文章标签： mybatis
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/yanyf2016/article/details/102974023
版权

在上篇文章中

https://blog.csdn.net/yanyf2016/article/details/102972195

生成的实体类没有数据库自己定义的注释，

根据网上找到的资料以及阅读Mybatis-generator源码，发现可以通过自定义注释生成器 CommentGenerator 接口的实现类来达到我们的目的。
通过阅读源码可以看到，代码生成注释是通过DefaultCommentGenerator类实现的，这个类继承了CommentGenerator接口，因此我们可以自己创建一个类继承CommentGenerator接口，然后重写里面相关方法就可以了（可以复制DefaultCommentGenerator中的代码过来，然后修改我们需要改动的方法）。

下面介绍实现过程。
1、自定义一个CommentGenerator接口的实现类，下面是我的自定义实现类代码


 

package com.generator;

import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.Properties;
import java.util.Set;

import org.mybatis.generator.api.CommentGenerator;
import org.mybatis.generator.api.IntrospectedColumn;
import org.mybatis.generator.api.IntrospectedTable;
import org.mybatis.generator.api.dom.java.*;
import org.mybatis.generator.api.dom.xml.XmlElement;
import org.mybatis.generator.config.MergeConstants;
import org.mybatis.generator.config.PropertyRegistry;

/**
 * 自定义实现 注释生成器 CommentGenerator 接口
 * 
 */
public class MyCommentGenerator implements CommentGenerator {

    private Properties properties;
    private Properties systemPro;
    private boolean suppressDate;
    private boolean suppressAllComments;
    private String nowTime;

    public MyCommentGenerator() {
        super();
        properties = new Properties();
        systemPro = System.getProperties();
        suppressDate = false;
        suppressAllComments = false;
        nowTime = (new SimpleDateFormat("yyyy-MM-dd HH:mm:ss")).format(new Date());
    }

    public void addJavaFileComment(CompilationUnit compilationUnit) {
        if (suppressAllComments) {
            return;
        }
        return;
    }

    /**
     * Adds a suitable comment to warn users that the element was generated, and
     * when it was generated.
     */
    public void addComment(XmlElement xmlElement) {
        return;
    }

    public void addRootComment(XmlElement rootElement) {
        // add no document level comments by default
        return;
    }

    public void addGeneralMethodAnnotation(Method method, IntrospectedTable introspectedTable, Set<FullyQualifiedJavaType> set) {

    }

    public void addGeneralMethodAnnotation(Method method, IntrospectedTable introspectedTable, IntrospectedColumn introspectedColumn, Set<FullyQualifiedJavaType> set) {

    }

    public void addFieldAnnotation(Field field, IntrospectedTable introspectedTable, Set<FullyQualifiedJavaType> set) {

    }

    public void addFieldAnnotation(Field field, IntrospectedTable introspectedTable, IntrospectedColumn introspectedColumn, Set<FullyQualifiedJavaType> set) {

    }

    public void addClassAnnotation(InnerClass innerClass, IntrospectedTable introspectedTable, Set<FullyQualifiedJavaType> set) {

    }

    public void addConfigurationProperties(Properties properties) {
        this.properties.putAll(properties);
        suppressDate = isTrue(properties.getProperty(PropertyRegistry.COMMENT_GENERATOR_SUPPRESS_DATE));
        suppressAllComments = isTrue(properties.getProperty(PropertyRegistry.COMMENT_GENERATOR_SUPPRESS_ALL_COMMENTS));
    }
    
    /**
     * 判断传入参数是否为true
     * @param property
     * @return
     */
    private boolean isTrue(String property) {
        if("true".equals(property)){
            return true;
        }
        return false;
    }

    /**
     * This method adds the custom javadoc tag for. You may do nothing if you do
     * not wish to include the Javadoc tag - however, if you do not include the
     * Javadoc tag then the Java merge capability of the eclipse plugin will
     * break.
     * 
     * @param javaElement
     *            the java element
     */
    protected void addJavadocTag(JavaElement javaElement, boolean markAsDoNotDelete) {
        javaElement.addJavaDocLine(" *");
        StringBuilder sb = new StringBuilder();
        sb.append(" * ");
        sb.append(MergeConstants.NEW_ELEMENT_TAG);
        if (markAsDoNotDelete) {
            sb.append(" do_not_delete_during_merge");
        }
        String s = getDateString();
        if (s != null) {
            sb.append(' ');
            sb.append(s);
        }
        javaElement.addJavaDocLine(sb.toString());
    }

    /**
     * This method returns a formated date string to include in the Javadoc tag
     * and XML comments. You may return null if you do not want the date in
     * these documentation elements.
     * 
     * @return a string representing the current timestamp, or null
     */
    protected String getDateString() {
        String result = null;
        if (!suppressDate) {
            result = nowTime;
        }
        return result;
    }

    public void addClassComment(InnerClass innerClass, IntrospectedTable introspectedTable) {
        if (suppressAllComments) {
            return;
        }
        StringBuilder sb = new StringBuilder();
        innerClass.addJavaDocLine("/**");
        sb.append(" * ");
        sb.append(introspectedTable.getFullyQualifiedTable());
        sb.append(" ");
        sb.append(getDateString());
        innerClass.addJavaDocLine(sb.toString().replace("\n", " "));
        innerClass.addJavaDocLine(" */");
    }

    public void addEnumComment(InnerEnum innerEnum, IntrospectedTable introspectedTable) {
        if (suppressAllComments) {
            return;
        }
        StringBuilder sb = new StringBuilder();
        innerEnum.addJavaDocLine("/**");
        sb.append(" * ");
        sb.append(introspectedTable.getFullyQualifiedTable());
        innerEnum.addJavaDocLine(sb.toString().replace("\n", " "));
        innerEnum.addJavaDocLine(" */");
    }
    
    /**
     * 设置字段注释
     */
    public void addFieldComment(Field field, IntrospectedTable introspectedTable, IntrospectedColumn introspectedColumn) {
        if (suppressAllComments) {
            return;
        }
        StringBuilder sb = new StringBuilder();
        field.addJavaDocLine("/**");
        sb.append(" * ");
        sb.append(introspectedColumn.getRemarks() + " " + introspectedColumn.getActualColumnName());
        field.addJavaDocLine(sb.toString().replace("\n", " "));
        field.addJavaDocLine(" */");
    }

    public void addFieldComment(Field field, IntrospectedTable introspectedTable) {
        if (suppressAllComments) {
            return;
        }
        StringBuilder sb = new StringBuilder();
        field.addJavaDocLine("/**");
        sb.append(" * ");
        sb.append(introspectedTable.getFullyQualifiedTable());
        field.addJavaDocLine(sb.toString().replace("\n", " "));
        field.addJavaDocLine(" */");
    }

    public void addModelClassComment(TopLevelClass topLevelClass, IntrospectedTable introspectedTable) {

    }

    public void addGeneralMethodComment(Method method, IntrospectedTable introspectedTable) {
        if (suppressAllComments) {
            return;
        }
      method.addJavaDocLine("/**");
      addJavadocTag(method, false);
      method.addJavaDocLine(" */");
    }
    
    /**
     * 设置getter方法注释
     */
    public void addGetterComment(Method method, IntrospectedTable introspectedTable,
            IntrospectedColumn introspectedColumn) {
        if (suppressAllComments) {
            return;
        }
        method.addJavaDocLine("/**");
        StringBuilder sb = new StringBuilder();
        sb.append(" * ");
        sb.append(introspectedColumn.getRemarks());
        method.addJavaDocLine(sb.toString().replace("\n", " "));
        sb.setLength(0);
        
        //加入系统用户
        sb.append(" * @author ");
        sb.append(systemPro.getProperty("user.name"));
        method.addJavaDocLine(sb.toString().replace("\n", " "));
        sb.setLength(0);
        
        //是否加入时间戳
        if(suppressDate){
            sb.append(" * @date " + nowTime);
            method.addJavaDocLine(sb.toString().replace("\n", " "));
            sb.setLength(0);
        }
        
        sb.append(" * @return ");
        sb.append(introspectedColumn.getActualColumnName());
        sb.append(" ");
        sb.append(introspectedColumn.getRemarks());
        method.addJavaDocLine(sb.toString().replace("\n", " "));
        method.addJavaDocLine(" */");
    }
    
    /**
     * 设置setter方法注释
     */
    public void addSetterComment(Method method, IntrospectedTable introspectedTable,
            IntrospectedColumn introspectedColumn) {
        if (suppressAllComments) {
            return;
        }
        method.addJavaDocLine("/**");
        StringBuilder sb = new StringBuilder();
        sb.append(" * ");
        sb.append(introspectedColumn.getRemarks());
        method.addJavaDocLine(sb.toString().replace("\n", " "));
        sb.setLength(0);
        
        //加入系统用户
        sb.append(" * @author ");
        sb.append(systemPro.getProperty("user.name"));
        method.addJavaDocLine(sb.toString().replace("\n", " "));
        sb.setLength(0);
        
        //是否加入时间戳
        if(suppressDate){
            sb.append(" * @date " + nowTime);
            method.addJavaDocLine(sb.toString().replace("\n", " "));
            sb.setLength(0);
        }
        
        Parameter parm = method.getParameters().get(0);
        sb.append(" * @param ");
        sb.append(parm.getName());
        sb.append(" ");
        sb.append(introspectedColumn.getRemarks());
        method.addJavaDocLine(sb.toString().replace("\n", " "));
        method.addJavaDocLine(" */");
    }

    public void addClassComment(InnerClass innerClass, IntrospectedTable introspectedTable, boolean markAsDoNotDelete) {
        if (suppressAllComments) {
            return;
        }
        StringBuilder sb = new StringBuilder();
        innerClass.addJavaDocLine("/**");
        sb.append(" * ");
        sb.append(introspectedTable.getFullyQualifiedTable());
        innerClass.addJavaDocLine(sb.toString().replace("\n", " "));
        sb.setLength(0);
        sb.append(" * @author ");
        sb.append(systemPro.getProperty("user.name"));
        sb.append(" ");
        sb.append(nowTime);
        innerClass.addJavaDocLine(" */");
    }
    
}

3.修改generatorConfig.xml，给commentGenerator元素设置type属性值为我们自定义类的全类名就可以了

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

最后，一般来说我们只需要实现实体类注释的方法就可以，如果觉得要实现CommentGenerator中所有的接口太麻烦的话，也可以让自定义实现类继承DefaultCommentGenerator类，然后重写与实体类属性、getter、setter注释相关的方法就可以了。


 

键盘上的手艺人-cloudFly
关注
专栏目录
Day14(springboot与mybatis整合、mybatis自动代码生成、swagger、thymeleaf、lombok环境配置、mybatisPlus介绍(自动代码生成))
weixin_39919087的博客
05-29 986
srpingboot和mybatis整合 springbootSSM项目下载地址 链接：https://pan.baidu.com/s/11fwh1C7ZOg3jQVlXl2DJjQ 提取码：83yt 依赖 <dependency> <groupId>org.mybatis.spring.boot</groupId> <artifactId>mybatis-spring-boot-starter</artifactId> &l
MyCommentGenerator
11-23
mybatis 生成 源码jar 可以修改注释 说明博客https://blog.csdn.net/ppwwp/article/details/78788145
mybatis-generator自动生成代码(含中文注释)
12-28
mybatis-generator自动生成代码(含中文注释) 这是一个maven项目，下载后直接导入到eclipse或者idea中即可。 修改对应的generatorConfig.xml 改成自己的数据库配置，然后运行App.java即可生成
Mybatis代码生成器如何自定义注释
weixin_43248672的博客
05-10 2841
我们在使用Mybatis代码生成器生成mapper、po以及xml文件的时候，mapper中的方法和po的字段上一般会自动生成一些“无用”的注释，使得代码看起来很乱。为了解决这个问题，一般有三种方式：第一种就是通过配置generatorConfig.xml文件来精简注释，第二种就是通过实现CommentGenerator中的方法，让代码生成器生成我们自己想要的注释效果，第三种既可以做到自定义注释，还能省去get、set方法。 修改generatorConfig.xml中的配置 context &lt
mybatis-generator生成数据表中注释
anmishi2025的博客
09-19 497
0、git clonehttps://github.com/backkoms/mybatis-generator-comments.git，编译打包，install到本地或delopy私服库中均可。 1、pom.xml配置 <build> <plugins> <plugin> <groupId&...
Mybatis-generator自动生成代码时候提取数据库的字段注释作为实体类字段的jar包
12-10
Mybatis-generator自动生成代码时候提取数据库的字段注释作为实体类字段的jar包
mybatis-comment-generator:自定义 Mybatis Generator 注释生成器，默认使用数据库注释作为生成 Java 注释，并支持附加注解
05-01
mybatis-comment-generator 简介 这是用于 中生成注释这一步骤的自定义生成器，默认将数据库注释作为 Java 注释，并支持在生成的 Java 代码中附加注解 示例 <?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE generatorConfiguration PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN" "http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd"> <generatorConfiguration> <properties resource="package/to/your/data_source.properties
mybatis-generator自动生成工具，包含tinyint处理，自动获取数据库注释
11-08
在"mybatis-generator自动生成工具，包含tinyint处理，自动获取数据库注释"这个主题中，有两个关键点值得注意： 1. **Tinyint处理**： 在MySQL数据库中，`TINYINT`是一种小型整数类型，通常用于表示只有几个可能值...
mybatis-generator自动生成字段注释的maven项目，执行StartUp.java即可
06-07
5. 调用`org.mybatis.generator.api.MyBatisGenerator`的`generate()`方法，开始生成代码。 在MBG生成的Java模型类中，字段注释通常是通过解析数据库表的字段注释实现的。如果数据库表的字段有注释，MBG会将其转换...
mybatis-generator.rar
02-07
执行生成命令后，MBG会根据配置文件自动生成代码，这些代码可以直接导入到IDE中，无需手动编写。 6. **自定义模板**：MBG支持自定义模板，这意味着你可以按照自己的喜好调整生成的代码样式，比如添加注释、修改字段...
mybatis-generator 修改版
03-27
MyBatis Generator 是一个自动代码生成工具，可以帮助开发者自动生成 MyBatis 映射文件、Java 模型类以及 DAO 接口，从而提高开发效率。 描述中的 "增加了SQL Server获取数据库注释" 表明这个修改版包含了一个特别...
MyBatis Generator + PostgreSQL 逆向工程单独使用包及使用说明.rar
07-18
PostgerSQL的jar包版本：postgresql-9.3-1102-jdbc4.jar mybatis-generator版本：mybatis-generator-core-1.3.7.jar 关于逆向工程自动生成dao层代码的功能，网上很多介绍的都是mysql版本的，而且介绍的都是在开发环境idea或eclipse中怎么使用，这里整理的是PostgerSQL版本的，而且是单独使用的方法（附jar包，修配置文件直接可以使用），生成dao层文件后，把需要的代码拷贝到自己项目上去即可。 生成的文件内容比较齐全，xml文件包括对应表格的操作包括select、update、delete、insert。这里需要说明一点，如果要操作的表没有主键字段，则生成的xml中只有insert，没有select、update、delete，因为这三种操作都与主键有关，如deleteByPrimaryKey(Long id)、selectByPrimaryKey(Long id)、updateByPrimaryKey(InRoomInfoDao record)。
JComment - Comment Generator-开源
05-14
JComment注释生成器将在java文件内部创建与javadoc兼容的注释。
DefaultCommentGenerator.class
05-11
mybatis generator 生成带中文注释的model类:将mybatis-generator-core-1.3.2.jar包中的org.mybatis.generator.interal.DefaultCommentGenerator.class文件替换，重新执行mybatis generator即可
Mybatis generator eclipse插件从数据库获取注释
dangmao的博客
12-07 1984
由于目前准备开始的项目要用到Mybatis，所以不可避免的要使用Mybatis generator工具通过数据库直接生成map,entity。但在使用过程中，原版的Mybatis generator有很多不足，每次启动的时候还要单独启动，不能在eclipse里面通过插件启动；不能把数据库注释写入文件中是一个最大问题。但是我想要直接带数据库中文注释的eclipse插件，找了好久都没找到，只找到菠萝大
MyBatis Generator系列(二)----自定义CommentGenerator实现中文注释
热门推荐
fendo
10-05 2万+
一、简介 由于MyBatis Generator自带了生成注释的功能,但是,是英文的而且生成的根本无法理解,所以可以通过,修改他的源码来实现生成中文的注释,具体方式有以下几种: 1) 自定义CommentGenerator 2) 修改源码 3) PluginAdapter插件的形式 二、自定义CommentGenerator实现中文注释 2.1、先创建M
MyBatis Generator 自定义CommentGenerator实现中文注释
u010686811的专栏
12-09 3465
MyBatis Generator自定义CommentGenerator实现中文注释(oracle) 目录 MyBatis Generator自定义CommentGenerator实现中文注释 第一步：pom.xml文件 oracle驱动依赖 <dependency> <groupId>org.mybatis.generator</groupId> <artifactId>mybatis-generator-core&lt..
Mybatis Generator的model生成中文注释,支持oracle和mysql(通过实现CommentGenerator接口的方法来实现)...
as2882的博客
11-23 279
自己手动实现的前提,对maven项目有基本的了解,在本地成功搭建了maven环境,可以参考我之前的文章:maven环境搭建 项目里新建表时model,mapper以及mapper.xml基本都是用Mybatis Generator(以下简称为MBG)自动生成的,但是MBG自动生成的model的注释实在有点非人类,至少中国人是完全接受不了的,在配置中禁用掉注释吧,倒是简单了,可是生成的m...
Intellij IDEA 2016学习系列之（三）修改mybatis-generator源码生成中文注释
幸运的天才小驴的专栏
09-04 1万+
如果你进入本文，说明你也是想在mybatis generator 自动生成mapper xml model的时候，自动生成数据库字段的备注为注释信息。那么只要你阅读完本文，就可以帮助你实现你想要的。文章末尾会有源码的地址和jar. 下载mybatis-generator-core源码 源码的修改 修改生成model对象类的注释 在FullyQualifiedTable中添加remark...
mybatis-plus 自动生成代码如何自定义实体名称
最新发布
05-25
MyBatis-Plus 自动生成代码可以通过配置自定义实体名称。你可以在生成代码的配置文件中指定表名和实体类的对应关系，从而实现...这样，MyBatis-Plus 自动生成代码时就会根据配置文件中的信息生成自定义实体名称的代码。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值