mybatis拦截器使用

[toc]

mybatis拦截器入门

mybatis 拦截器接口Interceptor

Interceptor接口,我们通过这个接口可以自定义我们自己的拦截器,从而实现在拦截的时候写上我们自己的一些逻辑。该接口提供了三个方法,

接口介绍:

intercept方法:
intercept方法是在进行拦截的时候要执行的方法。
plugin方法:
该方法是拦截器用于封装目标对象的,通过该方法我们可以返回目标对象本身,也可以返回一个它的代理。
setProperties方法:
mybatis配置文件中configuration中的配置的指定属性值。

spring boot + mybatis整合

工程创建过程省略,不会的自行谷歌。

这里贴出主要的pom.xml文件

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-test</artifactId>
        <scope>test</scope>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <dependency>
        <groupId>org.mybatis.spring.boot</groupId>
        <artifactId>mybatis-spring-boot-starter</artifactId>
        <version>1.1.1</version>
    </dependency>
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-devtools</artifactId>
        <optional>true</optional>
    </dependency>
</dependencies>

<build>
    <resources>
        <resource>
            <directory>src/main/resources</directory>
            <filtering>true</filtering>
            <excludes>
                <exclude>application.yml</exclude>
                <exclude>application-dev.yml</exclude>
                <exclude>application-uat.yml</exclude>
            </excludes>
        </resource>
        <resource>
            <directory>src/main/resources</directory>
            <filtering>true</filtering>
            <includes>
                <include>application.yml</include>
            </includes>
        </resource>
    </resources>
    <plugins>
        <plugin>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-maven-plugin</artifactId>
            <configuration>
                <fork>true</fork>
            </configuration>
        </plugin>
    </plugins>
</build>

application.yml 文件配置

