MyBatis Generator系列(八)----MyBatis Generator自定义插件实现自定义Mapper

最新推荐文章于 2024-06-02 12:37:06 发布
最新推荐文章于 2024-06-02 12:37:06 发布
阅读量1.4w 收藏 12
点赞数 5
分类专栏： MyBatis Generator
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/u011781521/article/details/78697775
版权

一、创建基类


有时候会通过创建实体的基类，用来复用一些代码，然后让其他的实体类集成这个类:

package com.fendo.bean;
/**   
 * @Title: BaseModel.java 
 * @Package com.fendo.bean 
 * @Description: 实体基类
 * @author fendo
 * @date 2017年12月2日 下午5:32:40 
 * @version V1.0   
*/
public class BaseModel {
	

	private String createDate;
	private String createName;
	private String updateDate;
	private String updateName;
	
	public String getCreateDate() {
		return createDate;
	}
	public void setCreateDate(String createDate) {
		this.createDate = createDate;
	}
	public String getCreateName() {
		return createName;
	}
	public void setCreateName(String createName) {
		this.createName = createName;
	}
	public String getUpdateDate() {
		return updateDate;
	}
	public void setUpdateDate(String updateDate) {
		this.updateDate = updateDate;
	}
	public String getUpdateName() {
		return updateName;
	}
	public void setUpdateName(String updateName) {
		this.updateName = updateName;
	}
	
}

然后创建一个Mapper基类

/**   
 * @Title: BaseMapper.java 
 * @Package com.fendo.mapper 
 * @Description: Mapper基类
 * @author fendo
 * @date 2017年12月2日 下午5:33:05 
 * @version V1.0   
*/
public interface  BaseMapper<T extends BaseModel> {

    List<T> selectAll();

    int deleteByPrimaryKey(String id);

    int insert(T record);

    int insertSelective(T record);

    T selectByPrimaryKey(String id);

    int updateByPrimaryKey(T record);
    
    int updateByPrimaryKeySelective(T record);

}

二、配置generatorConfig.xml


引入插件:

<!-- 自动生成tostring方法 -->
<plugin type="org.mybatis.generator.plugins.ToStringPlugin"/>
<!-- 自动生成equals方法和hashcode方法 -->
<plugin type="org.mybatis.generator.plugins.EqualsHashCodePlugin"/>
<plugin type="org.mybatis.generator.plugins.SerializablePlugin"/>

<!-- 自定义方法 -->
<plugin type="org.mybatis.generator.plugins.MapperPlugin">
	<property name="targetProject" value="../mybatis-generator-oracle/src/main/java"/>
	<property name="targetPackage" value="com.fendo.mapper"/>
</plugin>  
<commentGenerator>
	<!-- 设置编码为UTF-8 -->
	<property name="javaFileEncoding" value="UTF-8"/>
	<!--配置生成注释，默认注释已经修改 -->
	<property name="suppressAllComments" value="false"/>
</commentGenerator>

然后给mapper和bean添加基类 

<!-- 生成模型的包名和位置-->  
<javaModelGenerator targetPackage="com.fendo.bean" targetProject="src/main/java">  
	<property name="enableSubPackages" value="true"/>  
	<property name="trimStrings" value="true"/>
	<property name="rootClass" value="com.fendo.bean.BaseModel"/>
</javaModelGenerator>  

<!-- 生成DAO的包名和位置-->  
<javaClientGenerator type="XMLMAPPER" targetPackage="com.fendo.mapper" targetProject="src/main/java">  
	<property name="enableSubPackages" value="true"/>
	<property name="rootInterface" value="com.fendo.mapper.BaseMapper"/>
</javaClientGenerator>


三、创建MapperPlugin


创建自己的类然后实现PluginAdapter

package org.mybatis.generator.plugins;

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


import static org.mybatis.generator.internal.util.StringUtility.stringHasValue;
import static org.mybatis.generator.internal.util.messages.Messages.getString;

