Springboot+Mybatis+Mybatisplus 框架中增加自定义分页插件和sql 占位符修改插件

一、Springboot简介

springboot 是当下最流行的web 框架,Spring Boot是由Pivotal团队提供的全新框架,其设计目的是用来简化新Spring应用的初始搭建以及开发过程。该框架使用了特定的方式来进行配置,从而使开发人员不再需要定义样板化的配置,让这些框架集成在一起变得更加简单,简化了我们在集成过程中繁琐的模板化配置,springboot的核心特点如下:

  1. 独立运行:SpringBoot开发的应用可以以JRA包的形式独立运行,运行一个SpringBoot应用只需通过 java --jar xxxx.jar 来运行;
  2. 内嵌容器:SpringBoot内嵌了多个WEB容器,如:Tomcat、Jetty、Undertow,所以可以使用非WAR包形式进行项目部署;
  3. 自动starter依赖:SpringBoot提供了一系列的starter来简化Maven的依赖加载。starter是一组方便的依赖关系描述符,它将常用的依赖分组并将其合并到一个依赖中,这样就可以一次性将相关依赖添加到Maven或Gradle中;
  4. 自动配置:SpringBoot会根据在类路径中的JAR包和类,自动将类注入到SpringBoot的上下文中,极大地减少配置的使用;
  5. 应用监控:SpringBoot提供基于http、ssh、telnet的监控方式,对运行时的项目提供生产级别的服务监控和健康检测;
  6. 无代码生成/无需编写XML配置:SpringBoot不是借助于代码生成来实现的,而是通过条件注解来实现的,这是 Spring 4.x 提供的新特性。Spring4.x提倡使用Java配置和注解组合,无需编写任何xml配置即可实现Spring的所有配置功能;

二、Mybatis和Mybatisplus 简介

MyBatis 是支持普通 SQL查询,存储过程和高级映射的优秀持久层框架。MyBatis 消除了几乎所有的JDBC代码和参数的手工设置以及结果集的检索。MyBatis 使用简单的 XML或注解用于配置和原始映射,将接口和 Java 的POJOs(Plain Ordinary Java Objects,普通的 Java对象)映射成数据库中的记录。

每个MyBatis应用程序主要都是使用SqlSessionFactory实例的,一个SqlSessionFactory实例可以通过SqlSessionFactoryBuilder获得。SqlSessionFactoryBuilder可以从一个xml配置文件或者一个预定义的配置类的实例获得。

用xml文件构建SqlSessionFactory实例是非常简单的事情。推荐在这个配置中使用类路径资源(classpath resource),但你可以使用任何Reader实例,包括用文件路径或file://开头的url创建的实例。MyBatis有一个实用类----Resources,它有很多方法,可以方便地从类路径及其它位置加载资源。

MyBatis中文网站:https://mybatis.net.cn/

MyBatis blog:https://blog.mybatis.org/

MyBatis 官方网站:https://mybatis.org/mybatis-3/

MyBatis github:https://github.com/mybatis/mybatis-3

MyBatis-Plus(简称 MP)是一个 MyBatis 的增强工具,在 MyBatis 的基础上只做增强不做改变,为简化开发、提高效率而出现的框架,它对 Mybatis 的基础功能进行了增强,但未做任何改变。

MyBatis-Plus官网:https://baomidou.com/

MyBatis-Plus github:https://github.com/baomidou/mybatis-plus

三、Springboot+Mybatis+Mybatisplus 框架中增加自定义分页插件和sql 占位符修改插件

1、如何自定义分页插件

1)、在MyBatis-Plus 提供了com.baomidou.mybatisplus.extension.plugins.pagination.dialects.IDialect的接口抽象,如果需要自定义一个分页插件,需要先实现该接口,

复制代码
public class MyDialect implements IDialect {

    @Override
    public MyDialect buildPaginationSql(String originalSql, long offset, long limit) {
        //示例
        limit = (offset >= 1) ? (offset + limit) : limit;
        String sql = "SELECT * FROM ( SELECT TMP.*, ROW_NUMBER() OVER (ORDER BY 0) ROW_ID FROM ( " +
                originalSql + " ) TMP LIMIT " + FIRST_MARK + ") WHERE ROW_ID > " + SECOND_MARK;
        return new MyDialect(sql, limit, offset).setConsumerChain();
    }
}

