Mybatis Interceptor 拦截器的实现

 更新时间:2018年12月17日 14:19:07   作者:广训  
这篇文章主要介绍了Mybatis Interceptor 拦截器的实现,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧

Mybatis采用责任链模式,通过动态代理组织多个拦截器(插件),通过这些拦截器可以改变Mybatis的默认行为(诸如SQL重写之类的),由于插件会深入到Mybatis的核心,因此在编写自己的插件前最好了解下它的原理,以便写出安全高效的插件。

拦截器(Interceptor)在 Mybatis 中被当做插件(plugin)对待,官方文档提供了 Executor,ParameterHandler,ResultSetHandler,StatementHandler 共4种,并且提示“这些类中方法的细节可以通过查看每个方法的签名来发现,或者直接查看 MyBatis 发行包中的源代码”。

拦截器的使用场景主要是更新数据库的通用字段,分库分表,加解密等的处理。

1. Interceptor

拦截器均需要实现该 org.apache.ibatis.plugin.Interceptor 接口。

2. Intercepts 拦截器

@Intercepts({
    @Signature(type = Executor.class, method = "update", args = {MappedStatement.class, Object.class})
})

拦截器的使用需要查看每一个type所提供的方法参数。

Signature 对应 Invocation 构造器,type 为 Invocation.Object,method 为 Invocation.Method,args 为 Invocation.Object[]。

method 对应的 update 包括了最常用的 insert/update/delete 三种操作,因此 update 本身无法直接判断sql为何种执行过程。

args 包含了其余所有的操作信息, 按数组进行存储, 不同的拦截方式有不同的参数顺序, 具体看type接口的方法签名, 然后根据签名解析。

3. Object 对象类型

args 参数列表中,Object.class 是特殊的对象类型。如果有数据库统一的实体 Entity 类,即包含表公共字段,比如创建、更新操作对象和时间的基类等,在编写代码时尽量依据该对象来操作,会简单很多。该对象的判断使用

Object parameter = invocation.getArgs()[1];
if (parameter instanceof BaseEntity) {
  BaseEntity entity = (BaseEntity) parameter;
}

即可,根据语句执行类型选择对应字段的赋值。

如果参数不是实体,而且具体的参数,那么 Mybatis 也做了一些处理,比如 @Param("name") String name 类型的参数,会被包装成 Map 接口的实现来处理,即使是原始的 Map 也是如此。使用

Object parameter = invocation.getArgs()[1];
if (parameter instanceof Map) {
  Map map = (Map) parameter;
}

即可,对具体统一的参数进行赋值。

4. SqlCommandType 命令类型

Executor 提供的方法中,update 包含了 新增,修改和删除类型,无法直接区分,需要借助 MappedStatement 类的属性 SqlCommandType 来进行判断,该类包含了所有的操作类型

public enum SqlCommandType {
 UNKNOWN, INSERT, UPDATE, DELETE, SELECT, FLUSH;
}

毕竟新增和修改的场景,有些参数是有区别的,比如创建时间和更新时间,update 时是无需兼顾创建时间字段的。

MappedStatement ms = (MappedStatement) invocation.getArgs()[0];
SqlCommandType commandType = ms.getSqlCommandType();

5. 实例

自己编写的小项目中,需要统一给数据库字段属性赋值:

public class BaseEntity {
  private int id;
  private int creator;
  private int updater;
  private Long createTime;
  private Long updateTime;
}

dao 操作使用了实体和参数的方式,个人建议还是统一使用实体比较简单,易读。

使用实体:

int add(BookEntity entity);

使用参数:

复制代码 代码如下:
int update(@Param("id") int id, @Param("url") String url, @Param("description") String description, @Param("playCount") int playCount, @Param("creator") int creator, @Param("updateTime") long updateTime);

完整的例子:

package com.github.zhgxun.talk.common.plugin;

