mybatis自动生成代码(generator插件)

已于 2022-02-24 11:22:56 修改
阅读量395 收藏
点赞数
文章标签： java 开发语言 后端
于 2021-11-05 13:52:04 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/yx15156537218/article/details/121161366
版权

mybatis代码生成插件generator

generator依赖

测试类生成器

配置文件

1、依赖

        <dependency>
            <groupId>org.mybatis.spring.boot</groupId>
            <artifactId>mybatis-spring-boot-starter</artifactId>
            <version>1.3.0</version>
        </dependency>
        <dependency>
            <groupId>org.mybatis.generator</groupId>
            <artifactId>mybatis-generator-core</artifactId>
            <scope>test</scope>
            <version>1.3.2</version>
            <optional>true</optional>
        </dependency>

        <dependency>
            <groupId>org.apache.commons</groupId>
            <artifactId>commons-lang3</artifactId>
            <version>3.4</version>
        </dependency>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>commons-io</groupId>
            <artifactId>commons-io</artifactId>
            <version>2.4</version>
            <scope>test</scope>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.mybatis.generator</groupId>
            <artifactId>mybatis-generator-core</artifactId>
            <version>1.3.6</version>
            <scope>compile</scope>
        </dependency>

2、测试类生成器(这里可以根据自己的需求修改参考mybatis官网)

package org.mybatis.generator.plugins;

import org.apache.commons.io.IOUtils;
import org.junit.Test;
import org.mybatis.generator.api.MyBatisGenerator;
import org.mybatis.generator.api.ProgressCallback;
import org.mybatis.generator.config.Configuration;
import org.mybatis.generator.config.Context;
import org.mybatis.generator.config.xml.ConfigurationParser;
import org.mybatis.generator.internal.DefaultShellCallback;

import java.io.*;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import java.util.regex.Matcher;
import java.util.regex.Pattern;

/**
 * mybatis代码生成插件调用者.
 */
public class Generator {

    @Test
    public void generate() throws Exception {
        List<String> warnings = new ArrayList<String>();
        boolean overwrite = true;

        InputStream stream = Generator.class.getClassLoader().getResourceAsStream("generatorConfig.xml");

        ConfigurationParser cp = new ConfigurationParser(warnings);
        InputStreamReader reader = new InputStreamReader(stream, "utf-8");
        BufferedReader bufferedReader = new BufferedReader(reader);

        String line = bufferedReader.readLine();
        StringBuffer buffer = new StringBuffer();
        while (line != null) {
            buffer.append(line + "\n");
            line = bufferedReader.readLine();
        }
        String xmlWithParam = buffer.toString();
        
        System.out.println("------- xml config begin -------");
        System.out.println(xmlWithParam);
        System.out.println("------- xml config end -------");

        final Configuration config = cp.parseConfiguration(new ByteArrayInputStream(xmlWithParam.getBytes("utf-8")));
        DefaultShellCallback callback = new DefaultShellCallback(overwrite);
        MyBatisGenerator myBatisGenerator = new MyBatisGenerator(config, callback, warnings);
        System.out.println("------- generator begin -------");
        ProgressCallback cb = new ProgressCallback() {
            private Pattern SqlProviderPattern = Pattern.compile("\\w*SqlProvider\\.java");
            private List<String> taskNames = new ArrayList();

            @Override
            public void startTask(String taskName) {
                /*
                 * 输出这些信息从而知道 生成那些类了 
                * Generating Example class for table demo
                * Generating Primary Key class for table demo 
                * Generating Record class for table demo 
                * Generating Mapper Interface for table demo 
                * Generating SQL Provider for table demo 
                * Saving file DemoExample.java
                * Saving file DemoKey.java Saving file Demo.java
                * Saving file DemoMapper.java
                * Saving file DemoSqlProvider.java
                 */
                // System.out.println(taskName);
                taskNames.add( taskName);
            }

            @Override
            public void saveStarted(int arg0) {}

            @Override
            public void introspectionStarted(int arg0) {}

            @Override
            public void generationStarted(int arg0) {}

            @Override
            public void done() {
                for(String taskName : taskNames){
                Matcher matcher = SqlProviderPattern.matcher(taskName);
                    if (matcher.find()) {
                        final String SqlProviderFilename = matcher.group();
                        System.out.println("处理生成文件,selectByExample  增加mysql分页: " + SqlProviderFilename);
                        List<Context> contexts = config.getContexts();
                        FilenameFilter filter = new FilenameFilter() {
                            @Override
                            public boolean accept(File dir, String name) {
                                return SqlProviderFilename.equalsIgnoreCase(name);
                            }
                        };
                        boolean done = false;
                        for (Context ctx : contexts) {
                            if(done){
                                break;
                            }
                            String targetProject = ctx.getJavaClientGeneratorConfiguration().getTargetProject();
                            String targetPackage = ctx.getJavaClientGeneratorConfiguration().getTargetPackage();
                            String dir = targetProject.replaceAll("\\.", "\\\\") + "\\" + targetPackage.replaceAll("\\.", "\\\\");
                            System.out.println(System.getProperty("user.dir") + dir);
                            File mapperDir = new File(System.getProperty("user.dir"), dir);
                            File[] files = mapperDir.listFiles(filter);
                            if (files != null && files.length > 0) {
                                File sqlProviderFile = files[0];
                                try {
                                    Generator.addMysqlLimit(sqlProviderFile);
                                    done = true;
                                } catch (Exception e) {
                                    e.printStackTrace();
                                }
                            }
                        }
                        if(!done){
                             System.out.println("转换失败!!!! selectByExample  增加mysql分页: " + SqlProviderFilename);
                        } else {
                            System.out.println("转换成功!!!! selectByExample  增加mysql分页: " + SqlProviderFilename);
                        }
                    }
                }
            }

            @Override
            public void checkCancel() throws InterruptedException {}
        };
        myBatisGenerator.generate(cb);
        for (String warning : warnings) {
            System.out.println(warning);
        }
        System.out.println("------- generator end -------");
        // System.out.println(config.getClassPathEntries());
    }

