MyBatis如何通过拦截器修改SQL

开源字节

于 2024-05-15 14:57:13 发布

阅读量407

点赞数 3

文章标签： mybatis sql java 开源开源软件

本文链接：https://blog.csdn.net/qq_35634154/article/details/138908763

版权

假如我们想实现多租户，或者在某些SQL后面自动拼接查询条件。在开发过程中大部分场景可能都是一个查询写一个SQL去处理，我们如果想修改最终SQL可以通过修改各个mapper.xml中的SQL来处理。

但实际过程中我们可能穿插着ORM和SQL的混合使用，隐藏在代码中不容易被发现，还有假如项目中有很多很多的SQL我们不可能一一的去修改解决。

这个时候我们就需要通过mybatis拦截SQL并且最终修改SQL。具体操作如下：

一、实现Interceptor接口，并写相关逻辑

package cn.source.framework.interceptor.impl;

import cn.source.common.core.domain.BaseEntity;
import cn.source.common.core.domain.entity.SysUser;
import cn.source.common.utils.DateUtils;
import cn.source.common.utils.SecurityUtils;
import org.apache.ibatis.executor.Executor;
import org.apache.ibatis.mapping.MappedStatement;
import org.apache.ibatis.mapping.SqlCommandType;
import org.apache.ibatis.plugin.*;

import java.util.Properties;

/**
 * @Description: 自定义拦截器，注入创建人，创建日期，修改人，修改日期，企业id
 * @author: sourcebyte.vip
 * @date: 2023年10月18日 14:33
 */
@Intercepts({
   @Signature(
       type = Executor.class,
       method = "update",
       args = {MappedStatement.class, Object.class}),
})
public class HandleBaseInfoInterceptor implements Interceptor {

 @Override
 public Object intercept(Invocation invocation) throws Throwable {
   Object[] args = invocation.getArgs();
   MappedStatement mappedStatement = (MappedStatement) args[0];
   SqlCommandType sqlCommandType = mappedStatement.getSqlCommandType();
   // 用户类不处理，会导致获取不到用户信息出错
   if (args[1] instanceof SysUser) {
     return invocation.proceed();
   }
   if (args[1] instanceof BaseEntity) {
     BaseEntity baseEntity = (BaseEntity) args[1];
     if (sqlCommandType == SqlCommandType.UPDATE) {
       baseEntity.setUpdateTime(DateUtils.getNowDate());
       baseEntity.setUpdateBy(SecurityUtils.getUsername());
     } else if (sqlCommandType == SqlCommandType.INSERT) {
       baseEntity.setCreateTime(DateUtils.getNowDate());
       baseEntity.setCreateBy(SecurityUtils.getUsername());
       // System.out.println("赋值企业ID:" + baseEntity.getCompanyId());
       baseEntity.setCompanyId(SecurityUtils.getLoginUser().getUser().getCompanyId());
     }
   }
   return invocation.proceed();
 }

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

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

二、将插件注册到mybatis 的配置文件 mybatis-config.xml

<plugins>
  <!-- 自定义拦截器，注入企业id-->
  <plugin interceptor="cn.source.framework.interceptor.impl.HandleSelectInterceptor">   </plugin>
  <!-- 自定义拦截器，注入创建人，创建日期，修改人，修改日期，企业id-->
  <plugin interceptor="cn.source.framework.interceptor.impl.HandleBaseInfoInterceptor">  </plugin>
</plugins>