使用mybatis的interceptor修改執行sql以及傳入參數方式

mybatis interceptor修改執行sql以及傳入參數

項目中途遇到業務需求更改,在查詢某張表時需要增加條件,由於涉及的sql語句多而且依賴其他服務的jar,逐個修改sql語句和接口太繁雜。項目使用mybatis框架,因此借鑒PageHelper插件嘗試使用mybatis的Interceptor來實現改需求。

總體思路

  • 從BoundSql中獲取sql,通過正則匹配替換表名為子查詢REPLACE_TXT
  • 添加子查詢REPLACE_TXT 中需要用到的參數到mybatis參數列表中
  • 添加參數與占位符映射,即添加ParameterMapping對象到ParameterMappings中,由於statement在執行時是按照ParameterMappings的元素索引定位占位符封裝參數(即ParameterMappings中的第一個參數會封裝到第一個占位符上),因此ParameterMappings中的參數順序需要和占位符保持一致。其次ParameterMappings的元素個數需要和占位符個數保持一致。
  • 為瞭保證該intercept在最後執行,使用AutoConfiguration將intercept添加到SqlSessionFactory的Configuration中,並在spring.factories文件中添加AutoConfiguration
  • 未測試性能以及是否存在未知缺陷

1、Interceptor 代碼實現

package org.cnbi.project.other.sql.intercept;
import cn.hutool.core.util.NumberUtil;
import com.cnbi.cloud.common.core.exception.ServiceException;
import com.github.pagehelper.Page;
import com.github.pagehelper.util.ExecutorUtil;
import com.github.pagehelper.util.MetaObjectUtil;
import org.apache.ibatis.builder.annotation.ProviderSqlSource;
import org.apache.ibatis.cache.CacheKey;
import org.apache.ibatis.executor.Executor;
import org.apache.ibatis.mapping.BoundSql;
import org.apache.ibatis.mapping.MappedStatement;
import org.apache.ibatis.mapping.ParameterMapping;
import org.apache.ibatis.plugin.*;
import org.apache.ibatis.reflection.MetaObject;
import org.apache.ibatis.session.ResultHandler;
import org.apache.ibatis.session.RowBounds;
import org.cnbi.project.other.sql.aop.PeriodHolder;
import java.util.*;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
/**
 * @ClassName ParamInterceptor
 * @Description 修改接口太繁瑣,直接用mybatis攔截器對查詢sql進行攔截,將期間參數註入sql
 * @Author Wangjunkai
 * @Date 2019/10/23 11:36
 **/