import com.github.zhgxun.talk.common.util.DateUtil;
import com.github.zhgxun.talk.common.util.UserUtil;
import com.github.zhgxun.talk.entity.BaseEntity;
import com.github.zhgxun.talk.entity.UserEntity;
import lombok.extern.slf4j.Slf4j;
import org.apache.ibatis.executor.Executor;
import org.apache.ibatis.mapping.MappedStatement;
import org.apache.ibatis.mapping.SqlCommandType;
import org.apache.ibatis.plugin.Interceptor;
import org.apache.ibatis.plugin.Intercepts;
import org.apache.ibatis.plugin.Invocation;
import org.apache.ibatis.plugin.Plugin;
import org.apache.ibatis.plugin.Signature;
import org.springframework.stereotype.Component;

import java.util.Map;
import java.util.Properties;

/**
 * 全局拦截数据库创建和更新
 * <p>
 * Signature 对应 Invocation 构造器, type 为 Invocation.Object, method 为 Invocation.Method, args 为 Invocation.Object[]
 * method 对应的 update 包括了最常用的 insert/update/delete 三种操作, 因此 update 本身无法直接判断sql为何种执行过程
 * args 包含了其余多有的操作信息, 按数组进行存储, 不同的拦截方式有不同的参数顺序, 具体看type接口的方法签名, 然后根据签名解析, 参见官网
 *
 * @link http://www.mybatis.org/mybatis-3/zh/configuration.html#plugins 插件
 * <p>
 * MappedStatement 包括了SQL具体操作类型, 需要通过该类型判断当前sql执行过程
 */
@Component
@Intercepts({
    @Signature(type = Executor.class, method = "update", args = {MappedStatement.class, Object.class})
})
@Slf4j
public class NormalPlugin implements Interceptor {

  @Override
  @SuppressWarnings("unchecked")
  public Object intercept(Invocation invocation) throws Throwable {
    // 根据签名指定的args顺序获取具体的实现类
    // 1. 获取MappedStatement实例, 并获取当前SQL命令类型
    MappedStatement ms = (MappedStatement) invocation.getArgs()[0];
    SqlCommandType commandType = ms.getSqlCommandType();

    // 2. 获取当前正在被操作的类, 有可能是Java Bean, 也可能是普通的操作对象, 比如普通的参数传递
    // 普通参数, 即是 @Param 包装或者原始 Map 对象, 普通参数会被 Mybatis 包装成 Map 对象
    // 即是 org.apache.ibatis.binding.MapperMethod$ParamMap
    Object parameter = invocation.getArgs()[1];
    // 获取拦截器指定的方法类型, 通常需要拦截 update
    String methodName = invocation.getMethod().getName();
    log.info("NormalPlugin, methodName; {}, commandType: {}", methodName, commandType);

    // 3. 获取当前用户信息
    UserEntity userEntity = UserUtil.getCurrentUser();
    // 默认测试参数值
    int creator = 2, updater = 3;

    if (parameter instanceof BaseEntity) {
      // 4. 实体类
      BaseEntity entity = (BaseEntity) parameter;
      if (userEntity != null) {
        creator = entity.getCreator();
        updater = entity.getUpdater();
      }
      if (methodName.equals("update")) {
        if (commandType.equals(SqlCommandType.INSERT)) {
          entity.setCreator(creator);
          entity.setUpdater(updater);
          entity.setCreateTime(DateUtil.getTimeStamp());
          entity.setUpdateTime(DateUtil.getTimeStamp());
        } else if (commandType.equals(SqlCommandType.UPDATE)) {
          entity.setUpdater(updater);
          entity.setUpdateTime(DateUtil.getTimeStamp());
        }
      }
    } else if (parameter instanceof Map) {
      // 5. @Param 等包装类
      // 更新时指定某些字段的最新数据值
      if (commandType.equals(SqlCommandType.UPDATE)) {
        // 遍历参数类型, 检查目标参数值是否存在对象中, 该方式需要应用编写有一些统一的规范
        // 否则均统一为实体对象, 就免去该重复操作
        Map map = (Map) parameter;
        if (map.containsKey("creator")) {
          map.put("creator", creator);
        }
        if (map.containsKey("updateTime")) {
          map.put("updateTime", DateUtil.getTimeStamp());
        }
      }
    }
    // 6. 均不是需要被拦截的类型, 不做操作
    return invocation.proceed();
  }

