mybatis-generator插件 自动生成代码，自定义实体类(lombok带注释)

已于 2022-11-02 09:19:00 修改
阅读量1.5k 收藏 4
点赞数 1
分类专栏： java 文章标签： mybatis java
于 2022-10-28 10:06:27 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_43945716/article/details/127565885
版权

因为mybatis-generator插件生成的entity实体类，注释和getter、setter方法不够简洁

lombok插件

package org.mybatis.generator.plugins;

import org.mybatis.generator.api.IntrospectedColumn;
import org.mybatis.generator.api.IntrospectedTable;
import org.mybatis.generator.api.PluginAdapter;
import org.mybatis.generator.api.dom.java.FullyQualifiedJavaType;
import org.mybatis.generator.api.dom.java.Interface;
import org.mybatis.generator.api.dom.java.Method;
import org.mybatis.generator.api.dom.java.TopLevelClass;

import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.List;

public class LombokPlugin extends PluginAdapter {
    public LombokPlugin() {
    }

    public boolean validate(List<String> list) {
        return true;
    }

    public boolean modelBaseRecordClassGenerated(TopLevelClass topLevelClass, IntrospectedTable introspectedTable) {
        topLevelClass.addImportedType("java.io.Serializable");
        topLevelClass.addImportedType("lombok.Data");
        topLevelClass.addImportedType("lombok.EqualsAndHashCode");
        topLevelClass.addImportedType("lombok.experimental.Accessors");
//        topLevelClass.addImportedType("lombok.NoArgsConstructor");
//        topLevelClass.addImportedType("lombok.AllArgsConstructor");
        topLevelClass.addAnnotation("@Data");
        topLevelClass.addAnnotation("@EqualsAndHashCode(callSuper = false)");
        topLevelClass.addAnnotation("@Accessors(chain = true)");
//        topLevelClass.addAnnotation("@NoArgsConstructor");
//        topLevelClass.addAnnotation("@AllArgsConstructor");
        topLevelClass.addJavaDocLine("/**");
        topLevelClass.addJavaDocLine(" * @author ");
        topLevelClass.addJavaDocLine(" * @date " + (new SimpleDateFormat("yyyy/MM/dd/hh:mm")).format(new Date()));
        topLevelClass.addJavaDocLine(" */");
        topLevelClass.addSuperInterface(new FullyQualifiedJavaType("java.io.Serializable"));
        return true;
    }

    public boolean clientGenerated(Interface anInterface, TopLevelClass topLevelClass, IntrospectedTable introspectedTable) {
        anInterface.addJavaDocLine("/**");
        anInterface.addJavaDocLine(" * @author");
        anInterface.addJavaDocLine(" * @date " + (new SimpleDateFormat("yyyy/MM/dd/hh:mm")).format(new Date()));
        anInterface.addJavaDocLine(" */");
        return true;
    }

    public boolean modelSetterMethodGenerated(Method method, TopLevelClass topLevelClass, IntrospectedColumn introspectedColumn, IntrospectedTable introspectedTable, ModelClassType modelClassType) {
        return false;
    }

    public boolean modelGetterMethodGenerated(Method method, TopLevelClass topLevelClass, IntrospectedColumn introspectedColumn, IntrospectedTable introspectedTable, ModelClassType modelClassType) {
        return false;
    }
}

自定义注释方法，重写CommentGenerator

package org.mybatis.generator.plugins;

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;

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

/**
 * @author HelSing
 * @date 2019/3/18
 */
public class MybatisCommentGenerator implements CommentGenerator {

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

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