    private static void addMysqlLimit(File sqlProviderFile) throws Exception {
        /*
         * 这是自动生成的selectByExample 中的代码片段
        if (example != null && example.getOrderByClause() != null) {
            ORDER_BY(example.getOrderByClause()); // 整个文件唯一
        }
        
        return SQL();
        
         * 将return SQL()改为下面片段即可:

        String sqlString = SQL();
        if (example != null && example.getLimit() != null) {
            sqlString += " limit " + example.getLimit();
        }
        if (example != null && example.getOffset() != null) {
            sqlString += " offset " + example.getOffset();
        }
        return sqlString;
         */
        BufferedReader reader = new BufferedReader( new FileReader(sqlProviderFile));
        List<String> lines = IOUtils.readLines(reader);
        reader.close();
        String limitString = "        String sqlString = SQL();\n" +
                "        if (example != null && example.getLimit() != null) {\n" +
                "            sqlString += \" limit \" + example.getLimit();\n" +
                "        }\n" +
                "        if (example != null && example.getOffset() != null) {\n" +
                "            sqlString += \" offset \" + example.getOffset();\n" +
                "        }\n" +
                "        return sqlString;";
        ArrayList<String> newLines = new ArrayList<String>();

        
        for (int i=0; i< lines.size();++i) {
            String line = lines.get(i);
            newLines.add(line );
            if(line.replaceAll(" ", "") .equalsIgnoreCase("ORDER_BY(example.getOrderByClause());")) {
                // 添加下一行大括号和空白行
                ++i;
                newLines.add(lines.get(i));
                ++i;
                newLines.add(lines.get(i));
                
                ++i; // 跳过 return SQL();
                newLines.addAll(Arrays.asList( limitString.split("\n")));
            }
        }
        
//        for (String line : newLines) {
//            System.out.println(line);
//        }
        FileOutputStream writer = new FileOutputStream(sqlProviderFile);
        IOUtils.writeLines(newLines, "\n",writer,"UTF-8");
        writer.close();
    }
    
    public static void main(String[] args) throws Exception {
       new Generator().generate();
    }
}

3、配置文件
下面展示一些 内联代码片。

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

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

		<plugin type="org.mybatis.generator.plugins.AddLimitOffsetPlugin" />
		<plugin type="org.mybatis.generator.plugins.ToStringPlugin" />

		<commentGenerator>
			<property name="suppressDate" value="true" />
			<!-- remove comments -->
			<property name="suppressAllComments" value="true" />
		</commentGenerator>

		<jdbcConnection driverClass="com.mysql.cj.jdbc.Driver"
						connectionURL="jdbc:mysql://localhost:3306/xdkt?useUnicode=true&amp;characterEncoding=utf-8&amp;useSSL=false&amp;serverTimezone = GMT"
						userId="root" password="root" />

		<!-- java type resolver -->
		<javaTypeResolver>
			<property name="forceBigDecimals" value="false" />
		</javaTypeResolver>

		<!-- gem entity -->
		<!-- data -->
		<javaModelGenerator targetPackage="com.ydclass.couponapp.model"
							targetProject="./src/main/java">
			<property name="enableSubPackages" value="true" />
			<property name="trimStrings" value="false" />
		</javaModelGenerator>

		<!--  -->
		<!-- gem annotated mapper -->
		<!-- data -->
		<javaClientGenerator type="ANNOTATEDMAPPER"
							 targetPackage="com.ydclass.couponapp.mapper"
							 targetProject="./src/main/java">
			<property name="enableSubPackages" value="true" />
		</javaClientGenerator>
		<table tableName="t_coupon">
			<generatedKey column="id" sqlStatement="JDBC"/>
		</table>
		<table tableName="t_user_coupon">
			<generatedKey column="id" sqlStatement="JDBC"/>
		</table>
	</context>
