关于mybatis generator生成中文注释

最新推荐文章于 2021-09-18 11:08:09 发布
最新推荐文章于 2021-09-18 11:08:09 发布
阅读量1.1k 收藏 2
点赞数
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/baidu_41573665/article/details/86520274
版权
本文介绍了如何创建MyCommentGenerator类实现CommentGenerator接口，以在Mybatis Generator生成的代码中添加中文注释。通过修改generator.xml配置，设置自定义的commentGenerator，并在pom.xml中配置相关依赖，最终在运行main方法后，成功生成包含中文注释的Mapper代码。
摘要由CSDN通过智能技术生成

1、创建MyCommentGenerator类实现CommentGenerator接口

package gengrator;

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.TextElement;
import org.mybatis.generator.api.dom.xml.XmlElement;
import org.mybatis.generator.config.MergeConstants;
import org.mybatis.generator.config.PropertyRegistry;

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

import static org.mybatis.generator.internal.util.StringUtility.isTrue;

/**
 * @Description: 修改注释
 * @Author: 
 * @CreateDate: 2019/1/16 16:38
 */
public class MyCommentGenerator implements CommentGenerator {

    /**
     * properties配置文件
     */
    private Properties properties;
    /**
     * properties配置文件
     */
    private Properties systemPro;
    /*
     * 父类时间
     */
    private boolean suppressDate;
    /**
     * 父类所有注释
     */
    private boolean suppressAllComments;
    /**
     * 当前时间
     */
    private String currentDateStr;

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


    /**
     * @Description: 此方法返回格式化的日期字符串以包含在Javadoc标记中和XML注释。
     * @Author: 
     * @CreateDate: 2019/1/16 16:58
     */
    protected String getDateString() {
        String result = null;
        if (!suppressDate) {
            result = currentDateStr;
        }
        return result;
    }

