需求：
在执行某个动态sql时，where 子句，希望通过用户进行自定义查询条件，比如用户可以传入 “id > 100011 and name = '张三'” 的多条件表达式进行查询 (注意：这里的条件查询，为了安全性的考虑，是经过处理的，以免出现安全漏洞。)
方法：
1. 自定义mybatis的拦截器MySqlInterceptor（继承 org.apache.ibatis.plugin.Interceptor）对执行的mapper接口进行拦截
2. 改写对应 intercept()方法。
3. 添加到项目文件中，进行拦截器配置。
以下代码仅做参考学习使用。
自定义拦截器代码如下：
package com.hlyjy.zj.interceptor;
import net.sf.jsqlparser.expression.Expression;
import net.sf.jsqlparser.parser.CCJSqlParserUtil;
import org.apache.ibatis.binding.MapperMethod;
import org.apache.ibatis.executor.Executor;
import org.apache.ibatis.executor.statement.StatementHandler;
import org.apache.ibatis.mapping.BoundSql;
import org.apache.ibatis.mapping.MappedStatement;
import org.apache.ibatis.mapping.ParameterMapping;
import org.apache.ibatis.mapping.SqlSource;
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.slf4j.Logger;
import org.slf4j.LoggerFactory;
import java.util.Properties;
/**
* @author junzhou
* @date 2021/1/5 13:55
* @description: 自定义 MyBatis 拦截器
* 用于拦截 mapper 接口中的动态查询语句，只对 mapper 接口中的 searchByQuery 方法启作用
* @since 1.8
*/
@Intercepts({@Signature(type = Executor.class, method = "query",
args = {MappedStatement.class,
Object.class,
RowBounds.class,
ResultHandler.class})})
public class MySqlInterceptor implements Interceptor {
/**
* 日志记录器
*/
private static final Logger logger= LoggerFactory.getLogger(MySqlInterceptor.class);
/**
* intercept 方法用来对拦截的 sql 进行具体的操作
* 本拦截方法只对 mapper 接口中的 searchByQuery 方法进行拦截，实际每个方法都拦截了，
* 只是只有 searchByQuery 方法时，才真正执行 拦截的相关操作
* @param invocation 拦截器执行器
* @return
* @throws Throwable 异常信息
*/
@Override
public Object intercept(Invocation invocation) throws Throwable {
// logger.info("执行intercept方法：{}", invocation.toString());
// 获取 invocation 传递的参数
Object[] args = invocation.getArgs();
MappedStatement ms = (MappedStatement) args[0];
// 获取执行的该拦截器的全路径方法 比如你的 UserInfoMapper 接口的 getById 方法， com.xx.UserInfoMapper.getById
String id = ms.getId();
// 如果不是 searchByQuery 方法，就不进行相关的拦截操作
if (!filterMethodById(id)){
return invocation.proceed();
}
// 该参数类型 org.apache.ibatis.binding.MapperMethod$ParamMap
Object parameterObject = args[1];
// 获取传递的参数， 主要包含三个参数 1. 查询语句 searchQuery， 2. 查询偏移 pageOffset, 3. 查询每页的数据条数
MapperMethod.ParamMap paramMap = (MapperMethod.ParamMap) parameterObject;
// 对查询的条件进行重新拼接
// searchQuery 查询的条件
String searchQuery = "";
// pageOffset 分页查询的偏移
int pageOffset = 0 ;
// pageSize 分页查询页面大小，即每页多少条数据
int pageSize = 10;
// 取出各个参数并赋值
if (paramMap.containsKey("searchQuery")){
searchQuery = (String) paramMap.get("searchQuery");
}
if (paramMap.containsKey("pageOffset")){
pageOffset = (int) paramMap.get("pageOffset");
}
if (paramMap.containsKey("pageSize")){
pageSize = (int) paramMap.get("pageSize");
}
BoundSql boundSql = ms.getBoundSql(parameterObject);
// 获取原始查询的 sql 语句
String origSql = boundSql.getSql();
logger.error("原始SQL: {}", origSql);
// 构建新的 sql 语句， 将 where 条件和 limit 条件加入
String newSql = null;
// 如果存在条件查询则 拼接条件，如果不存在，则只添加分页限制
if (!searchQuery.equals("")){
newSql = origSql +" WHERE " + searchQuery + " LIMIT " + pageSize + " OFFSET " + pageOffset;
}else {
newSql = origSql + " LIMIT " + pageSize + " OFFSET " + pageOffset;
}
// 重新new一个查询语句对象
BoundSql newBoundSql = new BoundSql(ms.getConfiguration(), newSql,
boundSql.getParameterMappings(), boundSql.getParameterObject());
// 把新的查询放到 statement 里
MappedStatement newMs = newMappedStatement(ms, new MySqlInterceptor.BoundSqlSqlSource(newBoundSql));
for (ParameterMapping mapping : boundSql.getParameterMappings()) {
String prop = mapping.getProperty();
if (boundSql.hasAdditionalParameter(prop)) {
newBoundSql.setAdditionalParameter(prop, boundSql.getAdditionalParameter(prop));
}
}
// 修改 MappedStatement
Object[] queryArgs = invocation.getArgs();
queryArgs[0] = newMs;
logger.info("拦截了 " + id + " 相关执行。");
return invocation.proceed();
}
/**
* 定义一个内部辅助类，作用是包装 SQL
*/
class BoundSqlSqlSource implements SqlSource {
private BoundSql boundSql;
public BoundSqlSqlSource(BoundSql boundSql) {
this.boundSql = boundSql;
}
@Override
public BoundSql getBoundSql(Object parameterObject) {
return boundSql;
}
}
/**
* 根据获取到执行 id 找到对应的方法，只在 searchByQuery 方法上执行拦截
* @param id 根据 MappedStatement 获取到的 id 属性
* @return 是否是 searchByQuery 方法
*/
private boolean filterMethodById(String id){
System.out.println("id: " + id);
String[] names = id.split("\\.");
System.out.println("names: " + names.length);
return names[names.length - 1].equals("searchByQuery");
}
private MappedStatement newMappedStatement (MappedStatement ms, SqlSource newSqlSource) {
MappedStatement.Builder builder = new
MappedStatement.Builder(ms.getConfiguration(), ms.getId(), newSqlSource, ms.getSqlCommandType());
builder.resource(ms.getResource());
builder.fetchSize(ms.getFetchSize());
builder.statementType(ms.getStatementType());
builder.keyGenerator(ms.getKeyGenerator());
if (ms.getKeyProperties() != null && ms.getKeyProperties().length > 0) {
builder.keyProperty(ms.getKeyProperties()[0]);
}
builder.timeout(ms.getTimeout());
builder.parameterMap(ms.getParameterMap());
builder.resultMaps(ms.getResultMaps());
builder.resultSetType(ms.getResultSetType());
builder.cache(ms.getCache());
builder.flushCacheRequired(ms.isFlushCacheRequired());
builder.useCache(ms.isUseCache());
return builder.build();
}
/***
* 定义拦截的类 Executor、ParameterHandler、StatementHandler、ResultSetHandler当中的一个
* @param target 需要拦截的类
* @return
*/
@Override
public Object plugin(Object target) {
if (target instanceof Executor) {
return Plugin.wrap(target, this);
}
return target;
}
/**
* 属性相关操作
* 设置和自定义属性值
* @param properties 属性值
*/
@Override
public void setProperties(Properties properties) {
// 获取属性
// String value1 = properties.getProperty("prop1");
}
}
配置类：
package com.hlyjy.zj.config;
import com.github.pagehelper.autoconfigure.PageHelperAutoConfiguration;
import com.hlyjy.hbase.Interceptor.MySqlInterceptor;
import org.apache.ibatis.session.SqlSessionFactory;
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.List;
import java.util.Properties;
@Configuration
@AutoConfigureAfter(PageHelperAutoConfiguration.class)
public class MyBatisConfig {
@Autowired
private List<SqlSessionFactory> sqlSessionFactoryList;
@PostConstruct
public void addMySqlInterceptor() {
MySqlInterceptor interceptor = new MySqlInterceptor();
for (SqlSessionFactory sqlSessionFactory : sqlSessionFactoryList) {
sqlSessionFactory.getConfiguration().addInterceptor(interceptor);
}
}
}在resource目录下新建META-INF目录，然后添加spring.factories文件，其中内容如下：
# Auto Configure
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
com.github.pagehelper.autoconfigure.PageHelperAutoConfiguration,\
com.hlyjy.zj.config.MyBatisConfig # 其中 com.hlyjy.zj.config 为你自己配置类的包名，MyBatisConfig 为我的配置类名 如有不足之处，欢迎大家交流学习。