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

已于 2022-11-02 09:19:00 修改
阅读量1.4k 收藏 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
    评论
专栏目录
实体类带注释、支持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-plus-generator自定义模板生成 DTO、VO、Convertor、增删改查方法
万物皆字节
08-06 7745
在开发后台管理系统的时候，感觉基本上操作都是一样的：curd，于是借助并扩展mp的代码生成器自动生成一套api,减少重复劳动而且还统一规范，何乐而不为
MyBatis generator - 简单使用（4）- 自定义生成（修改源码）
mytt_10566的博客
06-28 2125
一、官方相关文档 github：https://github.com/mybatis/generator 文档：http://mybatis.org/generator/index.html 二、自定义生成 在上一篇博客（MyBatis generator - 简单使用（3）- 自定义注释）中自定义了注释生成器，可以还是不能满足需求，所以这篇博客示例下直接修改源码后生成符合需求的模板代码，不局限于注释。 从github下载源码就可搞了。 ...
mybatis-generator代码生成（支持自定义类型转换）
lichuangcsdn的博客
07-01 9796
前面我写过一个通过插件方式生成Dao接口代码（参考链接地址：https://blog.csdn.net/lichuangcsdn/article/details/80873229），但没找到自定义类型转换的方法，比如默认是将Mysql中tinyint类型转换为java中的Byte字段，但通常我们需求一般是将tinyint转换为java中的Integer类型，所以需要自己写个类型转换组件了。主要思路...
mybatis generator 自定义类名(修改mybatis-generator-1.3.2源码改dao类名)
Carson的专栏
09-06 692
网上找了一大堆的例子，感觉这个比较全，比较细，就是写的比较多，如果想看详细的，请看下面的链接，自动忽略我的： http://www.blogjava.net/bolo/archive/2015/03/20/423683.html 本篇只写手头只有一个eclipse的情况下（maven插件已经装好了），怎么修改dao的类名 1.建maven项目： 1） 2） 3） 4） 5）如果没有...
mybatis-generator+lombok自动生成mybatis代码
11-27
自己找资料，慢慢高了一个mybatis自动生成代码的类，当然是在mybatis-generator基础之上的，由于项目中有lombok，所以需要对生成的地方进行改造。我将改造后的文件都打包上传了，需要的同学拿去吧 zip包里面包含： generatorConfig.xml mybatis-generator-core-1.3.6.jar mybatis-generator-core-1.3.6-sources.jar pom.xml 直接下载就可以用
自定义mybatis-generator生成工具
weixin_41111360的博客
04-11 2059
首先，mybatis提供的这套底层代码生成工具是非常人性化的，用户直接依赖jar包就可以一键生成，并且提供一套配置文件，让用户进行灵活的配置以满足不同的用户需求。然而，只通过简单的修改配置文件还远远无法满足我们的需求，那怎么办呢？幸运的是，mybatis-generator可以让用户实现其相应的接口来自定义自己的代码风格，如代码注释（CommentGenerator），java类型（JavaTyp...
Mybatis Generator 自定义生成的一些总结
斯旺森swanson
09-09 495
Mybatis Generator 官方简称MBG，中国IT行业也经常称之为Mybatis逆向工程（由数据库生成Java代码）。提供了丰富的自定义生成文件的方法。不直接修改源代码的情况下，自定义生成文件主要通过以下几种方式：更改配置、替换生成器、编写插件。 配置 标签指定生成模式，可生成简洁版，普通版XML版，无XML采用注解版< 标签的rootClass属性，可为模型类添加父类。 标签的rootInterface属性，指定Dao的父接口。 替换生成器 替换注释生成器 替换Dao生成器 <ja
mybatis generator 扩展--自定义生成类
wuhulala的休息室
02-17 1598
背景 随着越来越多的增删改查和当前固定的开发模式，所以很多代码已经可以自动的进行生成，刚好感觉mbg这个工具很好使用，想着可以不可以直接使用它进行增删改查基本的代码的生成呢？ 后面经过搜索，发现了一些扩展点 扩展点 生成自定义的类 Plugin.java /** * 用于生成针对每一张表自的额外定义java文件 * * @param introspectedTab...
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整合lombok及swagger格式注解
02-07
最近由于项目需要，研究了一下mybatis-generator，利用mybatis-generator读取数据库表格及字段配置，生成实体类对应注释，同时通过实现lombok及swagger自定义插件来实现自定义格式注释，通过开关控制注释格式。...
mybatis-generator-core-1.3.5.jar
09-23
mybatis-generator+lombok整合插件jar包 generator：减少了大量的dao层工作量 lombok：减少了实体类的get，set等方法，使实体类更加简洁，增加了对应数据库的注释字段。
mybatis-generator-core-1.3.7.jar
08-24
mybatis-generatorjar包,生成的实体类自动带上swagger和lombok注解标签
mybatis-generator-数据库表映射实体，生成mapper.xml，适用于mybatis-puls
04-11
比原版本新增：实体类中添加了@Data lombok注解；添加了Myabtis-plus中的注解@TableName和@TableField；添加了sql中对字符串的空判断，之前只有null判断；DAO层继承了BaseMapper，适用于mybatis-plus； mybatis-plus...
Mybatis generator 代码生成器添加自定义方法
迷宫的博客
02-26 1131
代码生成器生成的接口查询的话，没有查询单条数据的，返回的是一个集合，然后去判空，再获取第一个数据，多写了不必要的步骤。所以直接如果能生成一个接口，直接返回一条数据就好了。废话不多说,增加根据id查询一条数据的接口。 有三个文件 public class CustomPlugin extends PluginAdapter { @Override public boolean validate(List<String> warnings) { return
Mybatis学习笔记九：自定义Generator Plugin
热门推荐
zsy3313422的专栏
11-16 1万+
上一章中知道了如何使用Mybatis Generator Plugin自动生成Mapper、Model和相关配置文件。但是在实际使用情况中，可能会遇到不同的个性化需求，那么就需要Generator的自定义插件来实现。1、创建基类在项目中，我们经常要把一些具有通用方法的实体类建立一个基类，提高代码复用程度。 假设每一个表中都有字段id和username，且每一个表都需要类似的CRUD方法（如根据主键
Mybatis-generator生成类，添加自定义方法，避免反复修改的方法
最新发布
12-22 378
采用继承方式解决Mybatis-generator可以生成类反复需要手工修改问题。Mybatis-generator可以方便的生成类，Mapper,XML ，但如有手工添加代码，XML时，再次生成会被覆盖。
MyBatis-Plus Generator自定义模板
nidongla的博客
04-05 1366
相信大家在开发过程中，应该都用过Mybatis-Plus的Generator，但是可能没有自定义过模板并使用。 每个项目都应该有一个从Controller层到Mapper层的通用模板，来去掉哪些简单的重复开发工作。 至于如何自定义模板并开发，大家可以先看看这篇博文，以及其附带的三篇博文，相信您一定有收获。 Ⅰ、奋斗青年LOVE Ⅱ、Github链接 Ⅲ、呵呵彡 如果您看完的话，应该也能手动制作一个自己风格的开发模板。 MyBatis-Plus的默认模板引擎是Velocity，但是这个引擎似乎多年没有人维护.
mybatis generator为实体类生成自定义注释
梦想起飞的地方.........
10-21 3052
mybatis generator为实体类生成自定义注释（读取数据库字段的注释添加到实体类，不修改源码） 我们都知道mybatis generator自动生成的注释没什么实际作用，而且还增加了代码量。如果能将注释从数据库中捞取到，不仅能很大程度上增加代码的可读性，而且减少了后期手动加注释的工作量。 1、首先定义注释生成插件 MyCommentGenerator.java package com.ilovey.mybatis.comment; import org.mybatis.gener.
代码生成器:mybatis-plus-generator自定义模板生成 dto、vo、convertor
05-25
但是，Mybatis-Plus 自动生成的实体类并不一定满足我们的需求，因此我们需要自定义模板来生成我们需要的类。 下面，我将介绍如何使用 Mybatis-Plus 自定义模板生成 dto、vo、convertor。 1. 创建自定义模板 我们...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值