    /**
     * @Description: 从该配置中的任何属性添加此实例的属性CommentGenerator配置。
     * @Author: 
     * @CreateDate: 2019/1/16 16:55
     */
    @Override
    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));
    }

    /**
     * @Description: 为字段添加注释
     * @Author: 
     * @CreateDate: 2019/1/16 17:02
     */
    @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());
        field.addJavaDocLine(sb.toString().replace("\n", " "));
        field.addJavaDocLine(" */");
    }

    /**
     * @Description: Java属性注释
     * @Author: 
     * @CreateDate: 2019/1/16 17:01
     */
    @Override
    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(" */");
    }

    /**
     * @Description: 为模型类添加注释
     * @Author: 
     * @CreateDate: 2019/1/16 17:06
     */
    @Override
    public void addModelClassComment(TopLevelClass topLevelClass, IntrospectedTable introspectedTable) {
        if (suppressAllComments) {
            return;
        }
        topLevelClass.addJavaDocLine("/**");
        topLevelClass.addJavaDocLine("* @Description:");
        topLevelClass.addJavaDocLine("* @Author: chf");
        topLevelClass.addJavaDocLine("* @CreateDate: " + getDateString());
        topLevelClass.addJavaDocLine("*/");
    }

    /**
     * @Description: Java类的类注释
     * @Author: 
     * @CreateDate: 2019/1/16 16:52
     */
    @Override
    public void addClassComment(InnerClass innerClass, IntrospectedTable introspectedTable) {
        if (suppressAllComments) {
            return;
        }
        innerClass.addJavaDocLine("/**");
        innerClass.addJavaDocLine("* @Description:");
        innerClass.addJavaDocLine("* @Author: chf");
        innerClass.addJavaDocLine("* @CreateDate: " + getDateString());
        innerClass.addJavaDocLine("*/");
    }

    /**
     * @Description: 为类添加注释
     * @Author: 
     * @CreateDate: 2019/1/16 16:53
     */
    @Override
    public void addClassComment(InnerClass innerClass, IntrospectedTable introspectedTable, boolean b) {
        if (suppressAllComments) {
            return;
        }
        innerClass.addJavaDocLine("/**");
        innerClass.addJavaDocLine("* @Description:");
        innerClass.addJavaDocLine("* @Author: chf");
        innerClass.addJavaDocLine("* @CreateDate: " + getDateString());
        innerClass.addJavaDocLine("*/");
    }

    /**
     * @Description: 为枚举添加注释
     * @Author: 
     * @CreateDate: 2019/1/16 17:00
     */
    @Override
    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(" */");
    }

    /**
     * @Description: 给getter方法加注释
     * @Author: 
     * @CreateDate: 2019/1/16 17:04
     */
    @Override
    public void addGetterComment(Method method, IntrospectedTable introspectedTable, IntrospectedColumn introspectedColumn) {}

    /**
     * @Description: 给setter方法加注释
     * @Author: 
     * @CreateDate: 2019/1/16 17:07
     */
    @Override
    public void addSetterComment(Method method, IntrospectedTable introspectedTable, IntrospectedColumn introspectedColumn) {}

    /**
     * @Description: 普通方法的注释，这里主要是XXXMapper.java里面的接口方法的注释
     * @Author: 
     * @CreateDate: 2019/1/16 17:03
     */
    @Override
    public void addGeneralMethodComment(Method method, IntrospectedTable introspectedTable) {
        if (suppressAllComments) {
            return;
        }
        method.addJavaDocLine("/**");
        meth
最低0.47元/天 解锁文章
止水于石
关注
  • 0
    点赞
  • 踩
  • 2
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
mybatis-generator自动生成dao、mapping、bean配置详解(转)
S1ow
11-13 1万+
<!DOCTYPE generatorConfiguration PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN" "http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd"> <!-- 可以用于加载配置项或者配置文件，在整个配置文件中就可以使用$
mybatis-generator自动生成代码(含中文注释)
12-28
mybatis-generator自动生成代码(含中文注释) 这是一个maven项目，下载后直接导入到eclipse或者idea中即可。 修改对应的generatorConfig.xml 改成自己的数据库配置，然后运行App.java即可生成
mybatis-generator生成数据库中文注释
07-17
mybatis-generator生成数据库中文注释，非常详细，方便易用
mybatis generator插件中文注释解决方案
09-26
mybatis generator默认生成的注释不包含英文，这个是修复过的。详情使用请参考我的博客。https://my.oschina.net/kkrgwbj/blog/748591
mybatis-generator生成Model带中文注释
01-16
mybatis-generator生成Model带中文注释，生成的是数据库字段里的备注信息。工具通过本人反编译调整过，如有其它需求欢迎一起探讨。
MyBatis Generator去掉生成的注解
09-01
2. `<property name="suppressAllComments" value="true" />`：这个属性更加直接，如果你将其设置为`true`，MyBatis Generator将完全不生成任何注释，包括默认的自动生成注释和日期注释。 除了上述的基本配置，`...
MyBatis Generator 自定义生成注释的方法
08-26
MyBatis Generator 自定义生成注释的方法 MyBatis Generator 是一个基于 Java 的持久层框架，它能够根据数据库表结构生成对应的实体类、Mapper 接口和 XML 配置文件。MyBatis Generator 提供了强大的自定义功能，...
mybatis generator 使用方法教程(生成带注释的实体类)
08-29
MyBatis Generator 使用方法教程（生成带注释的实体类） MyBatis Generator 是一个强大的工具，能够根据数据库表自动生成 Java 实体类、DAO、Mapper.xml 等文件，从而提高开发效率和减少开发时间。在本教程中，我们...
MyBatis Generator eclipse 插件 修改版【有中文注释】
07-22
eclipse 插件，使用MyBatis Generator 可自动生成数据库对应的bean（有中文注释），mapper.xml和mapper dao 接口文件，可直接使用查询数据库，此插件在eclipse mars.2 版本下亲测可用，
能完美生成中文注释的mybatis-generator
10-13
能够完美将数据库字段中文注释生成在实体类注释中的mybatis-generator工具，使用方便，按照说明一步一步的做下去就可生成成功
mybatis-generator生成带中文注释POJO类的超详细教程含代码和图解
11-17
mybatis-generator自动生成带中文注释POJO类和增删改查,idea和eclipes都可以使用
简单版mybatis-generator 带有中文注释
10-24
改造过的mybatis-generator 带有中文注释，减少了配置文件的复杂度。
mybatis-generator 解决中文注释乱码
05-12
如果是eclipse工具，直接生成的，则替换：plugins/org.mybatis.generator.core_1.3.2*****.jar,如果是其他方式则直接替换掉官方的mybatis-generator-core1.3.2.jar即可
Mybatis Generator生成底层实体（含中文注释）
04-01
普通的java项目，主要通过mybatis生成底层文件，其中包含了生成中文注释功能（对应数据库字段的注释），详细请参考：http://www.cnblogs.com/mengzw/p/6655001.html
mybatis generator 自定义注释生成
10-26
在“mybatis generator 自定义注释生成”这个主题中，我们主要关注的是如何在生成的代码中添加自定义的注释，特别是支持中文的表字段注释。这对于后期的代码维护和团队协作至关重要，清晰的注释能帮助理解代码逻辑，...
mybatis generator 生成中文注释
weixin_33795833的博客
07-16 122
 mybatis generator默认生成 的注释太奇葩了，完全不能拿到生产去用，不过幸亏提供了接口可以自己扩展。长话短说，要生成如下的domain， package com.demo.domain; /** test_mybatis */ public class TestMybatis { /** 主键 */ private Integer id; /** ...
Mybatis-Generator生成数据库的中文注释
09-19 620
使用过Mybatis3的朋友，相信应该听说过MBG插件，配合maven集成到eclipse，一条命令生成数据表对应的model,dao,mapper,ma...
Mybatis generator插件生成中文注释
qq_41988229的博客
09-18 399
到新的公司发现每个人用各自的代码生成插件，十分不方便，没有一套公司规范化的流程。使用generator插件遇到了不少问题，网上查找发现并不完善。在此附上自己用的一套以及遇到的 一些问题。基于oracle数据库 1，相关jar包 <!-- mybatis生成 jar包 --> <dependency> <groupId>org.mybatis.generator</groupId> <artifactId>mybatis-g.
mybatis generator 自定义生成
最新发布
05-14
MyBatis Generator 是 MyBatis 官方提供的一个代码生成工具，可以根据数据库表结构自动生成对应的 Java 实体类、Mapper 文件和 XML 映射文件等代码。如果需要对 MyBatis Generator 自动生成的代码进行定制，可以通过...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值