maven创建generator逆向自定义注解

最新推荐文章于 2022-10-25 10:50:57 发布
最新推荐文章于 2022-10-25 10:50:57 发布
阅读量565 收藏 1
点赞数 4
分类专栏： Java敏捷开发
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_40356439/article/details/89197019
版权

使用maven创建generator逆向生成自定义注解

项目目录结构

在这里插入图片描述

pom.xml插入

<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>cn.localhost</groupId>
  <artifactId>generator</artifactId>
  <version>0.0.1-SNAPSHOT</version>
  
  <name>sql-mapper</name>
  <url>http://maven.apache.org</url>

  <dependencies>
      <dependency>
            <groupId>org.mybatis.generator</groupId>
            <artifactId>mybatis-generator-core</artifactId>
            <version>1.3.6</version>
        </dependency>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>5.1.29</version>
        </dependency>
        <dependency>
            <groupId>log4j</groupId>
            <artifactId>log4j</artifactId>
            <version>1.2.17</version>
        </dependency>
    </dependencies>
</project>

log4j.properties

log4j.rootLogger=DEBUG, Console
#Console
log4j.appender.Console=org.apache.log4j.ConsoleAppender
log4j.appender.Console.layout=org.apache.log4j.PatternLayout
log4j.appender.Console.layout.ConversionPattern=%d [%t] %-5p [%c] - %m%n
log4j.logger.java.sql.ResultSet=INFO
log4j.logger.org.apache=INFO
log4j.logger.java.sql.Connection=DEBUG
log4j.logger.java.sql.Statement=DEBUG
log4j.logger.java.sql.PreparedStatement=DEBUG

编写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>
    <!--导入属性配置 -->
    <!--<properties resource="generator.properties"></properties> -->

    <!--指定特定数据库的jdbc驱动jar包的位置 -->
    <classPathEntry
        location="C://Users//31649//.m2//repository//mysql//mysql-connector-java//5.1.29//mysql-connector-java-5.1.29.jar" />

    <context id="default" targetRuntime="MyBatis3">

        <!-- 配置生成pojo的序列化的插件，mybatis支持很多插件，这些插件都在 org.mybatis.generator.plugins包下 -->
        <plugin
            type="org.mybatis.generator.plugins.SerializablePlugin" />

        <!-- 配置生成pojo的toString()方法的插件，mybatis支持很多插件，这些插件都在 org.mybatis.generator.plugins包下 -->
        <plugin
            type="org.mybatis.generator.plugins.ToStringPlugin" />

        <!-- optional，旨在创建class时，对注释进行控制 -->
        <commentGenerator
            type="cn.localhost.MyCommentGenerator">
            <!-- <property name="suppressDate" value="true" /> <property 
                name="suppressAllComments" value="true" /> -->
        </commentGenerator>

        <!--jdbc的数据库连接 -->
        <jdbcConnection
            driverClass="com.mysql.jdbc.Driver"
            connectionURL="jdbc:mysql://127.0.0.1:3306/jxpt_uat"
            userId="root" password="123456">
            <property name="nullCatalogMeansCurrent"
                value="true" />
        </jdbcConnection>


        <!-- 非必需，类型处理器，在数据库类型和java类型之间的转换控制 -->
        <javaTypeResolver>
            <property name="forceBigDecimals" value="false" />
        </javaTypeResolver>

       <!-- Model模型生成器,用来生成含有主键key的类，记录类 以及查询Example类 targetPackage 
            指定生成的model生成所在的包名 targetProject 指定在该项目下所在的路径 -->
        <javaModelGenerator
            targetPackage="cn.localhost.pojo"
            targetProject="src/main/java">

            <!-- 是否允许子包，即targetPackage.schemaName.tableName -->
            <property name="enableSubPackages" value="true" />
            <!-- 是否对model添加 构造函数 -->
            <!--<property name="constructorBased" value="false" /> -->
            <!-- 是否对类CHAR类型的列的数据进行trim操作 -->
            <property name="trimStrings" value="true" />
            <!-- 建立的Model对象是否 不可改变 即生成的Model对象不会有 setter方法，只有构造方法 -->
            <!--<property name="immutable" value="false" /> -->
        </javaModelGenerator>

        <!--Mapper映射文件生成所在的目录 为每一个数据库的表生成对应的SqlMap文件 -->
        <sqlMapGenerator
            targetPackage="mapper"
            targetProject="src/main/resources">
            <property name="enableSubPackages" value="true" />
        </sqlMapGenerator>

        <!-- 客户端代码，生成易于使用的针对Model对象和XML配置文件 的代码 type="ANNOTATEDMAPPER",生成Java 
            Model 和基于注解的Mapper对象 type="MIXEDMAPPER",生成基于注解的Java Model 和相应的Mapper对象 type="XMLMAPPER",生成SQLMap 
            XML文件和独立的Mapper接口 -->
        <javaClientGenerator
            targetPackage="cn.localhost.dao"
            targetProject="src/main/java" type="XMLMAPPER">
            <property name="enableSubPackages" value="true" />
        </javaClientGenerator>
        <table tableName="t_XXX"
               domainObjectName="TXXX" enableCountByExample="false"
               enableUpdateByExample="false" enableDeleteByExample="false"
               enableSelectByExample="false" selectByExampleQueryId="false">
        </table>
    </context>
