当前位置:首页 > Java技术文章 > mybatis的插件机制示例详解

实例详解mybatis的插件机制

  • 发布时间:
  • 作者:码农之家原创
  • 点击:181

这篇文章主要知识点是关于mybatis、插件机制、Mybatis分页插件使用方法详解 的内容,如果大家想对相关知识点有系统深入的学习,可以参阅以下java相关资源

数据结构与抽象:Java语言描述

《数据结构与抽象:Java语言描述》是一本数据结构的教材,Java语言与数据结构两条知识主线贯穿始终,这两条主线既相互独立又相互支撑。本书介绍了计算机编程中使用的数据结构和算法,包括29章,每章涉及一个ADT或其不同实现的规格说明和用法。

查看详情

mybatis的插件机制示例详解

前言

Mybatis作为一个应用广泛的优秀的ORM框架,已经成了JavaWeb世界近乎标配的部分,这个框架具有强大的灵活性,在四大组件(Executor、StatementHandler、ParameterHandler、ResultSetHandler)处提供了简单易用的插件扩展机制。Mybatis对持久层的操作就是借助于四大核心对象。MyBatis支持用插件对四大核心对象进行拦截,对mybatis来说插件就是拦截器,用来增强核心对象的功能,增强功能本质上是借助于底层的动态代理实现的,换句话说,MyBatis中的四大对象都是代理对象。

四大核心对象简介

MyBatis 四大核心对象

ParameterHandler:处理SQL的参数对象

ResultSetHandler:处理SQL的返回结果集

StatementHandler:数据库的处理对象,用于执行SQL语句

Executor:MyBatis的执行器,用于执行增删改查操作

Mybatis插件原理

  1. Mybatis的插件借助于责任链的模式进行对拦截的处理
  2. 使用动态代理对目标对象进行包装,达到拦截的目的
  3. 作用于Mybatis的作用域对象之上

拦截

插件具体是如何拦截并附加额外的功能的呢?

以ParameterHandler 来说

 public ParameterHandler newParameterHandler(MappedStatement mappedStatement, Object object, BoundSql sql, InterceptorChain interceptorChain){
 ParameterHandler parameterHandler = mappedStatement.getLang().createParameterHandler(mappedStatement,object,sql);
 parameterHandler = (ParameterHandler) interceptorChain.pluginAll(parameterHandler);
 return parameterHandler;
 }
public Object pluginAll(Object target) {
 for (Interceptor interceptor : interceptors) {
 target = interceptor.plugin(target);
 }
 return target;
 }

interceptorChain 保存了所有的拦截器(interceptors),是mybatis初始化的时候创建的。调用拦截器链中的拦截器依次的对目标进行拦截或增强。interceptor.plugin(target)中的target就可以理解为mybatis中的四大对象。返回的target是被重重代理后的对象。

插件接口

Mybatis插件接口-Interceptor

1.Intercept方法,插件的核心方法

2.plugin方法,生成target的代理对象

3.setProperties方法,传递插件所需参数

插件实例

插件开发需要以下步骤

  1. 自定义插件需要实现上述接口
  2. 增加@Intercepts注解(声明是哪个核心组件的插件,以及对哪些方法进行扩展)
  3. 在xml文件中配置插件
/** 插件签名,告诉mybatis单钱插件用来拦截那个对象的哪个方法 **/
@Intercepts({@Signature(type = ResultSetHandler.class,method ="handleResultSets",args = Statement.class)})
public class MyFirstInterceptor implements Interceptor {

 /** @Description 拦截目标对象的目标方法 **/
 @Override
 public Object intercept(Invocation invocation) throws Throwable {
 System.out.println("拦截的目标对象:"+invocation.getTarget());
 Object object = invocation.proceed();
 return object;
 }
 /**
 * @Description 包装目标对象 为目标对象创建代理对象
 * @Param target为要拦截的对象
 * @Return 代理对象
 */
 @Override
 public Object plugin(Object target) {
 System.out.println("将要包装的目标对象:"+target);
 return Plugin.wrap(target,this);
 }
 /** 获取配置文件的属性 **/
 @Override
 public void setProperties(Properties properties) {
 System.out.println("插件配置的初始化参数:"+properties);
 }
}

在mybatis.xml中配置插件

<!-- 自定义插件 -->
 <plugins>
  <plugin interceptor="mybatis.interceptor.MyFirstInterceptor">
   <!--配置参数-->
   <property name="name" value="Bob"/>
  </plugin>
 </plugins>

调用查询方法,查询方法会返回ResultSet