2)、实现由MyBatis-Plus 提供的com.baomidou.mybatisplus.extension.plugins.inner.PaginationInnerInterceptor 接口

复制代码
public class CustomerPaginationInnerInterceptor extends PaginationInnerInterceptor {


    @Override
    protected IDialect findIDialect(Executor executor) {
        return new MyDialect(); //这里也可以自己增加判断,根据不同的数据库类型,使用不同的IDialect 实现
    }
}

2、如何自定义sql 占位符修改插件

需要实现MyBatis-Plus 提供的com.baomidou.mybatisplus.extension.plugins.inner.InnerInterceptor提供的接口,在mybatis-plus中,提供了innerinterceptor拦截器,可以方便地实现拼接查询条件。 innerinterceptor拦截器可以拦截所有的select语句,然后可以对拦截到的sql语句做修改。

复制代码
public class MyReplacePlaceholderInnerInterceptor implements InnerInterceptor {

    public MyReplacePlaceholderInnerInterceptor() {

    }

    @Override
    public void beforeQuery(Executor executor, MappedStatement ms, Object parameter, RowBounds rowBounds, ResultHandler resultHandler, BoundSql boundSql) throws SQLException {
        String sql = boundSql.getSql();
         //TODO 对SQL 语句做占位符的替换
            PluginUtils.mpBoundSql(boundSql).sql(sql);
    }
}

3、定义自定义的mybatis的Configuration配置

复制代码
@Configuration
public class MybatisPlusConfiguration implements InitializingBean {

    @Autowired
    private MybatisPlusInterceptor mybatisPlusInterceptor;

    @Override
    public void afterPropertiesSet() throws Exception {
        
        List<InnerInterceptor> targetInterceptors = new ArrayList<>();
        MyReplacePlaceholderInnerInterceptor  myPlaceholderInnerInterceptor = new MyReplacePlaceholderInnerInterceptor ();
        targetInterceptors.add(myPlaceholderInnerInterceptor);
        // 先执行MybatisCustomerInterceptor
        List<InnerInterceptor> interceptors = mybatisPlusInterceptor.getInterceptors();
        interceptors.forEach(innerInterceptor -> {
            if (innerInterceptor instanceof PaginationInnerInterceptor) {
                // 自定义分页插件
                CustomerPaginationInnerInterceptor customerPaginationInnerInterceptor = new CustomerPaginationInnerInterceptor();
                customerPaginationInnerInterceptor.setMaxLimit(1000L);
                targetInterceptors.add(customerPaginationInnerInterceptor);
            }
            else {
                targetInterceptors.add(innerInterceptor);
            }
        });
        mybatisPlusInterceptor.setInterceptors(targetInterceptors);
    }
}
相关推荐
程序猿熊跃晖2 小时前
解决 MyBatis-Plus 中 `update.setProcInsId(null)` 不生效的问题
数据库·tomcat·mybatis
Hars、Wlgb3 小时前
mybatis 自带的几个插入接口的区别
mybatis
向阳2566 小时前
SpringBoot+vue前后端分离整合sa-token(无cookie登录态 & 详细的登录流程)
java·vue.js·spring boot·后端·sa-token·springboot·登录流程
XiaoLeisj6 小时前
【MyBatis】深入解析 MyBatis XML 开发:增删改查操作和方法命名规范、@Param 重命名参数、XML 返回自增主键方法
xml·java·数据库·spring boot·sql·intellij-idea·mybatis
KATA~1 天前
解决MyBatis-Plus枚举映射错误:No enum constant问题
java·数据库·mybatis
天上掉下来个程小白1 天前
Redis-14.在Java中操作Redis-Spring Data Redis使用方式-操作列表类型的数据
java·redis·spring·springboot·苍穹外卖
伊成1 天前
Springboot整合Mybatis+Maven+Thymeleaf学生成绩管理系统
java·maven·mybatis·springboot·学生成绩管理系统
我要学编程(ಥ_ಥ)1 天前
初始JavaEE篇 —— Mybatis-plus 操作数据库
java·java-ee·mybatis·mybatis-plus
〆、风神1 天前
装饰器模式与模板方法模式实现MyBatis-Plus QueryWrapper 扩展
mybatis·装饰器模式·模板方法模式
鸽鸽程序猿2 天前
【JavaEE】MyBatis - Plus
java-ee·mybatisplus