import org.mybatis.generator.api.GeneratedJavaFile;
import org.mybatis.generator.api.IntrospectedTable;
import org.mybatis.generator.api.JavaFormatter;
import org.mybatis.generator.api.PluginAdapter;
import org.mybatis.generator.api.ShellCallback;
import org.mybatis.generator.api.dom.java.CompilationUnit;
import org.mybatis.generator.api.dom.java.FullyQualifiedJavaType;
import org.mybatis.generator.api.dom.java.Interface;
import org.mybatis.generator.api.dom.java.JavaVisibility;
import org.mybatis.generator.api.dom.xml.Attribute;
import org.mybatis.generator.api.dom.xml.Document;
import org.mybatis.generator.api.dom.xml.TextElement;
import org.mybatis.generator.api.dom.xml.XmlElement;
import org.mybatis.generator.exception.ShellException;
import org.mybatis.generator.internal.DefaultShellCallback;

/**   
 * @Title: MapperPlugin.java 
 * @Package org.mybatis.generator.plugins 
 * @Description: TODO
 * @author fendo
 * @date 2017年12月2日 下午5:35:14 
 * @version V1.0   
*/
public class MapperPlugin extends PluginAdapter{

    private static final String DEFAULT_DAO_SUPER_CLASS = "com.fendo.mapper.BaseMapper";
    private static final String DEFAULT_EXPAND_DAO_SUPER_CLASS = "com.fendo.mapper.BaseExpandMapper";
    private String daoTargetDir;
    private String daoTargetPackage;

    private String daoSuperClass;

    // 扩展
    private String expandDaoTargetPackage;
    private String expandDaoSuperClass;

    private ShellCallback shellCallback = null;

    public MapperPlugin() {
        shellCallback = new DefaultShellCallback(false);
    }

    /**
     * 验证参数是否有效
     * @param warnings
     * @return
     */
    public boolean validate(List<String> warnings) {
        daoTargetDir = properties.getProperty("targetProject");
        boolean valid = stringHasValue(daoTargetDir);

        daoTargetPackage = properties.getProperty("targetPackage");
        boolean valid2 = stringHasValue(daoTargetPackage);

        daoSuperClass = properties.getProperty("daoSuperClass");
        if (!stringHasValue(daoSuperClass)) {
            daoSuperClass = DEFAULT_DAO_SUPER_CLASS;
        }

        expandDaoTargetPackage = properties.getProperty("expandTargetPackage");
        expandDaoSuperClass = properties.getProperty("expandDaoSuperClass");
        if (!stringHasValue(expandDaoSuperClass)) {
            expandDaoSuperClass = DEFAULT_EXPAND_DAO_SUPER_CLASS;
        }
        return valid && valid2;
    }

    
    /** 
     * 生成mapping 添加自定义sql 
     */ 
    @Override
    public boolean sqlMapDocumentGenerated(Document document, IntrospectedTable introspectedTable) {
    	
    	//创建Select查询
        XmlElement select = new XmlElement("select");
        select.addAttribute(new Attribute("id", "selectAll"));
        select.addAttribute(new Attribute("resultMap", "BaseResultMap"));
        select.addAttribute(new Attribute("parameterType", introspectedTable.getBaseRecordType()));
        select.addElement(new TextElement("select * from "+ introspectedTable.getFullyQualifiedTableNameAtRuntime()));

        XmlElement queryPage = new XmlElement("select");
        queryPage.addAttribute(new Attribute("id", "queryPage"));
        queryPage.addAttribute(new Attribute("resultMap", "BaseResultMap"));
        queryPage.addAttribute(new Attribute("parameterType", "com.fendo.bean.Page"));
        queryPage.addElement(new TextElement("select * from "+ introspectedTable.getFullyQualifiedTableNameAtRuntime()));
        
        XmlElement parentElement = document.getRootElement();
        parentElement.addElement(select);
        parentElement.addElement(queryPage);
        return super.sqlMapDocumentGenerated(document, introspectedTable);
    }