public class MyBatisTest {
 public static SqlSessionFactory sqlSessionFactory = null;

 public static SqlSessionFactory getSqlSessionFactory() {
  if (sqlSessionFactory == null) {
   String resource = "mybatis-config.xml";
   try {
    Reader reader = Resources.getResourceAsReader(resource);
    sqlSessionFactory = new SqlSessionFactoryBuilder().build(reader);
   } catch (IOException e) {
    e.printStackTrace();
   }
  }
  return sqlSessionFactory;
 }

 public void testGetById()
 {
  SqlSession sqlSession = this.getSqlSessionFactory().openSession();
  PersonMapper personMapper = sqlSession.getMapper(PersonMapper.class);
  Person person=personMapper.getById(2001);
  System.out.println(person.toString());
 }

public static void main(String[] args) {
  new MyBatisTest().testGetById();
 }
}

输出结果

插件配置的初始化参数:{name=Bob}
将要包装的目标对象:org.apache.ibatis.executor.CachingExecutor@754ba872
将要包装的目标对象:org.apache.ibatis.scripting.defaults.DefaultParameterHandler@192b07fd
将要包装的目标对象:org.apache.ibatis.executor.resultset.DefaultResultSetHandler@7e0b0338
将要包装的目标对象:org.apache.ibatis.executor.statement.RoutingStatementHandler@1e127982
拦截的目标对象:org.apache.ibatis.executor.resultset.DefaultResultSetHandler@7e0b0338
Person{id=2001, username='Tom', email='email@0', gender='F'}

多插件开发过程

1.创建代理对象时,按照插件配置的顺序进行包装

2.执行目标方法后,是按照代理的逆向进行执行

总结

1.遵循插件尽量不使用的原则,因为会修改底层设计
2.插件是生成的层层代理对象的责任链模式,使用反射机制实现
3.插件的编写要考虑全面,特别是多个插件层层代理的时候

好了,以上就是这篇文章的全部内容了,希望本文的内容对大家的学习或者工作具有一定的参考学习价值,谢谢大家对码农之家的支持。

Mybatis分页插件使用方法详解

本文实例为大家分享了Mybatis分页插件使用的具体代码,供大家参考,具体内容如下

1.分页插件简介

pagehelper源码

都说这是史上最好用的分页插件,支持多种数据库以多种方式分页。

2.分页插件的使用

2.1导入maven依赖

<dependency>
 <groupId>com.github.pagehelper</groupId>
 <artifactId>pagehelper</artifactId>
 <version>最新版本</version>
</dependency>

2.2 添加配置

1.在mybatis的config配置文件中添加拦截器 <plugin>

<!--
 plugins在配置文件中的位置必须符合要求,否则会报错,顺序如下:
 properties?, settings?,
 typeAliases?, typeHandlers?,
 objectFactory?,objectWrapperFactory?,
 plugins?,
 environments?, databaseIdProvider?, mappers?
-->
<plugins>
  <plugin interceptor="com.github.pagehelper.PageHelper">
   <property name="dialect" value="mysql"/>
   <!-- 该参数默认为false -->
   <!-- 设置为true时,会将RowBounds第一个参数offset当成pageNum页码使用 -->
   <!-- 和startPage中的pageNum效果一样-->
   <property name="offsetAsPageNum" value="true"/>
   <!-- 该参数默认为false -->
   <!-- 设置为true时,使用RowBounds分页会进行count查询 -->
   <property name="rowBoundsWithCount" value="true"/>
   <!-- 设置为true时,如果pageSize=0或者RowBounds.limit = 0就会查询出全部的结果 -->
   <!-- (相当于没有执行分页查询,但是返回结果仍然是Page类型)-->
   <property name="pageSizeZero" value="true"/>
   <!-- 3.3.0版本可用 - 分页参数合理化,默认false禁用 -->
   <!-- 启用合理化时,如果pageNum<1会查询第一页,如果pageNum>pages会查询最后一页 -->
   <!-- 禁用合理化时,如果pageNum<1或pageNum>pages会返回空数据 -->
   <property name="reasonable" value="false"/>
   <!-- 3.5.0版本可用 - 为了支持startPage(Object params)方法 -->
   <!-- 增加了一个`params`参数来配置参数映射,用于从Map或ServletRequest中取值 -->
   <!-- 可以配置pageNum,pageSize,count,pageSizeZero,reasonable,不配置映射的用默认值 -->
   <!-- 不理解该含义的前提下,不要随便复制该配置 -->
   <property name="params" value="pageNum=start;pageSize=limit;"/>
  </plugin>