    /**
     * 类的注释
     * @param innerClass
     * @param introspectedTable
     * @param markAsDoNotDelete
     */
    @Override
    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(" */");
    }

    @Override
    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(" */");
    }

    /**
     * 设置字段注释
     */
    @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() + " " + introspectedColumn.getActualColumnName());
        field.addJavaDocLine(sb.toString().replace("\n", " "));
        field.addJavaDocLine(" */");
    }

    @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(" */");
    }

    @Override
    public void addModelClassComment(TopLevelClass topLevelClass, IntrospectedTable introspectedTable) {

    }

    /**
     * 设置setter方法注释
     */
    @Override
    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(" */");
    }

    /**
     * 设置getter方法注释
     */
    @Override
    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(" */");
    }

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

    @Override
    public void addComment(XmlElement xmlElement) {
        return;
    }

    @Override
    public void addRootComment(XmlElement rootElement) {
        return;
    }

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

    }

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

    }

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

    }

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

    }

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

    }

    @Override
    public void addConfigurationProperties(Properties properties) {
        this.properties.putAll(properties);
        suppressDate = Boolean.valueOf(properties.getProperty(PropertyRegistry.COMMENT_GENERATOR_SUPPRESS_DATE));
        suppressAllComments = Boolean.valueOf(properties.getProperty(PropertyRegistry.COMMENT_GENERATOR_SUPPRESS_ALL_COMMENTS));
    }

    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());
    }

    protected String getDateString() {
        String result = null;
        if (!suppressDate) {
            result = nowTime;
        }
        return result;
    }

    @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(" */");
    }

    @Override
    public void addGeneralMethodComment(Method method, IntrospectedTable introspectedTable) {
        if (suppressAllComments) {
            return;
        }
        method.addJavaDocLine("/**");
        addJavadocTag(method, false);
        method.addJavaDocLine(" */");
    }
}

方法路径一定要和org.mybatis.generator.plugins保持一致

然后把编译的class文件，放到你实际项目引入的mybatis-generator-core.jar的plugins文件里再次生成代码即可
在这里插入图片描述

在这里插入图片描述

生成的实体类

自动生成代码点击跳转