</generatorConfiguration>

编写自定义注解类MyCommentGenerator

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

import org.mybatis.generator.api.IntrospectedColumn;
import org.mybatis.generator.api.IntrospectedTable;
import org.mybatis.generator.api.dom.java.Field;
import org.mybatis.generator.api.dom.java.InnerClass;
import org.mybatis.generator.api.dom.java.Method;
import org.mybatis.generator.api.dom.java.Parameter;
import org.mybatis.generator.api.dom.java.TopLevelClass;
import org.mybatis.generator.internal.DefaultCommentGenerator;
import org.mybatis.generator.internal.util.StringUtility;

/**
 * @author Yah LI E-mail:XXX@qq.com
 * @version 创建时间：2019年3月29日 下午9:26:57 类说明
 */
public class MyCommentGenerator extends DefaultCommentGenerator {
	private 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());
	}

	/**
	 *  实体参数自定义注解
	 * 
	 * */
	@Override
	public void addFieldComment(Field field, IntrospectedTable introspectedTable,
			IntrospectedColumn introspectedColumn) {
		if (suppressAllComments) {
			return;
		}
		StringBuilder sb = new StringBuilder();
		field.addJavaDocLine("/**");
		sb.append(" * <pre><b>column</b> : ");
		sb.append(introspectedColumn.getActualColumnName());
		sb.append("\n");
		sb.append("     * <br><b>comment</b> : " + introspectedColumn.getRemarks());
		sb.append("\n");
		sb.append("     * <br><b>type</b> : " + introspectedColumn.getJdbcTypeName() + "( "
				+ introspectedColumn.getLength() + " )");
		sb.append("\n");
		sb.append("         * 允许空: ( " + introspectedColumn.isNullable() + " ) 缺省值: ( "
				+ introspectedColumn.getDefaultValue() + " )");
		sb.append("\n");
		sb.append("     *");
		sb.append("\n");
		sb.append("     * @version " + currentDateStr);
		field.addJavaDocLine(sb.toString());
		field.addJavaDocLine(" */");
	}

	@Override
	public void addFieldComment(Field field, IntrospectedTable introspectedTable) {

	}

	/**
	 * 
	 * mapper接口自定义注解
	 * */
	@Override
	public void addGeneralMethodComment(Method method, IntrospectedTable introspectedTable) {
		if (suppressAllComments) {
			return;
		}
		StringBuilder sb = new StringBuilder();
		sb.append("/**");
		sb.append("\n");
		sb.append("	* ");
		sb.append("\n");
		sb.append("	* @author {自己名称}" + "\n");
		if (!suppressDate) {
			sb.append("	* @date " + currentDateStr + "\n");
		}

		List<Parameter> parameters = method.getParameters();

		for (Parameter parameter : parameters) {
			sb.append("	* @param " + parameter.getName() + "\n");
		}
		sb.append("	* @return " + method.getReturnType());
		sb.append("\n" + "	*/");
		method.addJavaDocLine(sb.toString());
	}

	// Get 方法注釋
	@Override
	public void addGetterComment(Method method, IntrospectedTable introspectedTable,
			IntrospectedColumn introspectedColumn) {
		if (suppressAllComments) {
			if (StringUtility.stringHasValue(introspectedColumn.getRemarks())) {
				method.addJavaDocLine("//获取:" + introspectedColumn.getRemarks());
			}
		} else {
			super.addGetterComment(method, introspectedTable, introspectedColumn);
		}
	}

	// Set 方法注釋
	@Override
	public void addSetterComment(Method method, IntrospectedTable introspectedTable,
			IntrospectedColumn introspectedColumn) {
		if (suppressAllComments) {
			if (StringUtility.stringHasValue(introspectedColumn.getRemarks())) {
				method.addJavaDocLine("//设置:" + introspectedColumn.getRemarks());
			}
		} else {
			super.addSetterComment(method, introspectedTable, introspectedColumn);
		}
	}

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

		sb.setLength(0);
		sb.append(" * @author ");
		sb.append(systemPro.getProperty("user.name"));
		sb.append(" ");
		sb.append(currentDateStr);

		addJavadocTag(innerClass, markAsDoNotDelete);

		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());
		innerClass.addJavaDocLine(" */");
	}

	/**
	 * 生成实体类头自定义注释
	 * */
	@Override
	public void addModelClassComment(TopLevelClass topLevelClass, IntrospectedTable introspectedTable) {
		if (suppressAllComments) {
			return;
		}
		StringBuilder sb = new StringBuilder();
		sb.append("/**");
		sb.append("\n");
		sb.append(" * <p> TableName : " + introspectedTable.getFullyQualifiedTableNameAtRuntime() + " </p >");
		sb.append("\n");
		sb.append(" * @author {公司名称/自己名称}" + "\n");
		sb.append(" * CopyRight Copyright 1999-2019 {公司官网} Inc. All rights reserved. \n");
		if (!suppressDate) {
			sb.append(" * @date " + currentDateStr + "\n");
		}
		sb.append(" */");
		topLevelClass.addJavaDocLine(sb.toString());
	}
}