    public List<GeneratedJavaFile> contextGenerateAdditionalJavaFiles(IntrospectedTable introspectedTable) {
        JavaFormatter javaFormatter = context.getJavaFormatter();
        List<GeneratedJavaFile> mapperJavaFiles = new ArrayList<GeneratedJavaFile>();
        for (GeneratedJavaFile javaFile : introspectedTable.getGeneratedJavaFiles()) {
            CompilationUnit unit = javaFile.getCompilationUnit();
            FullyQualifiedJavaType baseModelJavaType = unit.getType();

            String shortName = baseModelJavaType.getShortName();

            GeneratedJavaFile mapperJavafile = null;

            if (shortName.endsWith("Mapper")) { // 扩展Mapper
                if (stringHasValue(expandDaoTargetPackage)) {
                    Interface mapperInterface = new Interface(
                            expandDaoTargetPackage + "." + shortName.replace("Mapper", "ExpandMapper"));
                    mapperInterface.setVisibility(JavaVisibility.PUBLIC);
                    mapperInterface.addJavaDocLine("/**");
                    mapperInterface.addJavaDocLine(" * " + shortName + "扩展");
                    mapperInterface.addJavaDocLine(" */");

                    FullyQualifiedJavaType daoSuperType = new FullyQualifiedJavaType(expandDaoSuperClass);
                    mapperInterface.addImportedType(daoSuperType);
                    mapperInterface.addSuperInterface(daoSuperType);

                    mapperJavafile = new GeneratedJavaFile(mapperInterface, daoTargetDir, javaFormatter);
                    try {
                        File mapperDir = shellCallback.getDirectory(daoTargetDir, daoTargetPackage);
                        File mapperFile = new File(mapperDir, mapperJavafile.getFileName());
                        // 文件不存在
                        if (!mapperFile.exists()) {
                            mapperJavaFiles.add(mapperJavafile);
                        }
                    } catch (ShellException e) {
                        e.printStackTrace();
                    }
                }
            } else if (!shortName.endsWith("Example")) { // CRUD Mapper
                Interface mapperInterface = new Interface(daoTargetPackage + "." + shortName + "Mapper");

                mapperInterface.setVisibility(JavaVisibility.PUBLIC);
                mapperInterface.addJavaDocLine("/**");
                mapperInterface.addJavaDocLine(" * MyBatis Generator工具自动生成");
                mapperInterface.addJavaDocLine(" */");

                FullyQualifiedJavaType daoSuperType = new FullyQualifiedJavaType(daoSuperClass);
                // 添加泛型支持
                daoSuperType.addTypeArgument(baseModelJavaType);
                mapperInterface.addImportedType(baseModelJavaType);
                mapperInterface.addImportedType(daoSuperType);
                mapperInterface.addSuperInterface(daoSuperType);

                mapperJavafile = new GeneratedJavaFile(mapperInterface, daoTargetDir, javaFormatter);
                mapperJavaFiles.add(mapperJavafile);

            }
        }
        return mapperJavaFiles;
    }
	
}


四、生成代码


创建测试类:

import java.io.IOException;
import java.io.InputStream;
import java.net.URISyntaxException;
import java.sql.SQLException;
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.exception.InvalidConfigurationException;
import org.mybatis.generator.exception.XMLParserException;
import org.mybatis.generator.internal.DefaultShellCallback;

/**   
 * @Title: StartUp.java 
 * @Package com.fendo.mybatis_generator_plus 
 * @Description: mybatis-generator测试类
 * @author fendo
 * @date 2017年10月5日 下午3:53:17 
 * @version V1.0   
*/
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("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();
        }
    }
}


然后执行MBG，生成的代码结构如下:





生成的Healthyorder实体类默认继承了BaseModel




然后就是HealthyorderMapper映射文件,它默认是继承BaseMapper<Healthyorder>类，然后就可以使用BaseMapper里面的方法，生成的xml文件如下:




注意:


由于我这里直接是在源码里面改的，然后测试的，并没有打包成jar，运行的。


完整的源码:

http://download.csdn.net/download/u011781521/10142189

码农致富
关注
  • 5
    点赞
  • 踩
  • 12
    收藏
    觉得还不错? 一键收藏
  • 3
    评论
专栏目录
自定义mybatis-generator生成mapper代码
JC.Lin的博客
09-08 916
自定义mybatis-generator生成mapper代码 我是基于tk.mybatis.mapper.generator.MapperPlugin插件进行一个微小的拓展，大多数还是基于MapperPlugin逻辑进行处理，这里非常感谢tk.mybatis作者为我们提供源码基础。 tk.mybatis.mapper-generator源码地址https://repo1.maven.org/maven2/tk/mybatis/mapper-generator/1.1.5/ 通过继承PluginAdapter
Mybatis generator插件生成中文注释
qq_41988229的博客
09-18 397
到新的公司发现每个人用各自的代码生成插件，十分不方便，没有一套公司规范化的流程。使用generator插件遇到了不少问题，网上查找发现并不完善。在此附上自己用的一套以及遇到的 一些问题。基于oracle数据库 1，相关jar包 <!-- mybatis生成 jar包 --> <dependency> <groupId>org.mybatis.generator</groupId> <artifactId>mybatis-g.
mybatis generator自定义sql以及方法生成（二）
进步新青年的博客
03-11 2014
前言 接着上篇文章，一步步自定义需要生成的自定义方法以及在mapper.xml中生成自己想要的sql文件，有些代码都标注了自己在改造过程中的理解到的意思 开始改造 更改mapper方法命名风格 mybatis-generator生成的默认方法不是我想要的，我想要的风格如下： selectByPrimaryKey --> selectOne updateByPrimaryKeySelective --> update deleteByPrimaryKey -->delete.
MyBatis源码解析系列之十二：自定义插件开发
最新发布
阿里渣渣java研发组-群主
06-02 396
欢迎回到我的MyBatis源码解析系列。在前几篇文章中，我们详细介绍了MyBatis的架构及其核心组件的实现原理，并深入探讨了MyBatis与Spring的集成。本篇文章将探讨如何开发自定义插件，以扩展MyBatis的功能，满足特定的业务需求。MyBatis插件机制基于Java的动态代理，允许开发者通过实现接口来拦截执行的核心方法，从而实现诸如性能监控、日志记录、SQL重写等功能。Executor：执行器，负责SQL语句的执行。：语句处理器，负责SQL语句的生成和参数设置。
自定义mybatis-generator生成工具
weixin_41111360的博客
04-11 2084
首先，mybatis提供的这套底层代码生成工具是非常人性化的，用户直接依赖jar包就可以一键生成，并且提供一套配置文件，让用户进行灵活的配置以满足不同的用户需求。然而，只通过简单的修改配置文件还远远无法满足我们的需求，那怎么办呢？幸运的是，mybatis-generator可以让用户实现其相应的接口来自定义自己的代码风格，如代码注释（CommentGenerator），java类型（JavaTyp...
使用Maven插件(plugin)MyBatis Generator逆向工程
weixin_30832351的博客
05-10 111
内容来自官网：http://www.mybatis.org/generator/index.html generatorConfig.xml 模板(参考：http://www.mybatis.org/generator/configreference/xmlconfig.html) <?xml version="1.0" encoding="UTF-8"?> <!DOC...
增加Mybatis-generator生成的Mapper类和Mapper.xml里的方法
热门推荐
毛竹
07-28 5万+
首先附上我扩展后项目的github地址：点击打开链接 为了项目的需要，需要在生成的Mapper里添加enableSelectNotDeleteAll、enableSelectNotDeleteByPrimaryKey方法。下面介绍实现的过程。 第一步：在generatorConfig.xml对应的dtd文件里添加table的属性，如下： <!ATTLIST table catalog
mybatis-generator-gui
08-02
总的来说，mybatis-generator-gui是一个便捷的开发工具，通过图形界面简化了MyBatis的Mapper文件生成过程，提高了开发效率，同时提供了数据库类的自动生成功能，使开发者能更专注于业务逻辑的实现。对于使用MyBatis...
mybatis-generator-core-1.3.2
05-24
2. 自定义插件：可以通过实现自定义插件接口，扩展Mybatis Generator的功能，如添加代码注释、处理特殊字段等。 3. 代码更新：如果数据库表结构发生变化，只需重新运行生成器，即可自动更新相关的Java代码，保持与...
自定义mybatis-generator生成jar包
09-04
在Java开发中，MyBatis Generator（MBG）是一个强大的工具，它能够自动化地生成MyBatis相关的代码，包括Mapper接口、Mapper XML文件、DAO实现类、Service接口及实现、Controller以及实体类等。自定义MBG可以帮助我们...
mybatis-generator-gui-plus
04-13
MyBatis Generator（MBG）是一个强大的工具，它可以自动生成MyBatis的Mapper XML文件、Mapper接口、实体类以及DAO实现类。而`mybatis-generator-gui-plus`在此基础上增加了图形化的操作界面，使得配置和生成代码的...
整合maven+mybatis+generator生成java自定义model实体类,dao接口和mapper映射文件
06-12
通过继承PluginAdapter类,开发自定义插件,生成自定义的中文注解的java实体类,dao接口和mapper映射文件
mybatis-generator-1.35-master.zip
05-14
在项目初期或数据库结构频繁变动时，使用MyBatis Generator可以快速生成基础代码，使得开发者能更专注于业务逻辑的实现。 标题"mybatis-generator-1.35-master.zip"表明这是一个包含MyBatis Generator 1.35版本源码...
MyBatis Generator系列(四)----MyBatis Generator Plugin插件详解
fendo
12-02 2万+
一、MyBatis Generator插件简介 (A)MyBatis Generator插件有什么用 1.可以使用自己的注解来辅助生成代码； 2.可以在类上面添加一些方法来辅助生成代码； 3.可以添加一些XML中的元素的属性配置； 4.可以添加一些额外的XML文件或者Java文件（比如一个例子就是生成MyBatisConfig.xml文件）； (B)Plug
mybatis generator插件编写
斯旺森swanson
09-10 417
文章目录 MyBatis Generator Plugin Plugin用来在生成Java及XML的过程中修改或者添加内容。 其必须实现com.mybatis.generator.api.Plugin接口。大多数插件应扩展适配器类org.mybatis.generator.api.PluginAdapter 。适配器类提供基本的插件支持，并为大多数的接口方法（类似于Swing适配器类）提供了空操作的方法。 插件的生命周期 插件通过默认的构造函数创建 setContext方法被调用 setProperties
Mybatis定义基类的实现方式
qq_37134175的博客
08-10 1340
项目中少不了CRUD的操作，在Mybatis中的Mapper文件中也随处可见增、删、改、查。但是，有的CRUD操作却是类似的，可以通过Mybatis提供的注解加上反射实现传入实体类就是简单的CRUD操作，这样的实现是基于对单表的操作，需要进行关联查询等操作时，还是老老实实的写在mapper文件中。 一、Mybatis中的注解 定义Mybatis基类我们需要用到org.apache.ibatis...
自定义mybatis-generator自动生成代码时的类型转换
Roy_70的专栏
09-07 1万+
一、mybatis-generator问题 大家在使用mybatis的时候，有些时候需要使用mybatis generator来逆向生成mapper和entity层。 这其中一个问题在于，表设计的时候，出于最大程度节省表空间的考虑，不少枚举使用了tinyint类型，但是在进行自动生成的时候，默认生成的java字段是Byte类型，但是我想要的是Integer类型，这就对程序中使用产生了不便。 ...
java代码mybatis代码生成器插件
qq_34227896的博客
10-24 1万+
引言 mybatis-generator-maven-plugin、MyBatisPlus 对比。 1、mybatis-generator-maven-plugin插件深度更深，对mybatis提供的操作更仔细，不仅有简单的增删改查，还可以动态的使用where语句来操作。 2、MyBatisPlus插件主要提供了一些模板来操作，主要的模板有：velocity 模板引擎, 默认、freemar...
mabatis generator的用法
chijiansong的博客
03-17 100
1.添加配置文件 <?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"> <generatorCon
mybatis-generator-maven-plugin 1.3.2
04-29
mybatis-generator-maven-plugin 1.3.2 是一个Maven插件，用于生成Mybatis框架的Mapper接口和XML映射文件以及Java模型类。该插件的主要作用是自动生成相关的Java代码和XML文件，从而简化开发人员的工作量和时间成本。 作为一个Maven插件，mybatis-generator-maven-plugin 1.3.2 只需在项目的 pom.xml 中添加相应的依赖即可。该插件支持多种数据库类型，包括MySQL、Oracle、MSSQL、PostgreSQL 等。通过配置插件的属性，开发人员可以自定义生成文件的包名、路径、文件名等信息。 使用mybatis-generator-maven-plugin 1.3.2 生成Java代码时，可以使用FreeMarker模板引擎来自定义SQL语句和Java类的结构。此外，该插件还支持生成可读性更好的注释，使代码更易于维护。同时，mybatis-generator-maven-plugin 1.3.2 还支持使用Java 8的Lambda表达式，从而可以更加方便地编写SQL和Mybatis的映射代码。 总之，mybatis-generator-maven-plugin 1.3.2 是一个简单易用的插件，能够大大提高Mybatis框架开发的效率和质量，值得开发人员广泛应用。

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

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

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值