Mybatis Generator使用简介

最新推荐文章于 2022-10-09 15:01:29 发布
最新推荐文章于 2022-10-09 15:01:29 发布
阅读量312 收藏
点赞数 1
分类专栏： 服务器
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/ITzhongzi/article/details/103875607
版权

前言： 使用Mybatis Generator自动生成实体类和 mapper数据库操作类

目录结构

在这里插入图片描述

使用过程
  1. maven引入jar包
<dependency>
	<groupId>org.mybatis.generator</groupId>
	<artifactId>mybatis-generator-core</artifactId>
	<version>1.3.2</version>
	<optional>true</optional>
</dependency>
  1. 增加配置文件 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>

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

        <plugin type="com.itzhongzi.usernapp.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.jdbc.Driver"
                        connectionURL="jdbc:mysql://114.115.250.129:3306/coupun_shop?useUnicode=true&amp;characterEncoding=UTF-8&amp;useSSL=false"
                        userId="root" password="Huanghai@2019" />

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

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

        <!--  -->
        <!-- gem annotated mapper -->
        <!-- data -->
        <javaClientGenerator type="ANNOTATEDMAPPER"
                             targetPackage="com.itzhongzi.usernapp.mapper"
                             targetProject="./src/main/java">
            <property name="enableSubPackages" value="true" />
        </javaClientGenerator>

        <table tableName="t_user">
            <generatedKey column="id" sqlStatement="JDBC"/>
        </table>

    </context>
</generatorConfiguration>
  1. 增加一个工具类 AddLimitOffsetPlugin.java
package com.itzhongzi.usernapp.plugins;

import org.mybatis.generator.api.IntrospectedTable;
import org.mybatis.generator.api.PluginAdapter;
import org.mybatis.generator.api.dom.java.*;
import org.mybatis.generator.api.dom.xml.Attribute;
import org.mybatis.generator.api.dom.xml.TextElement;
import org.mybatis.generator.api.dom.xml.XmlElement;

import java.util.List;

public class AddLimitOffsetPlugin extends PluginAdapter {

    public boolean validate(List<String> warnings) {
        return true;
    }

    public boolean modelExampleClassGenerated(TopLevelClass topLevelClass,
                                              IntrospectedTable introspectedTable) {
        FullyQualifiedJavaType offsetType = new FullyQualifiedJavaType(
                "javax.annotation.Generated");
        topLevelClass.addImportedType(offsetType);
        topLevelClass.addAnnotation("@Generated(\"" + introspectedTable.getTableConfiguration().getTableName() + "\")");
        PrimitiveTypeWrapper integerWrapper = FullyQualifiedJavaType.getIntInstance().getPrimitiveTypeWrapper();

        Field limit = new Field();
        limit.setName("limit");
        limit.setVisibility(JavaVisibility.PRIVATE);
        limit.setType(integerWrapper);
        topLevelClass.addField(limit);

        Method limitSet = new Method();
        limitSet.setVisibility(JavaVisibility.PUBLIC);
        limitSet.setName("setLimit");
        limitSet.addParameter(new Parameter(integerWrapper, "limit"));
        limitSet.addBodyLine("this.limit = limit;");
        topLevelClass.addMethod(limitSet);

        Method limitGet = new Method();
        limitGet.setVisibility(JavaVisibility.PUBLIC);
        limitGet.setReturnType(integerWrapper);
        limitGet.setName("getLimit");
        limitGet.addBodyLine("return limit;");
        topLevelClass.addMethod(limitGet);

        Field offset = new Field();
        offset.setName("offset");
        offset.setVisibility(JavaVisibility.PRIVATE);
        offset.setType(integerWrapper);
        topLevelClass.addField(offset);

        Method offsetSet = new Method();
        offsetSet.setVisibility(JavaVisibility.PUBLIC);
        offsetSet.setName("setOffset");
        offsetSet.addParameter(new Parameter(integerWrapper, "offset"));
        offsetSet.addBodyLine("this.offset = offset;");
        topLevelClass.addMethod(offsetSet);

        Method offsetGet = new Method();
        offsetGet.setVisibility(JavaVisibility.PUBLIC);
        offsetGet.setReturnType(integerWrapper);
        offsetGet.setName("getOffset");
        offsetGet.addBodyLine("return offset;");
        topLevelClass.addMethod(offsetGet);

        return true;
    }