</plugins>

2.或者在spring配置中添加

<bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
 <!-- 注意其他配置 -->
 <property name="plugins">
 <array>
  <bean class="com.github.pagehelper.PageInterceptor">
  <property name="properties">
   <!--使用下面的方式配置参数,一行配置一个 -->
   <value>
   params=value1
   </value>
  </property>
  </bean>
 </array>
 </property>
</bean>

这两种方式不能同时用

3.在代码中的使用

3.1设置一个基础的请求类

public class BaseRequest implements Serializable {

 private static final long serialVersionUID = 1193444819529643410L;

 private Integer pageNum;//页数
 private Integer pageSize;//每页行数
 private Boolean count;//是否查询总条数

 public Integer getPageNum() {
  return pageNum;
 }

 public void setPageNum(Integer pageNum) {
  this.pageNum = pageNum;
 }

 public Integer getPageSize() {
  return pageSize;
 }

 public void setPageSize(Integer pageSize) {
  this.pageSize = pageSize;
 }

 public Boolean getCount() {
  return count;
 }

 public void setCount(Boolean count) {
  this.count = count;
 }

 @Override
 public String toString() {
  return "BaseRequest{" +
    "pageNum=" + pageNum +
    ", pageSize=" + pageSize +
    '}';
 }
}

3.2 设置一个基础的PageService 接口

让每个service 去实现这个接口来设置分页的初始值

public interface PageService {

 default void setDefaultPageInfo(BaseRequest baseRequest) {
  if (null != baseRequest) {
   baseRequest.setPageNum(null == baseRequest.getPageNum() ? Constants.PAGE_NUM : baseRequest.getPageNum());
   baseRequest
     .setPageSize(null == baseRequest.getPageSize() ? Constants.PAGE_SIZE : baseRequest.getPageSize());
   baseRequest.setCount(null == baseRequest.getCount() ? Boolean.TRUE : baseRequest.getCount());
  } else {
   baseRequest = new BaseRequest();
   baseRequest.setPageNum(Constants.PAGE_NUM);
   baseRequest.setPageSize(Constants.PAGE_SIZE);
   baseRequest.setCount(Boolean.TRUE);
  }
  PageHelper.startPage(baseRequest.getPageNum(), baseRequest.getPageSize(),baseRequest.getCount());
 }

}

3.3 如果做了数据转换这用来复制属性值(可选)

数据模型entity 只对应数据库表中的字段, 出参与入参 都是数据传输对象 dto , 从数据库中查出来的是entity而 接口返回的是dto 所要BeanUtils.copyProperties复制属性,和pageutils.copyProperties 复制分页属性

public class PageUtils {

 public static void copyProperties(PageInfo<?> source, PageInfo<?> des) {
  des.setEndRow(source.getEndRow());
  des.setFirstPage(source.getFirstPage());
  des.setHasNextPage(source.isHasNextPage());
  des.setHasPreviousPage(source.isHasPreviousPage());
  des.setIsFirstPage(source.isIsFirstPage());
  des.setIsLastPage(source.isIsLastPage());
  des.setNavigatepageNums(source.getNavigatepageNums());
  des.setNavigatePages(source.getNavigatePages());
  des.setNextPage(source.getNextPage());
  des.setOrderBy(source.getOrderBy());
  des.setPageNum(source.getPageNum());
  des.setPages(source.getPages());
  des.setPageSize(source.getPageSize());
  des.setPrePage(source.getPrePage());
  des.setSize(source.getSize());
  des.setStartRow(source.getStartRow());
  des.setTotal(source.getTotal());
 }
}

4.使用示例

在OrderService实现类中

import com.github.pagehelper.PageInfo;
import com.javxuan.common.util.PageUtils;
import com.javxuan.order.entity.Order;
import com.javxuan.order.response.OrderDto;
import com.javxuan.order.service.PageService;
import org.springframework.beans.BeanUtils;
import org.springframework.beans.factory.annotation.Autowired;

import java.util.ArrayList;

public class OrderServcieImpl implements IOrderServcie, PageService {

 @Autowired
 IOrderMapper orderMapper;