编写启动类MyBatisGeneratorApp

import java.io.File;
import java.util.ArrayList;
import java.util.List;

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

/**
 * @author Yah LI E-mail:XXX@qq.com
 * @version 创建时间：2019年3月29日 下午9:27:16 类说明
 */
public class MyBatisGeneratorApp {
	public void generator() throws Exception {

		List<String> warnings = new ArrayList<String>();
		boolean overwrite = true;
		// 指定 逆向工程配置文件
		// 如果在启动的时候报IO异常，找不到该文件，但是按住ctrl键有可以读取该文件，那么就写入绝对路径
		// 如果报出IOException 那么换成全路径 File configFile = new File("D:\\local_test\\manage\\src\\main\\resources\\generatorConfig.xml");
		File configFile = new File("generatorConfig.xml");
		ConfigurationParser cp = new ConfigurationParser(warnings);
		Configuration config = cp.parseConfiguration(configFile);
		DefaultShellCallback callback = new DefaultShellCallback(overwrite);
		MyBatisGenerator myBatisGenerator = new MyBatisGenerator(config, callback, warnings);
		myBatisGenerator.generate(null);

	}

	public static void main(String[] args) throws Exception {
		try {
			MyBatisGeneratorApp generatorSqlmap = new MyBatisGeneratorApp();
			generatorSqlmap.generator();
		} catch (Exception e) {
			e.printStackTrace();
		}

	}
}

完整代码可在github下载

链接: https://github.com/316493171/generator.git

逆向生成出的模板样式

在这里插入图片描述
在这里插入图片描述
在这里插入图片描述

Hubery#
关注
  • 4
    点赞
  • 踩
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
Maven项目中使用mybatis-generator生成代码，加注释
qq_33157666的博客
12-18 3893
目的：Maven项目中使用mybatis-generator生成代码，加注释 一、在pom.xml中加入相关依赖 &lt;project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://mave...
mybatis-逆向工程配置，以及自定义注释类
兴趣是最好的老师
07-23 271
1.pom.xml引入jar <!-- https://mvnrepository.com/artifact/org.mybatis.generator/mybatis-generator-core --> <dependency> <groupId>org.mybatis.generator</groupId> <artifactId>mybatis-generator-core</artifactId>
自定义注解（annotation）
chicu2721的博客
08-04 111
要深入学习注解，我们就必须能定义自己的注解，并使用注解，在定义自己的注解之前，我们就必须要了解Java为我们提供的元注解和相关定义注解的语法。 元注解： 　　元注解的作用就是负责注解其他注解。Java5.0定义了4个标准的meta-annotation类型，它们被用来提供对其它 annot...
maven:通过自定义maven插件运行启动自定义应用服务
10km的专栏
01-17 2762
我们知道tomcat可以通过maven启动，执行类似如下的命令,就可以启动一个tomcat服务了。 mvn tomcat7:run 参见 《maven 配置tomcat插件启动》 如果我们也想像tomcat一样,用maven直接启动自己的应用服务，应该怎么做呢？这就是我这两天在折腾的问题。实现这个想法，需要具体几个条件。 自定义maven插件 tomcat实现在maven启
mybatis generator 逆向工程 自定义设置Table注解 以及 自定义注释 和自定义mapper接口
云海
09-21 7077
mybatis-generator是一个很好的数据库逆向生成Java实体的插件，但不能添加中文注释和注解，如果我们想生成下面这样一个实体类，那么就只能自己动手扩展一下mybatis-generator   generatorConfig.xml 配置如下： &lt;?xml version="1.0" encoding="UTF-8"?&gt; &lt;!DOCTYPE generator...
mybatis逆向工程 自定义添加注解以及注释、mapper
09-23
综上所述，MyBatis逆向工程通过自定义注解、注释和Mapper，可以帮助开发者快速构建框架，提高开发效率。通过熟练掌握MBG的配置和自定义，可以更好地适应项目的特定需求，实现代码生成的灵活性。
IDEA mybatis-generator逆向工程生成代码
08-27
在本文中，我们将介绍如何使用IntelliJ IDEA结合MyBatis-Generator插件来执行逆向工程。通过该过程，我们可以节省大量的编码时间，避免重复劳动，使开发人员可以专注于业务逻辑的实现。 首先，MyBatis-Generator...
自定义逆向工程 可生成Table注解 自定义继承通用mapper
09-21
本主题聚焦于自定义逆向工程，特别是如何生成Table注解以及自定义继承通用Mapper。 1. **自定义逆向工程**: 逆向工程通常涉及到使用工具或框架来解析已有的源代码或数据库结构，然后生成新的源代码。MyBatis ...
基于 Maven 的 MyBatis 逆向工程
最新发布
muweichang的博客
10-25 669
什么是逆向工程？ 编码代码时候，pojo、mapper接口以及mapper文件，实现起来没有什么难度，但是需要很大工作量（大多都是一些重复性代码），我们借助逆向工程自动生成pojo、mapper接口以及mapper文件。 什么是MyBatis？ MyBatis 是一款优秀的持久层框架，它支持自定义 SQL、存储过程以及高级映射。MyBatis 免除了几乎所有的 JDBC 代码以及设置参数和获取结果集的工作。MyBatis 可以通过简单的 XML 或注解来配置和映射原始类型、接口和 Java POJO（P
Generator逆向生成工具，maven项目
07-09
是一个maven项目，直接用开发工具导入，jdk1.8的 ，更改资源文件generatorconfig.xml里的参数就可以生成文件，附带说明也在generator目录下
自定义Maven插件
bobozai86的博客
05-17 1038
第一、自定义Maven插件概述 Mojo：Maven plain Old Java Object。每一个Mojo就是Maven中的一个执行目标（executable goal），而插件则是对单个或者多个相关Mojo做统一分发。 一个Mojo包含了一个简单的Java类。插件中多个类似Mojo的通用之处可以使用抽象父类来封装。Maven插件项目的打包方式packagin必须为maven-plugin。 第二、自定义插件Maven插件的实现 1、创建一个maven项目mavenplugin 2、引入ma
Maven插件开发(三)——Java中Processor使用与maven-compiler-plugin的结合使用
Anumbrella
03-22 5223
在前面几篇博客中我们讲解了简单的自定义插件开发工作，今天我们讲解一下扩展maven-compiler-plugin的processor功能。 一、maven-compiler-plugin 我们知道Maven只是个项目管理工具，如果要编译Java代码是不行的，而maven-compiler-plugin这个是Apache官方提供的Maven编译Java源码的功能插件，我们在项目中经常使用到，也就是...
MyBatis Generator系列(二)----自定义CommentGenerator实现中文注释
fendo
10-05 2万+
一、简介 由于MyBatis Generator自带了生成注释的功能,但是,是英文的而且生成的根本无法理解,所以可以通过,修改他的源码来实现生成中文的注释,具体方式有以下几种: 1) 自定义CommentGenerator 2) 修改源码 3) PluginAdapter插件的形式 二、自定义CommentGenerator实现中文注释 2.1、先创建M
Mybatis逆向工程配置xml模板（带注释）
weixin_30593261的博客
09-14 317
<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE generatorConfiguration PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN" "http://mybatis.org/dtd/...
配置Maven的generator插件
阁揆的博客
03-29 1066
配置Maven的generator插件 添加generator插件坐标 在POM文件中添加插件坐标 <!-- 插件 --> <build> <plugins> <plugin> <groupId>org.springframework.boot</groupId> <artifactId&g...
自定义基于maven插件的代码生成器
nb7474的博客
01-09 4404
目录前言具体实现1. pom.xml2. MoJo的代码3. controller模板遇到的问题1. install出错2. 执行插件目标generator命令报错3. 生成的dao层文件执行insert语句报错使用插件1. pom.xml文件2. generator.properties3. 执行命令 前言 最近研究了一下maven的自定义插件，之前用过maven中的mybatis-gener...
扫描自定义注解并在spring容器中注入自定义bean
weixin_33748818的博客
03-28 5377
为什么80%的码农都做不了架构师？>>> ...
Spring项目中自定义注解的使用
热门推荐
Ekmr的博客
05-24 5万+
本篇博客将从一个普通的spring项目入手，教你如何在项目中应用自定义注解
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值