李鑫友
关注
  • 1
    点赞
  • 踩
  • 4
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
专栏目录
使用mybatis插件mybatis-generator 自动生成lombok注解,去除get和set方法,自动为实体添加数据库字段的注释
weixin_55586010的博客
03-01 1654
1.pom文件依赖2.generator.xml文件注意：generator.xml文件中的标签是有顺序的 顺序不对会报错的 关于lombok的配置在plugin标签中。
实体类带注释、支持lombok的mybatis-generator-core-1.3.7.jar
05-30
mybatis-generator-core-1.3.7.jar 带注释，支持lombok，如 @Data public class Person { /** * 自增ID */ private Long id; }
mybatis-generator整合lombok及swagger格式注解
02-07
最近由于项目需要，研究了一下mybatis-generator，利用mybatis-generator读取数据库表格及字段配置，生成实体类对应注释，同时通过实现lombok及swagger自定义插件来实现自定义格式注释，通过开关控制注释格式。下载资源解压后，通过idea打开项目，其中lib目录下的mybatis-generator-core-1.0.1.jar包需要放到本地仓库中，下载相关依赖后，执行MyBatisGeneratorRun类里的main方法启动即可。
自定义mybatis-generator生成工具
weixin_41111360的博客
04-11 2096
首先，mybatis提供的这套底层代码生成工具是非常人性化的，用户直接依赖jar包就可以一键生成，并且提供一套配置文件，让用户进行灵活的配置以满足不同的用户需求。然而，只通过简单的修改配置文件还远远无法满足我们的需求，那怎么办呢？幸运的是，mybatis-generator可以让用户实现其相应的接口来自定义自己的代码风格，如代码注释（CommentGenerator），java类型（JavaTyp...
使用 zliss-mybatis-generator 开源mybatis代码生成器生成mybatis代码 支持自定义模板
最新发布
xhei997的博客
05-12 261
只需简单引入后，即可使用生成数据库对应的mybatis代码文件，支持生成、maven-plugin插件方式生成。
MyBatis Generator系列(八)----MyBatis Generator自定义插件实现自定义Mapper
热门推荐
fendo
12-02 1万+
一、创建基类 有时候会通过创建实体的基类，用来复用一些代码，然后让其他的实体类集成这个类: package com.fendo.bean; /** * @Title: BaseModel.java * @Package com.fendo.bean * @Description: 实体基类 * @author fendo * @date 2017年12月2日 下午5
mybatis generator为实体类生成自定义注释
梦想起飞的地方.........
10-21 3122
mybatis generator为实体类生成自定义注释（读取数据库字段的注释添加到实体类，不修改源码） 我们都知道mybatis generator自动生成的注释没什么实际作用，而且还增加了代码量。如果能将注释从数据库中捞取到，不仅能很大程度上增加代码的可读性，而且减少了后期手动加注释的工作量。 1、首先定义注释生成插件 MyCommentGenerator.java package com.ilovey.mybatis.comment; import org.mybatis.gener.
【mybatis-generator】mybatis代码生成器generator，生成文件名自定义配置
qq_35448165的博客
01-12 1568
在根据表名生成实体类时，其类名和字段名默认使用驼峰命名，比方说 CREATE_DATE，生成的属性名字就是createDate相关属性设置：但是表名有时候比较长，我们就想要自己定义生成的文件名。
自定义mybatis-generator自动生成代码时的类型转换
Roy_70的专栏
09-07 1万+
一、mybatis-generator问题 大家在使用mybatis的时候，有些时候需要使用mybatis generator来逆向生成mapper和entity层。 这其中一个问题在于，表设计的时候，出于最大程度节省表空间的考虑，不少枚举使用了tinyint类型，但是在进行自动生成的时候，默认生成的java字段是Byte类型，但是我想要的是Integer类型，这就对程序中使用产生了不便。 ...
MyBatis-plus+达梦数据库实现自动生成代码的示例
09-07
为了使 MyBatis-Plus 能够识别并正确处理达梦数据库，你可能还需要自定义一个实体扫描器（EntityScanner）和一个数据库 ID 生成器（IDGenerator），因为 MyBatis-Plus 默认的 ID 生成策略可能不适用于达梦数据库。...
mybatis-plus-generator：代码生成器
02-21
Mybatis-Plus Generator 是一个基于 Mybatis 和 Mybatis-Plus 的强大代码生成工具，它能够极大地提高开发效率，通过简单的配置就能自动生成常见的 CRUD 操作代码、Mapper 接口及 XML 文件、实体类等。这款工具是开源...
MyBatis-Plus Generator配置详解
09-07
MyBatis-Plus Generator是一款强大的代码生成工具，它是MyBatis-Plus框架的一部分，能够帮助开发者自动生成Java实体类、Mapper接口及XML配置文件等，大大提高了开发效率。下面将详细介绍如何配置和使用MyBatis-Plus ...
Myabtis-Plus自定义代码生成器与自定义代码生成模板
a1091758887的博客
08-29 1432
在编写代码时我们会编写大量与业务无关的代码，比如Contoller，Service，Entity以及一些增删改查接口的定义，这些代码基本都是固定的模板，手动编写浪费大量时间，今天介绍一下Mybatis-Plus代码生成器来简化代码的开发，减少重复代码的编写。 ......
MyBatis Generator 自定义输出格式内容
郑志雄
06-03 3205
自定义mybaits的数据格式和内容 1.使用maven的MyBatis-Generator。 2.定制自己的mybtis-generator-core.jar 1）git clone https://github.com/ppj117/mybatis-generator-core 到本地 2）安装这个jar到本地仓库 mvn install -Dmaven.t...
如何使用MybatisX插件创建实体类
赵达宇的博客
07-06 1274
1、file-settings 选择markteplace 找到 小蓝鸟 MyBatisX。当你数据库已经建立好，我们可以用MybatisX插件来创建实体类。点击右边侧边栏的DataBase 加入MySQL。module path 要选择对应的模块。如果你添加完这个插件后，pom报错。点开数据库 ， 选中表格 右键。
Mybatis-plus 实体类自定义查询注解
qq_33775107的博客
06-21 4007
自定义查询注解是为实体类中某些实体属性作为查询条件定义的，在实体属性上引入注解可以实现自动生成查询条件QueryWrapper的功能。
【SpringBoot教程】开发提效工具Lombok引入 Mybatis-plus-generator代码自动生成工具
大数据小禅的博客
05-26 4098
一个优秀的Java代码库，简化了Java的编码，为Java代码的精简提供了一种方式你是否发现每个JavaBean都会写getter，setter，equals，hashCode和toString的模板代码，特别的多于没技术lombok消除Java的冗长代码，尤其是对于简单的Java对象，只要加上注解就行。
Springboot mybatis generate 自动生成实体类和Mapper
LSW1737554365的博客
06-26 4025
运行MyBatisGeneratorApp类即可实现自动生成实体类、mapper接口、mapper.xml
代码生成器:mybatis-plus-generator自定义模板生成 dto、vo、convertor
05-25
Mybatis-Plus 是一个基于 Mybatis 的增强工具，它简化了 Mybatis 的开发流程，提供了很多实用的功能，其中之一就是代码生成器。代码生成器可以根据数据库表结构自动生成实体类、mapper 接口、xml 文件等代码，极大地提高了开发效率。但是，Mybatis-Plus 自动生成的实体类并不一定满足我们的需求，因此我们需要自定义模板来生成我们需要的类。 下面，我将介绍如何使用 Mybatis-Plus 自定义模板生成 dto、vo、convertor。 1. 创建自定义模板 我们需要在 Mybatis-Plus 的代码生成器中创建自定义模板。打开 Mybatis-Plus 的代码生成器，点击“自定义模板”选项卡，然后点击“添加模板”按钮，输入模板名称和文件名，然后点击“保存”按钮。 在模板编辑器中，我们可以使用 FreeMarker 语法来编写模板。下面是一个简单的模板示例，用于生成 dto 类： ``` package ${dtoPackage}; import lombok.Data; @Data public class ${dtoName} { <#list table.columnList as column> private ${column.javaType} ${column.propertyName}; </#list> } ``` 在这个模板中，我们使用 `${}` 占位符来引用变量。`dtoPackage` 和 `dtoName` 变量由代码生成器自动提供，表示生成的 dto 类的包名和类名。`table` 变量表示当前生成的表信息，包含表名、列名、列类型等信息。我们使用 `<#list>` 和 `</#list>` 标签来遍历表的列信息，并生成对应的属性。 2. 配置代码生成器 在使用自定义模板之前，我们需要配置代码生成器。打开 Mybatis-Plus 的代码生成器，点击“全局配置”选项卡，在“自定义配置”中添加以下配置： ``` # dto 模板配置 dto=templates/dto.java.vm dtoOutputDir=src/main/java/${dtoPackage}/ ``` 其中，`dto` 是我们自定义模板的名称，`dtoOutputDir` 是生成的 dto 类的输出目录。我们还可以添加其他自定义模板和输出目录，例如： ``` # vo 模板配置 vo=templates/vo.java.vm voOutputDir=src/main/java/${voPackage}/ # convertor 模板配置 convertor=templates/convertor.java.vm convertorOutputDir=src/main/java/${convertorPackage}/ ``` 3. 生成代码 配置完成后，我们可以点击“执行”按钮来生成代码。代码生成器将根据配置生成实体类、mapper 接口、xml 文件、dto、vo、convertor 等代码。我们只需要将生成的代码复制到项目中即可。 总结 使用 Mybatis-Plus 的代码生成器可以大大提高开发效率，而自定义模板则可以生成我们需要的类。通过自定义模板，我们可以生成 dto、vo、convertor 等常用类，避免手写重复的代码，提高开发效率和代码质量。
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值