    public boolean sqlMapSelectByExampleWithoutBLOBsElementGenerated(
            XmlElement element, IntrospectedTable introspectedTable) {
        XmlElement isNotNullElement = new XmlElement("if");
        isNotNullElement.addAttribute(new Attribute("test", "limit > 0"));
        isNotNullElement.addElement(new TextElement("limit ${limit}"));
        element.getElements().add(isNotNullElement);

        isNotNullElement = new XmlElement("if");
        isNotNullElement.addAttribute(new Attribute("test", "offset > 0"));
        isNotNullElement.addElement(new TextElement("offset ${offset}"));
        element.getElements().add(isNotNullElement);
        return true;
    }

}
  1. 增加一个启动类 Generator.java
    示例如下： 启动 generate方法便可以在自己配置的目录生成 实体类 和 mapper类
package com.itzhongzi.usernapp.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();
    }
}
ITzhongzi
关注
专栏目录
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 mysql分页
77的博客
04-10 447
mybatis generator生成工具是非常强大的。基本上满足我们的很多需求了。但是如果想像下面这样的，暂时还是木有滴： List&lt;PhysicalOrderInfo&gt; selectPage(@Param("info")PhysicalOrderInfo info, @Param("pageable")Pageable pageable); int selectCo...
MyBatis generator使用，为Example添加分页
胡萧徒的博客
03-14 5819
条件: 数据库为 MySQL 1.对应的 XXXExample.java 中添加两个属性,以及对于的 getter 和 setter 方法 protected int startRow; protected int pageSize; public int getStartRow() { return startRow; } public void setStartR...
DAO层使用Mybatis-generator生成映射文件连接Mysql入门测试用例（无限速源码下载），page分页和limit的使用（四）
cucgyfjklx的博客
02-04 1万+
DAO层使用Mybatis-generator生成映射文件连接Mysql入门测试用例（无限速源码下载），page分页和limit的使用（四）
mybatis自动生成代码(generator插件)
yx15156537218的博客
11-05 400
mybatis代码生成插件generator generator依赖 测试类生成器 配置文件 1、依赖 <dependency> <groupId>org.mybatis.spring.boot</groupId> <artifactId>mybatis-spring-boot-starter</artifactId> <version>1.3.0&
Mybatis Generator 之分页查询
青城山上学编程
10-09 1454
通过之前的基础篇、注释篇和 Lombok 篇，生成的实体类和 Mapper 基本上可以满足大部分常见的业务，但这其中并不包括分页查询。不能分页的查询是没有灵魂的，小编能力有限，只实现了 mysql 的 limit 功能。
MyBatis Generator实现MySQL分页插件
叉叉哥的BLOG
05-06 2万+
MyBatis Generator是一个非常方便的代码生成工具，它能够根据表结构生成CRUD代码，可以满足大部分需求。但是唯一让人不爽的是，生成的代码中的数据库查询没有分页功能。本文介绍如何让MyBatis Generator生成的代码具有分页功能。MyBatis Generator结合Maven的配置和使用在实现分页之前，首先简单介绍MyBatis Generator如何使用。MyBatis Ge
mybatis generator 使用方法教程(生成带注释的实体类)
08-29
MyBatis Generator 使用方法教程（生成带注释的实体类） MyBatis Generator 是一个强大的工具，能够根据数据库表自动生成 Java 实体类、DAO、Mapper.xml 等文件，从而提高开发效率和减少开发时间。在本教程中，我们...
MyBatis Generator去掉生成的注解
09-01
默认情况下，MyBatis Generator使用的是`org.mybatis.generator.internal.DefaultCommentGenerator`。如果你想使用自定义的注释生成策略，你可以设置`type`属性，例如： ```xml ``` 这里，`...
Mybatis Generator使用说明
最新发布
02-03
### Mybatis Generator使用说明 #### 一、简介 Mybatis Generator 是一款强大的代码生成工具，它可以根据数据库表结构自动生成相应的 Java 实体类、Mapper 接口、XML 映射文件等，极大地提高了开发效率，减少了...
mybatis-generator中文注释并带分页-改进版2
07-08
jar包，直接替换eclipse->plugin下的 org.mybatis.generator.core_1.3.4.201608190045.jar包即可 如果版本不同的话，那么用外面的*.class文件找到相对应的目录替换jar包里的class就行。 这里也放了未编译的*.java文件供参考。里面配置是mysql, 使用的话，可以参数博客： http://blog.csdn.net/paincupid/article/details/52645610
mybatis-generator-plugin
01-06
mybaties-generator-plugin mysql 自动代码生成工具 用idea运行代码,实现自定义注解，分页功能 ，service ,controller，serviceimpl类
mybatis generator mysql
10-12
3. **运行MBG**：在Java代码中，通过调用`org.mybatis.generator.api.MyBatisGenerator`类的静态方法来执行生成过程。也可以通过命令行执行MBG，前提是配置文件和JAR文件在同一目录下。 4. **生成的代码**：MBG会...
mybatis generator
10-11
Mybatis Generator是一款强大的工具，它为开发者自动化生成Mybatis的Mapper接口、XML映射文件以及实体类，大大减轻了在使用Mybatis时手动编写这些文件的工作负担。在Java开发环境中，ORM(Object-Relational Mapping)...
利用mybatis generator插件生成基于分页语句及分页解决方案
woniu4500的专栏
05-29 3275
1》 虽然MyBatis_Generator可以将常用的DAO中的方法都生成,但是唯独忽视了一点——分页,虽然MyBatis支持分页,但是那个分页是内存分页,如果数据量大的话内存恐怕要承受不了,于是就自动动手改造自动化工具生成的代码使其支持真分页. 本文里面我说的是针对mysql的,针对其他数据库的请做适当修改,因为mybatis底层没有封装数据库的差异,所以我觉得也并没有必要对其差异进行
mybatis generator 使用
热门推荐
大T的专栏
06-09 3万+
XML Parser Error on line 13: XML 文档结构必须从头至尾包含在同一个实体内。 貌似配置文件不能加注释！ Unexpected error while running MyBatis Generator. Exception getting JDBC Driver 查阅generator官方文档发现指定Jar包路径即可   eneration
mybatis 分页插件 mysql_mybatis generator以及分页插件com.qiukeke.mybatis.plugins.MySQLLimitPlugin...
weixin_42554394的博客
01-27 389
1、官网：http://www.mybatis.org/generator/mybatis generator 生成的文件，包含三类：1)Model 实体文件，一个数据库表生成一个 Model 实体；2)ModelExample 文件，此文件和实体文件在同一目录下，主要用于查询条件构造；3)Mapper 接口文件，数据数操作方法都在此接口中定义；4)Mapper XML 配置文件；2、安装 ecl...
mysql能不能用分页插件_MyBatis Generator实现MySQL分页插件
weixin_35641153的博客
01-20 148
MyBatis Generator是一个非常方便的代码生成工具，它能够根据表结构生成CRUD代码，可以满足大部分需求。但是唯一让人不爽的是，生成的代码中的数据库查询没有分页功能。本文介绍如何让MyBatis Generator生成的代码具有分页功能。MyBatis Generator结合Maven的配置和使用在实现分页之前，首先简单介绍MyBatis Generator如何使用。MyBatis G...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

ITzhongzi

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

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

余额充值