 @GetMapping("/order")
 public PageInfo<OrderDto> list(OrderRequest orderRequest){
  //设置默认分页信息 PageService的方法
  setDefaultPageInfo(orderRequest);

  //查出order列表
  List<Order> orderList = orderMapper.selectList();
  //将entity的列表分页
  PageInfo<Order> orderPageInfo = new PageInfo<>(orderList);

  //连续显示5页与上面的二选一
  //PageInfo<Order> orderPageInfo = new PageInfo<>(orderList,5);

  //定义一个数据传输对象dtoList
  List<OrderDto> dtoList = new ArrayList<>();
  if(null==orderList || orderList.size<=0){
   return null;
  }

  //给dtoList 加值
  for(Order order:orderList){
   OrderDto dto = new OrderDto();
   //将entity 的属性值 复制给dto上
   BeanUtils.copyProperties(order, dto);
   dtoList.add(dto);
  }

  //给dto 分页
  PageInfo<OrderDto> dtoPageInfo = new PageInfo<>(dtoList);

  //连续显示5页 与上面的二选一
  //PageInfo<Order> orderPageInfo = new PageInfo<>(orderList,5);

  //将entity的分页信息复制给dtoPageInfo上
  PageUtils.copyProperties(orderPageInfo, dtoPageInfo);
  return dtoPageInfo;
 }
}

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持码农之家。

以上就是本次给大家分享的关于Java的全部知识点内容总结,大家还可以在下方相关文章里找到Java文件和base64流相互转换、 Java实现快速排序原理分析、 java图形界面编程的代码详、 等java文章进一步学习,感谢大家的阅读和支持。

上一篇:spring-boot-starter-web更换默认Tomcat容器的步骤

下一篇:Java实现随机10道10以内加减法的代码详解

展开 +

收起 -

mybatis插件机制 相关内容
mybatis注解配置的学习笔记

本篇文章主要介绍了mybatis学习笔记之mybatis注解配置详解,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧

查看详情
解决Mybatis逆向工程中使用Mysql8.0版本驱动遇到的问题

今天在使用 8.0.12 版的 mysql 驱动时遇到了各种各样的坑。这篇文章主要介绍了详解Mybatis逆向工程中使用Mysql8.0版本驱动遇到的问题,感兴趣的小伙伴们可以参考一下

查看详情
Spring Boot整合mybatis多数据源用法

这篇文章主要介绍了Spring Boot 整合mybatis 使用多数据源的实现方法,需要的朋友可以参考下

查看详情
Three.js开发指南:WebGL的JavaScript 3D库 查看详情
Java机器学习

利用Java机器学习常见库设计、构建、部署你自己的机器学习应用,包含机器学习基本概念、原理,Weka、Mahout、Spark等常见机器学习库的用法

查看详情
JavaScript从入门到精通

本书是javascript高级程序的权威指南,从初学者角度出发,通过通俗易懂的语言、丰富多彩的实例,详细介绍了使用JavaScript语言进行程序开发应该掌握的各方面技术,是一本入门经典书籍

查看详情
500套java毕业设计、PHP毕业设计视频演示

500多套的相关java、php的相关毕业设计项目视频演示,大家可以参考下里面的项目名称以及相关的界面,需要的毕业生们参考下吧。

查看详情
Java9模块化开发核心原则与实践 查看详情
Java 8基础应用与开发

《 Java8基础应用与开发 》包含Java8特点,知识结构图从入门到精通逐层加强,Q-DMS数据挖掘项目围绕本书,重视內容和实践活动,说道关键点和方式。结合实际成才全书的特性: 基础理论基础

查看详情
OSGi与Equinox:创建高度模块化的Java系统

阅读本书,首先你很快就会使用Eclipse bundle工具创建第一个基于OSGi的系统,进而转向复杂的产品开发。接下来,你将掌握一些用于创建具有特殊模块化、高效性和可维护性系统的最佳实践和技

查看详情
mybatis插件机制 学习笔记
网友NO.626630

Spring Mybatis 分页插件使用教程

Mybatis分页切入点 Mybatis内部有个plugins(插件)概念,本质上属于拦截器的思想。具体的解析可见他文MyBatis拦截器原理探究。本文将在此基础上直接展示实际项目的实现代码和其他的相关解析 分页具体代码实现 首先我们可以定义方言抽象类,用于实现分页AbstractDialect.java public abstract class AbstractDialect{ /** * 是否支持limit和偏移量 * @return */ public abstract boolean supportsLimitOffset(); /** * 是否支持limit * @return */ public abstract boolean supportsLimit(); /** * 获取增加了分页属性之后的SQL * @param sql * @param offset * @param limit * @return */ public abstract String getLimitString(String sql, int offset, int limit);} 再而我们就以Oracle与Mysql数据库的分页技术作下分别的实现 MySQLDialect.java-Mysql分页方言 public class MySQLDialect extends AbstractDialect { public boolean supportsLimitOffset() { return true; } public boolean supportsLimit() { re……

网友NO.297916

mybatis使用pageHelper插件进行查询分页

在数据库服务器中,sql语句实现分页便要每个查询语句都要写上limit(开始,结束),并且不能灵活的随前端变化,为此使用拦截器的方法,过程:拦截器拦截请求的sql语句(根据需要拦截的ID(正则匹配),进行拦截),并对根据前端传过来的页数,和每页的条数,计算出limit(开始,结束),总条数,然后,拼接到sql语句后边。其中这个处理过程,已经封装到了,分页插件中,可以不用理解,直接使用。 mybatis查询分页---使用pageHelper插件 之前在spring+springmvc由于整个大多都是xml的配置,在使用spring-boot后,需要进行分页, 也希望能够减少xml的配置以及新建很多分页的相关类,找到了pageHelper这个插件, 分页起来非常方便 page类 新建一个page T 用来接收分页信息 /** * @Author xuelongjiang */public class PageT { private Integer pageNo = 0; private Integer pageSize = 10; private T t; publ……

网友NO.319405

Mybatis分页插件使用方法详解

本文实例为大家分享了Mybatis分页插件使用的具体代码,供大家参考,具体内容如下 1.分页插件简介 pagehelper源码 都说这是史上最好用的分页插件,支持多种数据库以多种方式分页。 2.分页插件的使用 2.1导入maven依赖 dependency groupIdcom.github.pagehelper/groupId artifactIdpagehelper/artifactId version最新版本/version/dependency 2.2 添加配置 1.在 mybatis的config配置文件 中添加拦截器 plugin !-- plugins在配置文件中的位置必须符合要求,否则会报错,顺序如下: properties?, settings?, typeAliases?, typeHandlers?, objectFactory?,objectWrapperFactory?, plugins?, environments?, databaseIdProvider?, mappers?--plugins plugin interceptor="com.github.pagehelper.PageHelper" property name="dialect" value="mysql"/ !-- 该参数默认为false -- !-- 设置为true时,会将RowBounds第一个参数offset当成pageNum页码使用 -- !-- 和startPage中的pageNum效果一样-- property name="of……

网友NO.725974

MyBatis分页插件PageHelper的具体使用

MyBatis分页插件PageHelper 如果你也在用 MyBatis,建议尝试该分页插件,这一定是最方便使用的分页插件。分页插件支持任何复杂的单表、多表分页。 PageHelper是一个Mybatis的分页插件, 负责将已经写好的sql语句, 进行分页加工. PageHelper的使用 优点:无需你自己去封装以及关心sql分页等问题,使用很方便,前端取数据也很方便。 1.引入pagehelper依赖 dependency groupIdcom.github.pagehelper/groupId artifactIdpagehelper/artifactId version5.1.2ersion/dependency 2.配置applicationContext.xml文件 在spring的 sqlsessionfactory 的 bean 中增加一个分页拦截器属性 bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean" property name="plugins" array bean class="com.github.pagehelper.PageInterceptor" property name="properties" value !-- 这里设定你的数据库类型 -- helperDialect=mysql /value /property /bean /array /property/bean 3.调用PageHelper的方法 在……

网友NO.726525

mybatis拦截器与分页插件实例教程

mybatis介绍 拦截器的一个作用就是我们可以拦截某些方法的调用,我们可以选择在这些被拦截的方法执行前后加上某些逻辑,也可以在执行这些被拦截的方法时执行自己的逻辑而不再执行被拦截的方法。 MyBatis 是一款优秀的持久层框架,它支持定制化 SQL、存储过程以及高级映射。MyBatis 避免了几乎所有的 JDBC 代码和手动设置参数以及获取结果集。MyBatis 可以使用简单的 XML 或注解来配置和映射原生类型、接口和 Java 的 POJO(Plain Old Java Objects,普通老式 Java 对象)为数据库中的记录。 mybatis架构图 我们这个demo实现就是基于mybatis的插件模块(主要实现mybatis的Interceptor接口) Interceptor接口 package org.apache.ibatis.plugin;import java.util.Properties;/** * @author Clinton Begin */public interface Interceptor { Object intercept(Invocation invocation) throws Throwable; Object plugin(Object target); void setPrope……

<
1
>

Copyright 2018-2020 xz577.com 码农之家

本站所有电子书资源不再提供下载地址,只分享来路

免责声明:网站所有作品均由会员网上搜集共同更新,仅供读者预览及学习交流使用,下载后请24小时内删除

版权投诉 / 书籍推广 / 赞助:QQ:520161757