</generatorConfiguration>

*总结使用方法
导入依赖将xml配置文件中的文件路径和数据库连接属性改成自己的，并配置需要生成的表的名称。然后使用generator去生成代码到对应的工程文件夹下。这样就可以生成操作你所配置表的实体和并能使用它去操作数据库。

Heart鑫^
关注
5.6 Mybatis代码生成器Mybatis Generator (MBG)实战详解
天罡gg的专栏
05-14 2万+
本文我们主要实战Mybatis官方的代码生成器：Mybatis Generator(MBG)，掌握它以后，可以简化大部分手写代码，我们只需要写复杂逻辑代码！创建与MySQL表对应的Java PO对象，字段一一对应；创建Mapper接口，和对应的XML映射文件(或注解)。首先是PO对象，我们往往创建与数据库表字段一一对应的PO对象;其次在Mapper里，通常都会写基本的增删改查代码。本文就带大家实战一下Mybatis Generator，用它生成实战项目全部表的PO对象和基本增删改查代码！
mybatis-generator-plugin：Mybatis Generator代码生成插件扩展，增加：查询单条数据插件（SelectOneByExamplePlugin），MySQL分页插件（LimitPlugin），数据模型链式插件（ModelBuilderPlugin），示例条件增强插件（ExampleEnhancedPlugin），示例目标包修改插件（ExampleTargetPlugin），批量插入插件（BatchInsertPlugin），逻辑删除插件（LogicalDeletePlugi
02-03
这是MyBatis Generator插件的拓展插件包 应该说使用Mybatis就一定离不开代码生成插件，而此插件本身还提供了插件扩展功能用于增强插件本身，官方已经提供了一些扩展，本项目的目的也是通过该插件机制来强化Mybatis Generator本质，方便和减少我们平时的代码开发量。 因为插件是本人兴之所至至所临时发布的项目（本人已近三年未做JAVA开发，代码水平请大家见谅），但基本插件都是在实际项目中经过检验的请大家放心使用，但因为项目总体主要数据库为MySQL，Mybatis实现使用Mapper.xml方式，因此代码生成时对于其他数据库和注解方式的支持未予考虑，请大家见谅。 V1.3
mybatis-generator自动生成代码插件
qq_42291464的博客
08-31 559
springboot项目集成mybatis-generator插件并运行起来步骤 1，新建项目，选择组件 spring-web，sql下的mybatis框架及mysql驱动 2，mybatis-generator安装与配置，生成数据库逆向文件 3，跑通接口 一、新建springboot项目 创建项目时勾选常用组件，spring-web，sql下的mybatis框架及mysql驱动，对应在pom.xml文件中自动加载依赖： <dependencies> <dependency
mybatis generator 自动生成代码插件
会写Bug的攻城狮
09-13 135
mybatis generator 自动生成代码插件 1.首先在File——Settings——点击Plugins，搜索框中搜索mybatis，选择mybatis-plugins，点击安装（由于我的已经安装过，所以没有绿色的Install按钮，而变成了instleaed,）安装完成后点击图片上那个位置的按钮Free mybatis plugin之后会让你重启IDEA ： 在pop.xml的中添加如下 <!-- mybatis generator 自动生成代码插件 --> <pl
mybatis-generator自动生成代码插件使用详解
大叶子不小的博客
11-23 328
mybatis-generator是一款在使用mybatis框架时，自动生成model，dao和mapper的工具，很大程度上减少了业务开发人员的手动编码时间，今天自己研究了一下，也分享一下使用心得供大家简单使用。 　　本人使用的是maven构建，首先需要在pom.xml文件添加mybatis-generator依赖包以及插件，配置如下： 　　dependencies中添加： <dependency> <groupId>org.mybatis.generator&lt
Mybatis-plus代码生成器（加快开发效率）
三横同学的博客
08-09 325
Mybatis-plus代码生成器（加快开发效率） 1.使用依赖 <dependencies> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> <!-- 数
mybatis自动生成代码 eclipse插件
10-30
总结，MyBatis Generator插件是Eclipse开发环境中一个高效实用的工具，它能够帮助开发者快速生成与数据库交互的代码，降低开发工作量，提高开发效率。通过合理配置和使用，可以使Java Web开发更加顺畅，减少因手动...
mybatis-generator自动生成代码 （全部文件）
06-07
MyBatis Generator（MBG）是一款强大的工具，用于自动生成MyBatis的DAO层代码，包括实体类（Bean）、Mapper接口以及对应的XML映射文件。它极大地简化了开发过程，避免了手动编写这些重复性高的代码，提高了开发效率...
Mybatis Plus代码生成器 IDEA 插件版 （版本v0.0.6）
06-28
1.Mybatis Plus代码生成器 1.1.自定义配置模板 1.2.自定义表-实体映射信息 1.3.多数据源管理 1.4.操作记忆功能 1.5.操作化繁为简 2.工程化（maven,spring boot） 2.1.生成maven工程 2.2.生成...
Mybatis 自动生成代码
08-07
MyBatis Generator（MBG）是一款强大的自动化代码生成工具，主要用于简化MyBatis框架的使用。它能够根据数据库中的表自动生成对应的Java实体类、Mapper接口及XML配置文件，极大地提高了开发效率。在理解MBG的工作...
MyBatis Generator（MBG）提供的插件
weixin_34414650的博客
09-14 163
提供的插件 随着MyBatis Generator（MBG）的使用日益增长，我们发现通过插件增加功能越来越有用，而不是增加基础代码生成器的复杂性。插件是一种模块化且易于理解的用于扩展MBG的机制。有关编写插件的更多信息，请参阅实现插件。有关配置插件的信息，请参阅<plugin>提供的插件都在包org.mybatis.generator.plu...
generator mysql插件_mybatis generator插件系列--分页插件
weixin_39568233的博客
02-23 126
1、首先定义分页插件MysqlPagePlugin.javapackage com.demo.mybatis.plugin;import org.mybatis.generator.api.CommentGenerator;import org.mybatis.generator.api.IntrospectedTable;import org.mybatis.generator.api.Plug...
MyBatis Generator 插件使用指南
最新发布
SmartSi
07-26 940
MyBatis-Generator (mybatis-generator-maven-plugin) 是 MyBatis 提供的快速生成代码的插件。可以帮我们快速生成表对应的持久化对象(POJO)、操作数据库的接口(dao) 以及映射文件 Mapper。基于 mybatis-generator-core-x.x.x.jar 和其 XML 配置文件，通过命令行运行。通过 Ant 的 Task 结合其 XML 配置文件运行。通过 Maven 插件运行。
MyBatis Generator系列(五)----MyBatis Generator Plugin插件之ToStringPlugin
fendo
12-02 3992
一、ToStringPlugin插件简介 org.mybatis.generator.plugins.ToStringPlugin ToStringPlugin插件主要用来为KeyClass，Record Class和BlobClass提供toString方法的 二、ToStringPlugin使用 默认情况下通过MyBatis Generator生成的
myBatisGeneratorPlugins
qq_43097257的博客
09-09 449
myBatisGeneratorPlugins 一些mybatis-generator扩展插件集合 已实现功能 自动添加swagger2注解到实体类 扩展set方法,返回this实例;方便链式调用 maven引用 <!-- https://mvnrepository.com/artifact/com.github.misterchangray.mybatis.generator.plugins/myBatisGeneratorPlugins --> <dependency>
MyBatis Generator插件之ToStringPlugin
zsg88的专栏
08-27 2158
org.mybatis.generator.plugins.ToStringPlugin 示例使用的DDL为： CREATE TABLE `userinfo` ( `id` bigint(20) NOT NULL AUTO_INCREMENT, `userName` varchar(255) DEFAULT NULL, `password` varchar(255) DEFAULT
MyBatis Generator的内置插件
zsg88的专栏
08-27 1406
org.mybatis.generator.plugins.CachePlugin 这个插件是一个挺有用的插件，用来生成在XML中的元素（这个插件只针对MyBatis3/MyBatis3Simple有效哈）； 很显然，这个插件需要一些配置，支持的配置属性有：cache_eviction，cache_flushInterval，cache_readOnly，cache_size，cache_ty
Mybatis-generator常用的几个内置插件
u011163372的博客
07-28 3782
Plugin能够用来在MyBatis Generator生成Java和XML文件过程中修改或者添加内容；Plugin必须实现org.mybatis.generator.api.Plugin接口，在这个接口中提供了非常多的方法，所以，很自然，MBG提供了一个适配器org.mybatis.generator.api.PluginAdapter，一般情况下只需要继承这个适配器即可； MBG已经提供了一些
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
IDEA中使用MyBatis Generator插件自动生成代码
"这篇文章主要介绍了如何在IntelliJ IDEA中使用MyBatis Generator插件来自动生成实体类和mapper.xml文件，适用于Java开发人员提升开发效率。" 在Java开发中，MyBatis是一个流行的持久层框架，它允许开发者将SQL与...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值