新重构一套系统发现只是单租户,现在由于业务需要将单租户升级到多租户,脑袋一下就大了,所有的数据操作都要加上租户Id,涉及整个工程都要进行调整,琢磨了一下午,看有没有什么办法可以减少工作量,能够尽可能的复用现有的代码,底层基础工程架构为spring-cloud mybatis ,思来想去最后发现可以通过自定义mybatis拦截器在数据操作前进行拦截,加上租户Id这样我现有的工程代码都无需做大的改变,只需要在自定义个filter拦截到租户Id后传递到自定义的拦截器上就可以实现我的要求。思路有了就开始撸代码。
首先先了解一下mybatis自定义拦截器,mybatis的拦截器需要实现接口Interceptor.java 该接口有三个方法
/**
*拦截需要处理方法,处理自定义逻辑
*/
Object intercept(Invocation var1) throws Throwable;
/**
*返回构建的拦截器
*/
Object plugin(Object var1);
/**
*设置属性
*/
void setProperties(Properties var1);
实现类需要添加注解
@Intercepts({@Signature(type = StatementHandler.class, method = "query", args = {Statement.class, ResultHandler.class}),
@Signature(type = StatementHandler.class, method = "update", args = {Statement.class}),
@Signature(type = StatementHandler.class, method = "batch", args = { Statement.class })})
说明一下@Signature是方法签名也就是需要拦截的类,方法,和参数目前只支持一下几个类和相关方法
StatementHandler (prepare, parameterize, batch, update, query)
ResultSetHandler (handleResultSets, handleOutputParameters)
ParameterHandler (getParameterObject, setParameters)
Executor (update, query, flushStatements, commit, rollback,getTransaction, close, isClosed)
一般我们采用mybatis进行数据库操作默认都是用sql语句预编译模式
那么我们需要拦截StatementHandler 的prepare 即可,接下来看一个具体的列子
import org.apache.ibatis.executor.Executor;
import org.apache.ibatis.executor.statement.RoutingStatementHandler;
import org.apache.ibatis.executor.statement.StatementHandler;
import org.apache.ibatis.plugin.*;
import org.apache.ibatis.session.ResultHandler;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;
import java.sql.Statement;
import java.util.Properties;
/**
* Created by apple on 2018/10/6.
*/
@Intercepts({@Signature(type = StatementHandler.class, method = "query", args = {Statement.class, ResultHandler.class}),
@Signature(type = StatementHandler.class, method = "update", args = {Statement.class}),
@Signature(type = StatementHandler.class, method = "batch", args = { Statement.class })})
@Component
public class EntPluginInterceptor implements Interceptor {
private static final Logger LOGGER = LoggerFactory.getLogger(EntPluginInterceptor.class);
@Override
public Object intercept(Invocation invocation){
// 开始时间
long start = System.currentTimeMillis();
invocation.getArgs();
try {
LOGGER.info("------------TNT----------");
RoutingStatementHandler handler = (RoutingStatementHandler) invocation.getTarget();
String sql = handler.getBoundSql().getSql();
return invocation.proceed();
} catch (Exception e) {
LOGGER.error("执行失败!", e);
return null;
} finally {
long end = System.currentTimeMillis();
long time = end - start;
LOGGER.info("cost time {}ms", time);
}
}
@Override
public Object plugin(Object arg0) {
return Plugin.wrap(arg0, this);
}
@Override
public void setProperties(Properties arg0) {
}
}
String sql = handler.getBoundSql().getSql();
拿到的就是我们需要进行拦截的sql语句,我们通过对sql语句进行自定义逻辑修改,然后再赋值回去即可达成我们的目的。但是了BoundSql类没有提供sql 的set方法,但是这个拦不到我们直接反射就可了。
拦截器自定义完成后在springcloud中直接通过@component在工程启动的时候实例化就可以了,这样我们就可以通过改动很少的代码将工程进行升级。当然了,可以根据自己的需要再添加一些其他的黑科技,例如添加一个白名单机制,就可以做到按照自己需要进行拦截了