mybatis generator 搭配lombok ,逆向生成字段类注释

最新推荐文章于 2024-03-18 17:17:45 发布
最新推荐文章于 2024-03-18 17:17:45 发布
阅读量1.1k 收藏 11
点赞数 5
文章标签： maven java generator plugin
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/Nba_3210/article/details/107708799
版权

逆向生成字段类注释

自定义插 的实现方式有两种：

1，实现接口 **Plugin**
2, 继承抽象类：**PluginAdapter**  （已经实现了接口Plugin ,功能更丰富）-推荐使用

自定义插件说明

我使用的是mybatis-generator-core 是 1.3.7 版本。

					<dependencies>
                        <dependency>
                            <groupId>org.mybatis.generator</groupId>
                            <artifactId>mybatis-generator-core</artifactId>
                            <version>1.3.7</version>
                        </dependency>
                    </dependencies>

打开mybatis-generator-core-1.3.7.jar 我们看到org.mybatis.generator.plugins 下已经有很多插件了
在这里插入图片描述

我们自定义插件也要放在这个包下。所以，我们也要建一个包名为：org.mybatis.generator.plugins。
如果我们随意定的报名，在执行mybatis-generator 时，会找不到你自定义的包名。

下面开始上代码：

逆生成表字段说明

根据数据库表字段，字段说明。逆向生成java 类的时候，自动生成字段注释

MyCommentPlugin.java

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.Field;
import org.mybatis.generator.api.dom.java.JavaElement;
import org.mybatis.generator.api.dom.java.JavaVisibility;
import org.mybatis.generator.api.dom.java.TopLevelClass;
import org.mybatis.generator.internal.util.StringUtility;
import util.GsonUtil;

import java.util.LinkedHashMap;
import java.util.List;

/**
 * 逆生成字段注释插件
 * @author author
 * @date 2020/7/30 16:54
 */
public class MyCommentPlugin extends PluginAdapter {


    private static final String SEPARATION = ",";
    private static final String JSON_PREFIX = "{";
    private static final String JSON_SUFFIX = "}";

    private boolean makeConstant = true;

    /**
     * 这里已经要返回true
     * true : 插件生效
     * false : 插件失效
     * @param warnings
     * @return
     */
    @Override
    public boolean validate(List<String> warnings) {
        return true;
    }

    @Override
    public boolean modelFieldGenerated(Field field, TopLevelClass topLevelClass, IntrospectedColumn introspectedColumn, IntrospectedTable introspectedTable, ModelClassType modelClassType) {
        this.comment(field, topLevelClass, introspectedColumn, introspectedTable);
        return true;
    }

    private void comment(JavaElement element, TopLevelClass topLevelClass, IntrospectedColumn introspectedColumn, IntrospectedTable introspectedTable) {
        element.getJavaDocLines().clear();
        element.addJavaDocLine("/**");
        //获取列字段注解
        String remark = introspectedColumn.getRemarks();
        if (remark != null && remark.length() > 1) {
            element.addJavaDocLine(" * " + remark);
            element.addJavaDocLine(" *");
        }
        // 根据项目要求，可以加上自定义的注解
    //    element.addJavaDocLine(" * Column:    " + introspectedColumn.getActualColumnName());
    //    element.addJavaDocLine(" * Length:    " + introspectedColumn.getLength());
    //    element.addJavaDocLine(" * DefaultValue:  " + (StringUtility.stringHasValue(introspectedColumn.getDefaultValue()) ? introspectedColumn.getDefaultValue() : "无默认值"));
    //    element.addJavaDocLine(" * Nullable:  " + introspectedColumn.isNullable());

        // mysql 中自增主键，添加 AutoIncrement:  true 说明
        boolean autoIncrement = introspectedColumn.isAutoIncrement();
        if (autoIncrement) {
            element.addJavaDocLine(" * AutoIncrement:  true");
        }
        element.addJavaDocLine(" */");
        if (this.makeConstant) {
            System.out.println("start constant " + introspectedColumn.getActualColumnName());
            if (StringUtility.stringHasValue(remark) && remark.contains(JSON_PREFIX) && remark.contains(JSON_SUFFIX)) {
                //截取常量字符串
                String commentJson = remark.substring(remark.indexOf(JSON_PREFIX), remark.lastIndexOf(JSON_SUFFIX) + 1);
                try {
                    LinkedHashMap<String, String> commentMap = GsonUtil.fromJson(commentJson,LinkedHashMap.class);

                    commentMap.forEach((key, value) -> {
                        Field field = new Field();
                        //常量字段属性名 以列字段名+_+json key 值为字段名
                        field.setName(introspectedColumn.getActualColumnName().toUpperCase() + "_" + key.toUpperCase());
                        field.setStatic(true);
                        field.setFinal(true);
                        //设置常量字段类型与列字段一致
                        field.setType(introspectedColumn.getFullyQualifiedJavaType());
                        //常量字段属性描述
                        String desc = "";
                        //常量字段属性值
                        String constant = "";
                        if (value.contains(SEPARATION)) {
                            String[] split = value.split(SEPARATION);
                            constant = split[0];
                            desc = split[1];
                        } else {
                            constant = value;
                        }
                        field.setInitializationString(constant);
                        field.setVisibility(JavaVisibility.PUBLIC);
                        field.addJavaDocLine("/**");
                        field.addJavaDocLine("* " + introspectedColumn.getActualColumnName() + ":" + desc);
                        field.addJavaDocLine("*/");
                        if (introspectedTable.getTargetRuntime() == IntrospectedTable.TargetRuntime.MYBATIS3_DSQL) {
                            context.getCommentGenerator().addFieldAnnotation(field, introspectedTable,
                                    topLevelClass.getImportedTypes());
                        } else {
                            context.getCommentGenerator().addFieldComment(field, introspectedTable);
                        }
                        //将常量加入BD实体类
                        topLevelClass.addField(field);
                    });
                } catch (Exception e) {
                    e.printStackTrace();
                }
            }
        }
    }
}

2，使用lombok 注解方式

MyLombokPlugin.java

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;

/**
 * @author author
 * @date 2020/7/30 16:52
 */
public class MyLombokPlugin extends PluginAdapter {

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

    @Override
    public boolean modelBaseRecordClassGenerated(TopLevelClass topLevelClass, IntrospectedTable introspectedTable) {
        // 到入需要注解的包
        topLevelClass.addImportedType("lombok.Data");
        // topLevelClass.addImportedType("lombok.Builder");
        //  topLevelClass.addImportedType("lombok.NoArgsConstructor");
        // topLevelClass.addImportedType("lombok.AllArgsConstructor");

        // 添加domain的注解
        topLevelClass.addAnnotation("@Data");
        // topLevelClass.addAnnotation("@Builder");
        // topLevelClass.addAnnotation("@NoArgsConstructor");
        //   topLevelClass.addAnnotation("@AllArgsConstructor");

        // 添加domain的注释
        topLevelClass.addJavaDocLine("/**");
        //   topLevelClass.addJavaDocLine("* @ClassName: " + topLevelClass.getType().getShortName());
        //  topLevelClass.addJavaDocLine("* @Description: ");
        topLevelClass.addJavaDocLine("* @author: Mybatis Generator");
        topLevelClass.addJavaDocLine("* @date " + date2Str(new Date()));
        topLevelClass.addJavaDocLine("*/");
        return true;
    }

    @Override
    public boolean clientGenerated(Interface interfaze, TopLevelClass topLevelClass,
                                   IntrospectedTable introspectedTable) {
        // Mapper文件的注释
        interfaze.addJavaDocLine("/**");
        //   interfaze.addJavaDocLine("* @ClassName: " + interfaze.getType().getShortName());
        //   interfaze.addJavaDocLine("* @Description: ");
        interfaze.addJavaDocLine("* @author: Mybatis Generator");
        interfaze.addJavaDocLine("* @date " + date2Str(new Date()));
        interfaze.addJavaDocLine("*/");
        return true;
    }

    @Override
    public boolean modelSetterMethodGenerated(Method method, TopLevelClass topLevelClass,
                                              IntrospectedColumn introspectedColumn, IntrospectedTable introspectedTable, ModelClassType modelClassType) {
        // 不生成getter
        return false;
    }

    @Override
    public boolean modelGetterMethodGenerated(Method method, TopLevelClass topLevelClass,
                                              IntrospectedColumn introspectedColumn, IntrospectedTable introspectedTable, ModelClassType modelClassType) {
        // 不生成setter
        return false;
    }

    /**
     * 格式化时间字符串
     *
     * @param date
     * @return
     * @author: renkai721
     * @date: 2018年7月13日 上午11:17:52
     * @Title: date2Str
     * @Description:
     */
    private String date2Str(Date date) {
        SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
        return sdf.format(date);
    }

}

generatorConfig.xml

<?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>
       <!--引入mysql 连接 数据库的jar-->
    <classPathEntry location="D:\m2e\repository\mysql\mysql-connector-java\8.0.15\mysql-connector-java-8.0.15.jar"/>
    <context id="default" targetRuntime="MyBatis3">

        <plugin type="org.mybatis.generator.plugins.MyLombokPlugin">
            <property name="hasLombok" value="true"/>
        </plugin>
        <!--自定义注释插件-->
        <plugin type="org.mybatis.generator.plugins.MyCommentPlugin">
            <!--开启根据注释生成常量,需把常量字段定义为json-->
            <!--模板规则-->
            <!--注释{'常量后缀1':'值#描述','常量后缀2':'值#描述’}-->
            <property name="makeConstant" value="true"/>
            <!--作者-->
            <property name="author" value="author"/>
        </plugin>

        <commentGenerator>
            <property name="suppressDate" value="true"/>
            <property name="suppressAllComments" value="true"/>
        </commentGenerator>

        <jdbcConnection driverClass="com.mysql.jdbc.Driver"
                        connectionURL="jdbc:mysql://ip:3306/库名"
                        userId="username"
                        password="密码">
        </jdbcConnection>

        <javaModelGenerator targetPackage="com.xxx.entity"
                            targetProject="./src/main/java">
            <property name="trimStrings" value="true"/>
            <property name="immutable" value="false"/>
        </javaModelGenerator>
        <sqlMapGenerator targetPackage="dao"
                         targetProject="./src/main/resources">
        </sqlMapGenerator>
        <javaClientGenerator type="XMLMAPPER"
                             targetPackage="com.xxx.dao"
                             targetProject="./src/main/java">
        </javaClientGenerator>
        <table tableName="表名" domainObjectName="XxxEntity"
               enableSelectByPrimaryKey="true" enableUpdateByPrimaryKey="true"
               enableDeleteByPrimaryKey="true">
        </table>
    </context>
</generatorConfiguration>

pom.xml

<?xml version="1.0" encoding="UTF-8"?>

<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.wl.mybatis</groupId>
    <artifactId>mybatis-generator</artifactId>
    <version>1.0-SNAPSHOT</version>
    <packaging>war</packaging>

    <name>mybatis-generator Maven Webapp</name>
    <!-- FIXME change it to the project's website -->
    <url>http://www.example.com</url>

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <maven.compiler.source>1.8</maven.compiler.source>
        <maven.compiler.target>1.8</maven.compiler.target>
    </properties>

    <dependencies>

        <dependency>
            <groupId>org.mybatis.generator</groupId>
            <artifactId>mybatis-generator-core</artifactId>
            <version>1.3.7</version>
        </dependency>

        <dependency>
            <groupId>com.google.code.gson</groupId>
            <artifactId>gson</artifactId>
            <version>2.8.6</version>
        </dependency>

        <dependency>
            <groupId>cn.hutool</groupId>
            <artifactId>hutool-all</artifactId>
            <version>5.3.5</version>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.18.12</version>
        </dependency>
        <dependency>
            <groupId>org.mybatis</groupId>
            <artifactId>mybatis</artifactId>
            <version>3.5.5</version>
        </dependency>

    </dependencies>

    <build>
        <finalName>mybatis-generator</finalName>
        <pluginManagement><!-- lock down plugins versions to avoid using Maven defaults (may be moved to parent pom) -->
            <plugins>
                <!-- mybatis-generator -->
                <plugin>
                    <groupId>org.mybatis.generator</groupId>
                    <artifactId>mybatis-generator-maven-plugin</artifactId>
                    <version>1.3.7</version>
                    <configuration>
                        <!-- mybatis-generator的配置文件，根据情况调整位置 -->
                        <configurationFile>src/main/resources/generatorConfig.xml</configurationFile>
                        <verbose>true</verbose>
                        <overwrite>true</overwrite>
                    </configuration>
                    <dependencies>
                        <dependency>
                            <groupId>org.mybatis.generator</groupId>
                            <artifactId>mybatis-generator-core</artifactId>
                            <version>1.3.7</version>
                        </dependency>
                    </dependencies>
                </plugin>
            </plugins>

        </pluginManagement>
    </build>

</project>

GsonUtil.java

package util;

import com.google.gson.Gson;
import com.google.gson.GsonBuilder;

/**
 * @author author
 * @date 2020/7/30 17:25
 */
public class GsonUtil {

    private static final GsonBuilder gsonBuilder = new GsonBuilder();
    private static final Gson gson = new Gson();

    public static String toJson(Object obj) {
        return gsonBuilder.serializeNulls().create().toJson(obj);
    }

    public static <T> T fromJson(String str,Class<T> clazz){
        return gson.fromJson(str ,clazz);
    }
}

最后编译MyCommentPlugin.java, MyLombokPlugin.java 建生成 class 文件
在这里插入图片描述
将这两个文件 copy 到
mybatis-generator-core-1.3.7.jar 的 org.mybatis.generator.plugins 目录下

在这里插入图片描述

最后执行：

在这里插入图片描述

最后在工程中就会生成对应的实体类：
在这里插入图片描述

最后说明：
以上两个插件功能也是网上参考大牛写的 再整理优化的。大牛的文档找不到了所以没法贴出对应大牛的文档链接，请见谅！

思念的眷恋
关注
mybatis-generator+lombok自动生成mybatis代码
11-27
自己找资料，慢慢高了一个mybatis自动生成代码的类，当然是在mybatis-generator基础之上的，由于项目中有lombok，所以需要对生成的地方进行改造。我将改造后的文件都打包上传了，需要的同学拿去吧 zip包里面包含： ...
mybatis-generator 整合lombok
u013068184的博客
06-10 9147
使用Lombok工具可以在生成实体类时省掉getter/setter以及构造方法等等代码，使得代码整体更加简洁优雅。在使用MyBatis时，可以利用generator映射数据库反向生成相对应得实体类以及mapper接口和mapper.xml文件。 这实现过程的关键时需要自己继承接口自定义一个插件实现类。 代码： pom.xml文件（引入org.mybatis.generator依赖以及配置插件，这...
mybatis generator插件系列--lombok插件 （减少百分之九十bean代码）
weixin_33918357的博客
09-16 1009
经常使用mybatis generator生成代码的你 有没有因为生成的getter/setter而烦恼呢？ 有没有生成后又手动加toString/hashCode/Equals方法呢？ 有没有改一个字段又要手动改写getter/setter/toString/hashCode/Equals呢？ 下面我将介绍一个mybatis generator Lomb...
Mybatis Generator 之整合 Lombok
青城山上学编程
10-09 1159
继的大胆想法实现后，小编已经开始膨胀，以至于暗中馋上了 Lombok 的身子。别怪小编太下贱，怎奈 Lombok 链式编程等一系列丝滑操作太诱人。要实现这个伟大的目标，需经历以下几个步骤。
【MyBatis框架】MyBatis使用lombok插件和generator自动化简化开发
haohaoxuexiyai的博客
11-25 1094
一、lombok插件 1.1 lombok的安装 <dependency> <groupId>org.projectlombok</groupId> <artifactId>lombok</artifactId> <version>1.18.2</version> <scope>provided</scope> </dependency> 1.2 lomb
使用mybatis插件mybatis-generator(lombok）
最新发布
weixin_51296247的博客
03-18 956
***/@Override/*** 为实体添加lombok的注解* @return*/@Override//添加domain的import*///添加domain的注解*///添加domain的注释/*** 为实体类字段添加注释* @return*/@Override@Override//不生成getter@Override//不生成setter。
mybatis generator 使用方法教程(生成带注释的实体类)
08-29
MyBatis Generator 使用方法教程（生成带注释的实体类） MyBatis Generator 是一个强大的工具，能够根据数据库表自动生成 Java 实体类、DAO、Mapper.xml 等文件，从而提高开发效率和减少开发时间。在本教程中，我们...
MybatisGenerator代码生成器（可查询指定字段）
08-06
MybatisGenerator本身是没有提供查询指定字段的，例如数据库有5个字段，我想查询其中3个...经过研究MybatisGenerator实现原理，在保证原有功能的基础上，实现了生成查询指定字段的相关方法，下载即可使用。eclipse！
MyBatis Generator 自定义生成注释的方法
08-26
MyBatis Generator 自定义生成注释的方法 MyBatis Generator 是一个基于 Java 的持久层框架，它能够根据数据库表结构生成对应的实体类、Mapper 接口和 XML 配置文件。MyBatis Generator 提供了强大的自定义功能，...
mybatis-plus快速逆向生成代码
03-07
0.解压后查看说明文档。 1.pom.xml中增加对应引入包 2.复制FastAutoGeneratorTest.java到自己的项目中 然后更改引入包路径 3.更改数据库源 4.更改生成代码路径 5.执行main方法
使用mybatis插件mybatis-generator 自动生成lombok注解,去除get和set方法,自动为实体添加数据库字段的注释
weixin_55586010的博客
03-01 1725
1.pom文件依赖2.generator.xml文件注意：generator.xml文件中的标签是有顺序的 顺序不对会报错的 关于lombok的配置在plugin标签中。
mybatis generator配合lombok使用
白_的博客
06-20 3791
生成jar 有jar可直接点击 jar下载地址 1 新建一个springboot项目 路径和图里一致 LombokPlugin package org.mybatis.generator.plugins; import org.mybatis.generator.api.IntrospectedColumn; import org.mybatis.generator.api.IntrospectedTable; import org.mybatis.generator.api.PluginAdapter
【SpringBoot教程】开发提效工具Lombok引入 Mybatis-plus-generator代码自动生成工具
大数据小禅的博客
05-26 4272
一个优秀的Java代码库，简化了Java的编码，为Java代码的精简提供了一种方式你是否发现每个JavaBean都会写getter，setter，equals，hashCode和toString的模板代码，特别的多于没技术lombok消除Java的冗长代码，尤其是对于简单的Java对象，只要加上注解就行。
mybatis-generator+lombok+mysql8整合
qq_31145141的博客
09-23 480
简介： 项目使用的数据库对应实体类，dao，mapper.xml文件非常多，而且手写包含了大量的get，set，toString等方法。 generator：减少了大量的dao层工作量 lombok：减少了实体类的get，set等方法，使实体类更加简洁，增加了对应数据库的注释字段。 idea安装lombok插件 ctrl+alt+s 或 File -> Settings...
mybatis-generator自动生成代码(lombok带注释)
ldy_sm的博客
09-02 2318
mybatis-generator自动生成代码(lombok带注释) 最近接触到的项目都会用到mybatis框架，会涉及到实体和表的映射，mapper以及mapper.xml的生成，mybatis-generator插件可以根据表结构自动生成实体、mapper、mapper.xml，大大简化了开发的工作量，现有的插件有点小缺陷，注释没有获取数据库字段的注释（mysql为例就是字段的comment），包括不支持lombok。 查阅相关资料，我这边修改了下mybatis-generator-core-1.3.
mybatis-generator 分页和lombok插件
qq_33080131的博客
01-16 468
在生成的DO类加上@Data和@NoArgsConstructor注解，引入lombok.Data和lombok.NoArgsConstructor，并且将数据库的列的comment自动添加到字段注释上。当前mybatis-generator官方插件生成的example不支持分页参数，另外也没有继承lombok类，生成的类里有大量的getter和setter不够精简。在生成的XxxExample中加入两个属性limit和offset，同时加上set和get方法。如果有更多拓展想法可联系本人，将为你实现。
Mybatis-generator生成字段注释
赵海鑫|芽孢八叠球菌|John Helsing
05-22 8875
Mybatis自动生成工具能够根据数据库表/视图等自动生成相应的bean和mapper，大大的简化了开发工作。 但默认的生成bean并没有将数据库表中的字段注释也放到生成的bean的属性上。 本文记录如何让mybatis-generator根据数据库表字段注释生成bean的属性注释。 一.编写自定义注释生成工具 首先我们要实现CommentGenerator这个接口，编写一个自定义注释生成工具...
mybatis generator 生成中文字段注释
qq_40562912的博客
02-20 1584
首先，试了好几次，重写DefaultCommentGenerator ，创建MyCommentGenerator类实现CommentGenerator接口，都是按照网上的方案来的，执行也没问题，但是就是没有实体生成，然后又看到说可以直接改jar包的方法，那么我就下手改了， 首先说一下我引的包，引入了一个plugin插件，且内部引入了generator 核心包和 mysql驱动包 <p...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值