  @Override
  public Object plugin(Object target) {
    return Plugin.wrap(target, this);
  }

  @Override
  public void setProperties(Properties properties) {
  }
}

6. 感受

其它几种类型,后面在看,尤其是分页。

在编写代码的过程中,有时候还是需要先知道对象的类型,比如 Object.class 跟 Interface 一样,很多时候仅仅代表一种数据类型,需要明确知道后再进行操作。

@Param 标识的参数其实会被 Mybatis 封装成 org.apache.ibatis.binding.MapperMethod$ParamMap 类型,一开始我就是使用

for (Field field:parameter.getClass().getDeclaredFields()) {

}

的方式获取,以为这些都是对象的属性,通过反射获取并修改即可,实际上发现对象不存在这些属性,但是打印出的信息中,明确有这些字段的,网上参考一些信息后,才知道这是一个 Map 类型,问题才迎刃而解。

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

相关文章

  • Hutool开发MapUtil工具类使用示例

    Hutool开发MapUtil工具类使用示例

    这篇文章主要为大家介绍了Hutool开发MapUtil工具类使用示例详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2022-10-10
  • Gradle jvm插件系列教程之Java Library插件权威详解

    Gradle jvm插件系列教程之Java Library插件权威详解

    这篇文章主要介绍了Java Library插件权威详解,本文通过示例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友参考下吧
    2024-01-01
  • SpringBoot自定义转换器应用实例讲解

    SpringBoot自定义转换器应用实例讲解

    SpringBoot在响应客户端请求时,将提交的数据封装成对象时,使用了内置的转换器,SpringBoot 也支持自定义转换器,这个内置转换器在 debug的时候,可以看到,提供了124个内置转换器
    2022-08-08
  • JAVA时间存储类Period和Duration使用详解

    JAVA时间存储类Period和Duration使用详解

    这篇文章主要为大家介绍了JAVA时间存储类Period和Duration使用详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2022-09-09
  • java Object类中常用API分享

    java Object类中常用API分享

    Object类是java中所有类的祖宗类,因此java中所有的类的对象都可以直接使用Object类中提供的一些方法,下面小编为大家整理了Object类中常用API,希望对大家有所帮助
    2023-10-10
  • java web图片上传和文件上传实例详解

    java web图片上传和文件上传实例详解

    这篇文章主要介绍了java web图片上传和文件上传实例详解的相关资料,这里提供了两种方法及示例代码,需要的朋友可以参考下
    2016-11-11
  • Spring动态数据源实现读写分离详解

    Spring动态数据源实现读写分离详解

    这篇文章主要为大家详细介绍了Spring动态数据源实现读写分离,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2017-07-07
  • Java日期工具类DateUtils实例详解

    Java日期工具类DateUtils实例详解

    这篇文章主要为大家详细介绍了Java日期工具类DateUtils实例,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2017-12-12
  • Java设计模式中的工厂模式详解

    Java设计模式中的工厂模式详解

    这篇文章主要介绍了Java设计模式中的工厂模式详解,工厂方法模式(Factory Method Pattern):创新型模式之一,简称工厂模式,通过定义工厂父类负责定义创建对象的公共接口,而子类则负责生成具体的对象,需要的朋友可以参考下
    2023-09-09
  • 关于Eureka的概念作用以及用法详解

    关于Eureka的概念作用以及用法详解

    这篇文章主要介绍了关于Eureka的概念作用以及用法详解,服务治理就是提供了微服务架构中各微服务实例的快速上线或下线且保持各服务能正常通信的能力的方案总称,需要的朋友可以参考下
    2023-05-05

最新评论