@Intercepts({
        @Signature(type = Executor.class, method = "query", args = {MappedStatement.class, Object.class, RowBounds.class, ResultHandler.class}),
        @Signature(type = Executor.class, method = "query", args = {MappedStatement.class, Object.class, RowBounds.class, ResultHandler.class, CacheKey.class, BoundSql.class})
}
)
public class ParamInterceptor implements Interceptor {
    private final static Pattern DW_DIMCOMPANY = Pattern.compile("dw_dimcompany", Pattern.CASE_INSENSITIVE);
    private final static String REPLACE_TXT = "(select * from dw_dimcompany where cisdel = '0' and START_PERIOD <= ? and END_PERIOD > ?)";
    @Override
    public Object intercept(Invocation invocation) throws Throwable {
        Object[] args = invocation.getArgs();
        MappedStatement ms = (MappedStatement) args[0];
        Object parameter = args[1];
        RowBounds rowBounds = (RowBounds) args[2];
        ResultHandler resultHandler = (ResultHandler) args[3];
        Executor executor = (Executor) invocation.getTarget();
        CacheKey cacheKey;
        BoundSql boundSql;
        if(args.length == 4){
            boundSql = ms.getBoundSql(parameter);
        } else {
            boundSql = (BoundSql) args[5];
        }
        //獲取sql語句,使用正則忽略大小寫匹配
        String sql = boundSql.getSql();
        Matcher matcher = DW_DIMCOMPANY.matcher(sql);
        //沒有需要替換的表名則放行
        if(!matcher.find()){
            return invocation.proceed();
        }
       //收集占位符個數(即paramIndex 的size)以及占位符次序(slot:即參數在ParameterMappings中的順序)
        int index = 0;
        ArrayList<Integer> paramIndex = new ArrayList<>();
        while(matcher.find(index)){
            index = matcher.end();
            String sqlPart = sql.substring(0, index);
            int slot = index - sqlPart.replace("?", "").length() + paramIndex.size() ;
            paramIndex.add(slot);
            paramIndex.add(slot + 1);
        }
        //替換子查詢
        String companyPeriodSql = matcher.replaceAll(REPLACE_TXT);
        cacheKey = args.length == 4 ? executor.createCacheKey(ms, parameter, rowBounds, boundSql) : (CacheKey) args[4];
        //處理參數
        Object parameterObject = processParameterObject(ms, parameter, boundSql, cacheKey, paramIndex);
        BoundSql companyPeriodBoundSql = new BoundSql(ms.getConfiguration(), companyPeriodSql, boundSql.getParameterMappings(), parameterObject);
        Map<String, Object> additionalParameters = ExecutorUtil.getAdditionalParameter(boundSql);
        //設置動態參數
        for (String key : additionalParameters.keySet()) {
            companyPeriodBoundSql.setAdditionalParameter(key, additionalParameters.get(key));
        }
        return executor.query(ms, parameterObject, RowBounds.DEFAULT, resultHandler, cacheKey, companyPeriodBoundSql);
    }
    public Object processParameterObject(MappedStatement ms, Object parameterObject, BoundSql boundSql, CacheKey pageKey, ArrayList<Integer> paramIndex) {
        //處理參數
        Map<String, Object> paramMap = null;
        if (parameterObject == null) {
            paramMap = new HashMap<>();
        } else if (parameterObject instanceof Map) {
            //解決不可變Map的情況
            paramMap = new HashMap<>();
            paramMap.putAll((Map) parameterObject);
        } else {
            paramMap = new HashMap<>();
            // sqlSource為ProviderSqlSource時,處理隻有1個參數的情況
            if (ms.getSqlSource() instanceof ProviderSqlSource) {
                String[] providerMethodArgumentNames = ExecutorUtil.getProviderMethodArgumentNames((ProviderSqlSource) ms.getSqlSource());
                if (providerMethodArgumentNames != null && providerMethodArgumentNames.length == 1) {
                    paramMap.put(providerMethodArgumentNames[0], parameterObject);
                    paramMap.put("param1", parameterObject);
                }
            }
            //動態sql時的判斷條件不會出現在ParameterMapping中,但是必須有,所以這裡需要收集所有的getter屬性
            //TypeHandlerRegistry可以直接處理的會作為一個直接使用的對象進行處理
            boolean hasTypeHandler = ms.getConfiguration().getTypeHandlerRegistry().hasTypeHandler(parameterObject.getClass());
            MetaObject metaObject = MetaObjectUtil.forObject(parameterObject);
            //需要針對註解形式的MyProviderSqlSource保存原值
            if (!hasTypeHandler) {
                for (String name : metaObject.getGetterNames()) {
                    paramMap.put(name, metaObject.getValue(name));
                }
            }
            //下面這段方法,主要解決一個常見類型的參數時的問題
            if (boundSql.getParameterMappings() != null && boundSql.getParameterMappings().size() > 0) {
                for (ParameterMapping parameterMapping : boundSql.getParameterMappings()) {
                    String name = parameterMapping.getProperty();
                    if (!name.equals(GLOBALPERIOD)
                            && paramMap.get(name) == null) {
                        if (hasTypeHandler
                                || parameterMapping.getJavaType().equals(parameterObject.getClass())) {
                            paramMap.put(name, parameterObject);
                            break;
                        }
                    }
                }
            }
        }
        return processPageParameter(ms, paramMap, boundSql, pageKey, paramIndex);
    }
    private final static String GLOBALPERIOD = "globalPeriod";
    public Object processPageParameter(MappedStatement ms, Map<String, Object> paramMap, BoundSql boundSql, CacheKey pageKey, ArrayList<Integer> paramIndex) {
        paramMap.put(GLOBALPERIOD, getPeriod());
        //處理pageKey
        pageKey.update(getPeriod());
        //處理參數配置
        handleParameter(boundSql, ms, paramIndex);
        return paramMap;
    }
    protected void handleParameter(BoundSql boundSql, MappedStatement ms,  ArrayList<Integer> paramIndex) {
        if (boundSql.getParameterMappings() != null) {
            List<ParameterMapping> newParameterMappings = new ArrayList<>(boundSql.getParameterMappings());
            for (Integer index : paramIndex) {
                if(index < newParameterMappings.size()) {
                    newParameterMappings.add(index, new ParameterMapping.Builder(ms.getConfiguration(), GLOBALPERIOD, String.class).build());
                }else{
                    newParameterMappings.add(new ParameterMapping.Builder(ms.getConfiguration(), GLOBALPERIOD, String.class).build());
                }
            }
            MetaObject metaObject = MetaObjectUtil.forObject(boundSql);
            metaObject.setValue("parameterMappings", newParameterMappings);
        }
    }
    private final static String Q = "Q";
    private final static String H = "H";
    private String getPeriod(){
        //使用threadlocal保存從request中獲取的參數,此處不再描述
        String period = PeriodHolder.getPeriod();
        if(NumberUtil.isNumber(period)){
            return period;
        }else if(period.contains(Q)){
            return period.substring(0, 4) + Integer.parseInt(period.substring(5)) * 3;
        }else if(period.contains(H)){
            return period.substring(0, 4) + Integer.parseInt(period.substring(5)) * 6;
        }else{
            throw new ServiceException("非法期間:" + period);
        }
    }
    @Override
    public Object plugin(Object target) {
        return Plugin.wrap(target, this);
    }
    @Override
    public void setProperties(Properties properties) {
        //nothing to do...
    }
}