mybatis:
  mapper-locations: classpath*:/mapper/*.xml
  config-location: classpath:/mybatis-config.xml
  type-aliases-package: com.cl.domain
spring:
  datasource:
    driverClassName: com.mysql.jdbc.Driver
    url: jdbc:mysql://localhost:3306/cloud_afwk?useUnicode=true&characterEncoding=utf-8&useSSL=false
    username: cloudafwk
    password: handhand

mybatis-config.xml文件配置,注意:当自己重新写了一个mybatis 的拦截器需要配置

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configuration PUBLIC "-//mybatis.org//DTD Config 3.0//EN" "http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
   <settings>
      <!-- DTO驼峰命名与表字段下划线命名自动转换 -->
      <setting name="mapUnderscoreToCamelCase" value="true" />

      <!--<setting name="logImpl" value="STDOUT_LOGGING"/>-->
   </settings>
   <plugins>
      <plugin interceptor="com.cl.util.MyInterceptor">
         <property name="databaseType" value="mySql"/>
      </plugin>
   </plugins>
</configuration>

注意: 上述的package路径写自己搭建项目的路径,不可全盘copy

创建自己的拦截器MyInterceptor

创建自己的拦截器,并实现Interceptor接口,在自己的拦截器中分别实现intercept(),plugin(),setProperties()三个方法。首先我们先在三个方法中分别加入打印信息,看看先后自行的顺序。首先启动自己的程序,发现启动日志中已经有我们在拦截器里面的打印信息:

由此发现,setProperties()方法中可以在Configuration出事化当前的Interceptor时执行。

@Intercepts注解

阅读该注解的源码,发现里面就一个参数值Signature 类型的数组,可见在Interceptor中可以写多个值。

再深入一层去看Signature这个信号通知是什么?里面有三个值type,method,args,@Signature则表明要拦截的接口、方法以及对应的参数类型

下面通过注解里面具体的值来演示下该拦截器的执行过程:

@Intercepts({@Signature(type = StatementHandler.class, method = "prepare", args = {Connection.class, Integer.class})})

可见拦截器先是进plugin这个方法,看Plugin类:

该Plugin类中的静态方法wrap方法中根据注解Interceptor中定义的哪些接口需要拦截,如果有需要拦截的接口则返回一个代理对象,没有则返回目标对象本身。一个Plugin就是一个代理对象InvocationHandler,然后通过invoke方法封装成一个Invocation对象给intercept。

通过拦截器,可以自己定义分页查询的功能,将查询出来的语句重新封装sql语句,并返回对象,从而达到拦截器的作用,当有切换不同的数据库时,可以通过mybatis的配置属性值,在拦截器中获取不同的属性值,来重新封装sql语句,从而达到动态切换的目的

本文章只是介绍mybatis的拦截器的一些概念,具体分页查询,当然还可以自己定义一些其它的判断逻辑,比如我们项目中mybatis插件自动做租户隔离,也是运用类似的方法。总之,方法概念有了,具体实现就看个人了。嘻嘻嘻。。。

原文地址:https://www.cnblogs.com/levcon/p/9226184.html

时间: 2024-08-08 11:48:23

mybatis拦截器使用的相关文章

mybatis拦截器

业务需求:由于公司业务需要在所有的sql的增删改查中必须包含officeId,业务以officeId做隔离.因此做了一个Mybatis的的过去器.通过拦截sql处理的过程来判断接口sql是否包含officeId,如果不包含则添加officeId.@NoNeedOffice的注解可以添加在Dao的接口类或方法上.用于标识不需要处理的接口. package com.example.springcloud.provider; import com.example.springcloud.provide

Mybatis拦截器介绍及分页插件

1.1    目录 1.1 目录 1.2 前言 1.3 Interceptor接口 1.4 注册拦截器 1.5 Mybatis可拦截的方法 1.6 利用拦截器进行分页 1.2     前言 拦截器的一个作用就是我们可以拦截某些方法的调用,我们可以选择在这些被拦截的方法执行前后加上某些逻辑,也可以在执行这些被拦截的方法时执行自己的逻辑而不再执行被拦截的方法.Mybatis拦截器设计的一个初衷就是为了供用户在某些时候可以实现自己的逻辑而不必去动Mybatis固有的逻辑.打个比方,对于Executor

Mybatis拦截器介绍

拦截器的一个作用就是我们可以拦截某些方法的调用,我们可以选择在这些被拦截的方法执行前后加上某些逻辑,也可以在执行这些被拦截的方法时执行自己的逻辑而不再执行被拦截的方法.Mybatis拦截器设计的一个初衷就是为了供用户在某些时候可以实现自己的逻辑而不必去动Mybatis固有的逻辑.打个比方,对于Executor,Mybatis中有几种实现:BatchExecutor.ReuseExecutor.SimpleExecutor和CachingExecutor.这个时候如果你觉得这几种实现对于Execu

【Mybatis】1、Mybatis拦截器

MyBatis拦截器原理探究 http://www.cnblogs.com/fangjian0423/p/mybatis-interceptor.html MyBatis 拦截器 (实现分页功能) http://www.cnblogs.com/jethypc/p/5149183.html 由浅入深分析mybatis通过动态代理实现拦截器(插件)的原理 http://zhangbo-peipei-163-com.iteye.com/blog/2033832 使用方法 https://github.

Mybatis拦截器实现分页

本文介绍使用Mybatis拦截器,实现分页:并且在dao层,直接返回自定义的分页对象. 最终dao层结果: public interface ModelMapper { Page<Model> pageByConditions(RowBounds rowBounds, Model record); } 接下来一步一步来实现分页. 一.创建Page对象: public class Page<T> extends PageList<T> { private int page

Mybatis拦截器 mysql load data local 内存流处理

Mybatis 拦截器不做解释了,用过的基本都知道,这里用load data local主要是应对大批量数据的处理,提高性能,也支持事务回滚,且不影响其他的DML操作,当然这个操作不要涉及到当前所load的数据,其中在使用的时候一定要local , 这个命令使用是mysql规定的,否则不加则会认为是服务器本地的文件.这里主要是以流的方式来做处理,这样可以使用内存流,这样就可以避免在某些时候需要生成文件才能导入的多余操作,和IO性能消耗.也可以是应用本地的文件. 注:该做法只试用于存入数据的表,不

【Mybatis】1、Mybatis拦截器学习资料汇总

MyBatis拦截器原理探究 http://www.cnblogs.com/fangjian0423/p/mybatis-interceptor.html [myBatis]Mybatis中的拦截器 http://blog.csdn.net/moshenglv/article/details/52699976 MyBatis 拦截器 (实现分页功能) http://www.cnblogs.com/jethypc/p/5149183.html 由浅入深分析mybatis通过动态代理实现拦截器(插件

Mybatis 拦截器(二)

Mybatis拦截器介绍 拦截器的一个作用就是我们可以拦截某些方法的调用,我们可以选择在这些被拦截的方法执行前后加上某些逻辑,也可以在执行这些被拦截的方法时执行自己的逻辑而不再执行被拦截的方法.Mybatis拦截器设计的一个初衷就是为了供用户在某些时候可以实现自己的逻辑而不必去动Mybatis固有的逻辑.打个比方,对于Executor,Mybatis中有几种实现:BatchExecutor.ReuseExecutor.SimpleExecutor和CachingExecutor.这个时候如果你觉

MyBatis拦截器原理探究

前言: MyBatis拦截器介绍 MyBatis提供了一种插件(plugin)的功能,虽然叫做插件,但其实这是拦截器功能.那么拦截器拦截MyBatis中的哪些内容呢? 我们进入官网看一看: MyBatis 允许你在已映射语句执行过程中的某一点进行拦截调用.默认情况下,MyBatis 允许使用插件来拦截的方法调用包括: Executor (update, query, flushStatements, commit, rollback, getTransaction, close, isClose