逆向工程之实现CommentGenerator接口来实现生成自定义注解的实体类等

最新推荐文章于 2024-03-14 22:36:25 发布
最新推荐文章于 2024-03-14 22:36:25 发布
阅读量2.6k 收藏 2
点赞数 2
文章标签： mybatis generator mysql java
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_39693263/article/details/105650307
版权

一、使用背景

       项目操作数据库层使用的并不是mybatis，而是Spring的JdbcTemple,因此对底层的SQL创建是使用的自定义注解来动态生成。自定义注解对字段多时，手动生成实体类过于繁琐，就想使用逆向工程来生成。网上找的基本都是mybatis的，对自定义注解的比较少。参考了许多人博客后，转载的那个是比较接近的了。 

二、步骤说明

1、pom文件dependencies标签下新增以下依赖

        <!-- mybatis generator-->
        <dependency>
            <groupId>org.mybatis.generator</groupId>
            <artifactId>mybatis-generator-core</artifactId>
            <version>1.3.5</version>
        </dependency>
       <!-- <dependency>
            <groupId>com.oracle</groupId>
            <artifactId>ojdbc6</artifactId>
            <version>6.0</version>
        </dependency>-->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>5.1.9</version>
        </dependency>
plugins标签下配置插件启动配置文件
 <finalName>mybatis-generator-plus</finalName>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <version>2.3.2</version>
                <configuration>
                    <source>1.8</source>
                    <target>1.8</target>
                </configuration>
            </plugin>

            <plugin>
                <groupId>org.mybatis.generator</groupId>
                <artifactId>mybatis-generator-maven-plugin</artifactId>
                <version>1.3.2</version>
                <configuration>                                 
 <configurationFile>src/main/resources/tk_generatorConfig.xml</configurationFile>
                 <overwrite>true</overwrite>
                 <verbose>true</verbose>
                </configuration>


                <dependencies>
                    <dependency>
                        <groupId>mysql</groupId>
                        <artifactId>mysql-connector-java</artifactId>
                        <version>5.1.41</version>
                    </dependency>
                    <dependency>
                        <groupId>tk.mybatis</groupId>
                        <artifactId>mapper</artifactId>
                        <version>3.3.9</version>
                    </dependency>
                </dependencies>
            </plugin>
        </plugins>

maven插件来启动配置文件时没使用到自定义的类，因此我是用的类来加载的。

2、新增tk_generatorConfig文件，名字可以随便取，配置进去就好。

<?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>

    <!-- MyBatis3Simple：不生成 Example相关类及方法 -->
    <context id="Mysql" targetRuntime="MyBatis3Simple" defaultModelType="flat">
        <property name="beginningDelimiter" value="`" />
        <property name="endingDelimiter" value="`" />
        
        <plugin type="org.mybatis.generator.plugins.SerializablePlugin" />
        
       <!--
        <commentGenerator>
            <property name="suppressAllComments" value="true" />
            <property name="suppressDate" value="true"/>
            <property name="javaFileEncoding" value="UTF-8"/>
        </commentGenerator>
        -->
        <!-- 使用MyCommentGenerator来生成自定义注释 -->
        <commentGenerator type="org.mybatis.generator.MyCommentGenerator">
            <property name="suppressAllComments" value="false"></property>
        </commentGenerator>

        <!-- jdbc 数据库连接配置 -->
        <jdbcConnection
                driverClass="com.mysql.jdbc.Driver"
                connectionURL="jdbc:mysql://127.0.0.1:3306/was"
                userId="root"
                password="root">
            <!--因为数据库连接版本过高，加这个配置 解决xml生成其他库相同表的映射字段-->
            <property name="nullCatalogMeansCurrent" value="true" />
        </jdbcConnection>
        

        <!-- 配置数据库表实体类存放路径 -->
        <javaModelGenerator targetPackage="cn.liangjinh.entity" targetProject="src/main/java" />

        <!-- 配置XxxMapper.xml文件存放路径 -->
        <sqlMapGenerator targetPackage="mapper/sign" targetProject="src/main/resources" />

        <!-- 配置XxxMapper实体接口存放路径 -->
        <javaClientGenerator
                targetPackage="cn.liangjinh.dao"
                targetProject="src/main/java" type="XMLMAPPER" />

        <!-- 配置需要生成的表 -->
        <!-- tableName：数据库表名，%代表所有，domainObjectName：生成文件名 ，schema：数据源 -->
        <table tableName="table_name" domainObjectName="table_name" enableCountByExample="false" enableUpdateByExample="false" enableDeleteByExample="false" enableSelectByExample="false" selectByExampleQueryId="false" />
    </context>

</generatorConfiguration>

3、重点就是自定义注释类的实现，由于编译的时候，有可能会提示类与接口不在同一个路径下，因此新建了包org.mybatis.generator并在下面新建了类MyCommentGenerator来实现CommentGenerator接口。具体内容可以参考他的实现类DefaultCommentGenerator，可以直接复制代码然后改下类名就行。他的基本方法都有开头都有一句!this.suppressAllComments来，因此传入的值需要为false。因为我使用到的是在属性上面新增注解。因此修改的主要是addFieldComment这个方法

 /**
     * 为属性注释
     * @param field
     * @param introspectedTable
     * @param introspectedColumn
     */
    public void addFieldComment(Field field, IntrospectedTable introspectedTable, IntrospectedColumn introspectedColumn) {
        if (suppressAllComments) {
            return;
        }
            field.addJavaDocLine("/**");
            String remarks = introspectedColumn.getRemarks();
            if (StringUtility.stringHasValue(remarks)) {
                field.addJavaDocLine(" * Database Column Remarks:");
                String[] remarkLines = remarks.split(System.getProperty("line.separator"));
                String[] var6 = remarkLines;
                int var7 = remarkLines.length;

                for(int var8 = 0; var8 < var7; ++var8) {
                    String remarkLine = var6[var8];
                    field.addJavaDocLine(" *   " + remarkLine);
                }
            }
            field.addJavaDocLine(" *");
            field.addJavaDocLine(" * This field was generated by MyBatis Generator.");
            StringBuilder sb = new StringBuilder();
            sb.append(" * This field corresponds to the database column ");
            sb.append(introspectedTable.getFullyQualifiedTable());
            sb.append('.');
            sb.append(introspectedColumn.getActualColumnName());
            field.addJavaDocLine(sb.toString());
            this.addJavadocTag(field, false);
            field.addJavaDocLine(" */");
            // 根据实体类的自定义注解逆向生成sql
            sb.setLength(0);
            sb.append("@FieldAnnotation(fieldName=\"").append(introspectedColumn.getActualColumnName());
            sb.append("\",");
            /*
            MYSQL字段类型配置为varchar或者longtext时，注解类型为String,
            由于有根据注解的length对实体做长度校验，longtext的长度默认为512
            */
            if ("VARCHAR".equals(introspectedColumn.getJdbcTypeName())
                || "LONGTEXT".equals(introspectedColumn.getJdbcTypeName())) {
            sb.append("fieldType = FieldType.STRING,");
            }
            sb.append("length = ").append(introspectedColumn.getLength()).append(")");
            field.addAnnotation(sb.toString());
    }

4、最后新建启动类StartUp 

package cn.liangjinh.generator;

import org.mybatis.generator.api.MyBatisGenerator;
import org.mybatis.generator.config.Configuration;
import org.mybatis.generator.config.xml.ConfigurationParser;
import org.mybatis.generator.exception.InvalidConfigurationException;
import org.mybatis.generator.exception.XMLParserException;
import org.mybatis.generator.internal.DefaultShellCallback;

import java.io.IOException;
import java.io.InputStream;
import java.net.URISyntaxException;
import java.sql.SQLException;
import java.util.ArrayList;
import java.util.List;


public class StartUp {

    public static void main(String[] args) throws URISyntaxException {
        try {
            System.out.println("--------------------start generator-------------------");
            List<String> warnings = new ArrayList<String>();
            boolean overwrite = true;
            ClassLoader classloader = Thread.currentThread().getContextClassLoader();
            InputStream is = classloader.getResourceAsStream("tk_generatorConfig.xml");
            ConfigurationParser cp = new ConfigurationParser(warnings);
            Configuration config = cp.parseConfiguration(is);
            DefaultShellCallback callback = new DefaultShellCallback(overwrite);
            MyBatisGenerator myBatisGenerator = new MyBatisGenerator(config, callback, warnings);
            myBatisGenerator.generate(null);
            System.out.println("--------------------end generator-------------------");
        } catch (SQLException e) {
            e.printStackTrace();
        } catch (IOException e) {
            e.printStackTrace();
        } catch (InterruptedException e) {
            e.printStackTrace();
        } catch (InvalidConfigurationException e) {
            e.printStackTrace();
        } catch (XMLParserException e) {
            e.printStackTrace();
        }
    }
}

然后直接运行就可以了。

效果展示

/**
     * Database Column Remarks:
     *   创建人员名称
     *
     * This field was generated by MyBatis Generator.
     * This field corresponds to the database column test.CREATE_USERNAME
     *
     * @mbg.generated 2020-04-20
     */
    @FieldAnnotation(fieldName="CREATE_USERNAME",fieldType = FieldType.STRING,length = 150)
    private String createUsername;

    /**
     * Database Column Remarks:
     *   创建人员ID
     *
     * This field was generated by MyBatis Generator.
     * This field corresponds to the database column test.CREATE_USERID
     *
     * @mbg.generated 2020-04-20
     */
    @FieldAnnotation(fieldName="CREATE_USERID",fieldType = FieldType.STRING,length = 96)
    private String createUserid;

英文注释没有删除的原因是为了调试的时候可以看到哪个参数对应哪个值，方便拼接。

项目结构图

 

修改类注释的话就重写addModelClassComment这个方法。亲测可以了

希望这个对有使用自定义注释的有所帮助。

参考链接 https://blog.csdn.net/u011781521/article/details/78161201

 

 

起个不重复的名字真难
关注
  • 2
    点赞
  • 踩
  • 2
    收藏
    觉得还不错? 一键收藏
  • 3
    评论
实现生成自定义注解的实体类
01-03
本篇文章将详细探讨如何实现生成自定义注解的实体类，以及它们在实际开发中的应用。 一、自定义注解的定义 自定义注解的定义类似于接口，但以`@interface`关键字开头。下面是一个简单的自定义注解示例： ```java @...
java自定义注解接口实现方案
09-05
但这并不意味着接口的实现类会自动继承接口上的注解，只有类之间的继承关系才适用。 接下来，我们来看如何自定义注解。以下是一个简单的自定义注解示例： ```java @Retention(RetentionPolicy.RUNTIME) @Target...
mybatis generator自带的commentGenerator如何配置
最新发布
tian_xuezhi的专栏
03-14 337
我看着MyBatis Generator生成的mapper真是烦，好多注释，然后查了一下很多兄弟也有同感。然后查了一下官网，原来MyBatis Generator自带的commentGenerator也可以配置。有些兄弟发文说可以动手写个commentGenerator，就可以不生成注释了。把上面这段加入generatorConfig文件中，再执行一下。我觉得挺好的，但是要写代码，还要调试，就有点麻烦。生成的类对象就干干净净啦。
MyBatis Generator系列(二)----自定义CommentGenerator实现中文注释
fendo
10-05 2万+
一、简介 由于MyBatis Generator自带了生成注释的功能,但是,是英文的而且生成的根本无法理解,所以可以通过,修改他的源码来实现生成中文的注释,具体方式有以下几种: 1) 自定义CommentGenerator 2) 修改源码 3) PluginAdapter插件的形式 二、自定义CommentGenerator实现中文注释 2.1、先创建M
mybatis-generator自定义实现生成entity,xml含中文注释
m0_37539286的博客
07-06 1858
mybatis-generator自定义实现生成entity,xml含中文注释
Mybatis-generator自动生成代码时提取自定义注释
yanyf的博客
11-08 551
在上篇文章中 https://blog.csdn.net/yanyf2016/article/details/102972195 生成的实体类没有数据库自己定义的注释， 根据网上找到的资料以及阅读Mybatis-generator源码，发现可以通过自定义注释生成器 CommentGenerator 接口的实现类来达到我们的目的。 通过阅读源码可以看到，代码生成注释是通过DefaultComm...
MyBatis积累(2)：Mybatis Generator 自定义注释
mingyuli的博客
02-17 699
`
Mybatis Generator的model生成中文注释,支持oracle和mysql(通过修改源码的方式来实现)...
as2882的博客
11-25 346
在看本篇之前,最好先看一下上一篇通过实现CommentGenerator接口的方法来实现中文注释的例子,因为很多操作和上一篇基本是一致的,所以本篇可能不那么详细. 首先说一下上篇通过实现CommentGenerator接口的一些不足,毕竟只是实现了CommentGenerator接口,在里面的方法再怎么改,有效的也只是针对model类,并且使用的人大概也发现了,里面的addClassC...
Spring AOP 自定义注解的实现代码
08-30
同时，自定义注解还可以用于描述类、方法、参数等的元数据，以便在编程中实现更多的功能。 在编程中，我们可以使用 @interface 关键字来定义自定义注解，例如： ```java @Target({ElementType.METHOD}) @Retention...
自定义逆向工程 可生成Table注解 自定义继承通用mapper
09-21
通过自定义逆向工程，我们可以让MBG在生成的实体类上自动添加Table注解，包括表名、主键信息等，这样可以减少手动编写这些元数据的工作量，提高代码一致性。 示例： ```java @Table(name = "user") public ...
MyCommentGenerator
11-23
mybatis 生成 源码jar 可以修改注释 说明博客https://blog.csdn.net/ppwwp/article/details/78788145
DefaultCommentGenerator.class
05-11
mybatis generator 生成带中文注释的model类:将mybatis-generator-core-1.3.2.jar包中的org.mybatis.generator.interal.DefaultCommentGenerator.class文件替换，重新执行mybatis generator即可
JComment - Comment Generator-开源
05-14
JComment注释生成器将在java文件内部创建与javadoc兼容的注释。
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
Java自定义注解实现Redis自动缓存的方法
08-30
Java自定义注解实现Redis自动缓存的方法是指在Java应用程序中使用自定义注解来实现Redis自动缓存的功能。该方法可以在实际开发中节省重复劳动，提高开发效率。 首先，需要创建一个自定义注解@RedisCache，该注解将...
代码生成器Mybatis-Generator使用教程
kesteler的博客
03-07 5052
Generator
mybatis-generator自定义注释生成
热门推荐
一头磕在键盘上
02-24 4万+
mybatis-generator 生成自定义注释
myBatis-generator 生成中文注释的问题
会开车的野人的专栏
03-27 2540
mybatis.generator的官方插件只能生成一些无用的英文注释，要生成中文注释需要修改源代码。 现在以mybatis.generator-1.3.5为例，说明修改源代码的内容。 修改的内容一共两个类:DefaultCommentGenerator.java和 MyBatisGenerator.java ；这两个类均来自org.mybatis.generator.core_1.3.5.2
mybatisgenerator自定义注释
hyhanyu的博客
10-29 906
一般在生成java bean的时候，希望把 sql中的备注信息全都生成出来。这时需要自己定义注释生成。写一个类继承 DefaultCommentGenerator 把DefaultCommentGenerator 然后对addFieldComment方法进行重写，并且把其他的加注解的方法根据需要是否添加，如果只希望在java bean上有注解存在，那么把期他方法不实现。 public v...
Eclipse Hibernate: 新手指南-反向生成带注解实体类详细步骤
你可以通过调试或查询数据库来验证生成的实体类是否符合预期，以及注解是否正确表示了数据库中的表结构和字段关系。 通过以上步骤，你将能够熟练地在Eclipse中使用Hibernate进行反向生成带注解的实体类，这将极大地...
评论 3
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值