2、AutoConfiguration代碼實現

package org.cnbi.project.autoconfig;
import com.github.pagehelper.autoconfigure.PageHelperAutoConfiguration;
import org.apache.ibatis.session.SqlSessionFactory;
import org.cnbi.project.other.sql.intercept.ParamInterceptor;
import org.mybatis.spring.boot.autoconfigure.MybatisAutoConfiguration;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.autoconfigure.AutoConfigureAfter;
import org.springframework.context.annotation.Configuration;
import javax.annotation.PostConstruct;
import java.util.Iterator;
import java.util.List;
/**
 * @ClassName ParamIntecepterAutoConfiguration
 * @Description
 * @Author Wangjunkai
 * @Date 2019/10/23 15:41
 **/
@AutoConfigureAfter({MybatisAutoConfiguration.class, PageHelperAutoConfiguration.class})
@Configuration
public class ParamIntecepterAutoConfiguration {
    @Autowired
    private List<SqlSessionFactory> sqlSessionFactoryList;
    public ParamIntecepterAutoConfiguration() {
    }
    @PostConstruct
    public void addParamInterceptor() {
        ParamInterceptor interceptor = new ParamInterceptor();
        Iterator var3 = this.sqlSessionFactoryList.iterator();
        while(var3.hasNext()) {
            SqlSessionFactory sqlSessionFactory = (SqlSessionFactory)var3.next();
            sqlSessionFactory.getConfiguration().addInterceptor(interceptor);
        }
    }
}

mybatis interceptor處理查詢參數及查詢結果

攔截器:攔截update,query方法

處理查詢參數及返回結果。

/**
 * Created by windwant on 2017/1/12.
 */
@Intercepts({
        @Signature(type=Executor.class,method="update",args={MappedStatement.class,Object.class}),
        @Signature(type=Executor.class,method="query",args={MappedStatement.class,Object.class,RowBounds.class,ResultHandler.class})
})
public class EncryptInterceptor implements Interceptor {
    public static final Logger logger = LoggerFactory.getLogger(EncryptInterceptor.class);
 
 
    @Override
    public Object intercept(Invocation invocation) throws Throwable {
        dealParameter(invocation);
        Object returnValue = invocation.proceed();
        dealReturnValue(returnValue);
        return returnValue;
    }
 
    //查詢參數加密處理
    private void dealParameter(Invocation invocation) {
        MappedStatement statement = (MappedStatement) invocation.getArgs()[0];
        String mapperl = ConfigUtils.get("mybaits.mapper.path");
        String methodName = statement.getId().substring(statement.getId().indexOf(mapperl) + mapperl.length() + 1);
        if (methodName.startsWith("UserBaseMapper")){
            if(methodName.equals("UserBaseMapper.updateDriver")){
                ((Driver) invocation.getArgs()[1]).encrypt();
            }
        }
        logger.info("Mybatis Encrypt parameters Interceptor, method: {}, args: {}", methodName, invocation.getArgs()[1]);
    }
 
    //查詢結果解密處理
    private void dealReturnValue(Object returnValue){
        if(returnValue instanceof ArrayList<?>){
            List<?> list = (ArrayList<?>)returnValue;
            for(Object val: list){
                if(val instanceof Passenger){///
                    //TODO
                }
                logger.info("Mybatis Decrypt result Interceptor, result object: {}", ToStringBuilder.reflectionToString(val));
            }
        }
    }
 
    @Override
    public Object plugin(Object target) {
        return Plugin.wrap(target, this);
    }
 
    @Override
    public void setProperties(Properties properties) {
 
    }
}

添加xml配置

<bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
              <property name="typeAliasesPackage" value="com.xx.model"/>
              <property name="dataSource" ref="dataSource"/>
              <!-- 自動掃描mapping.xml文件 -->
              <property name="mapperLocations" value="classpath*:mybatis/*.xml"></property>
              <property name="plugins">//攔截器插件
                     <array>
                            <bean class="com.github.pagehelper.PageHelper">
                                   <property name="properties">
                                          <value>dialect=hsqldb</value>
                                   </property>
                            </bean>
                            <bean class="com.xx.interceptor.EncryptInterceptor">
                                   <property name="properties">
                                          <value>property-key=property-value</value>
                                   </property>
                            </bean>
                     </array>
              </property>
       </bean>

以上為個人經驗,希望能給大傢一個參考,也希望大傢多多支持WalkonNet。

推薦閱讀: