自定义注解与拦截器实现不规范sql拦截（拦截器实现篇）

最近考虑myBatis中sql语句使用规范的问题，如果漏下条件或者写一些不规范语句会对程序性能造成很大影响。最好的方法就是利用代码进行限制，通过拦截器进行sql格式的判断在自测环节就能找到问题。写了个简单情景下的demo，并通过idea插件来将myBatis的mapper方法都打上拦截器判断的注解，多少自动化一点。

需求简介

使用myBatis拦截器对Mapper的sql进行判断，对增加了自定义注解修饰的方法进行where条件的判断，存在where子句再执行，否则抛出异常。

具体实现

自定义注解

// 标志注解，用来表示mapper方法需要经过where条件存在与否的判断
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface WhereConditionCheck {
}

限定method修饰，同时指定runtime，以在运行过程中判断是否被该注解修饰。

拦截器实现类

WhereConditionInterceptor拦截器判断类

@Intercepts({// 拦截query方法@Signature(type = Executor.class, method = "query",args = {MappedStatement.class, Object.class, RowBounds.class, ResultHandler.class}),@Signature(type = Executor.class,method = "update",args = {MappedStatement.class, Object.class})
})
@Component
@Slf4j
// 利用myBatis拦截器去获取对应的语句，where条件放行，无where阻止
public class WhereConditionInterceptor implements Interceptor {

首先利用@Intercepters注解，定义拦截器拦截的方法。这些方法来自Mybatis执行时调用的Executor接口的实现类，并通过args参数的设置来唯一指定同名的重载方法。

    @Overridepublic Object intercept(Invocation invocation) throws Throwable {// 获取sql信息MappedStatement mappedStatement = (MappedStatement) invocation.getArgs()[0];Object parameter = invocation.getArgs()[1]; // 参数BoundSql sql = mappedStatement.getBoundSql(parameter);// 获取原始调用方法的注解信息String id = mappedStatement.getId();String className = id.substring(0, id.lastIndexOf("."));String methodName = id.substring(id.lastIndexOf(".") + 1);Method[] methods = Class.forName(className).getMethods();// 不考虑方法重载for(Method method:methods){if(method.getName().equals(methodName) && method.isAnnotationPresent(WhereConditionCheck.class)){// 执行拦截boolean checkResult = checkIfWhereExist(sql);if(!checkResult){// 根据sql类型判断抛出异常的语句SqlCommandType sqlCommandType = mappedStatement.getSqlCommandType();if(sqlCommandType.equals(SqlCommandType.SELECT)) {log.error("query error, sql='" + sql.getSql() + "''");throw new RuntimeException("Query methods must contain where condition. method:" + id);} else if(sqlCommandType.equals(SqlCommandType.DELETE)) {log.error("delete error, sql='" + sql.getSql()  + "''");throw new RuntimeException("Delete methods must contain where condition. method:" + id);}}}}return invocation.proceed();}

重写intercept方法，利用invocation来获取之前定义的拦截方法的具体参数对象，利用第一个参数MappedStatement对象来获取具体的sql信息。需要注意的是，为了获取原Mapper接口中定义方法的注解信息，我们需要利用getId获取完整的接口名和类名，并利用反射获取对应的方法对象，以判断对应方法是否存在@WhereConditionCheck注解。

    private boolean checkIfWhereExist(BoundSql sql){String sqlStr = sql.getSql();sqlStr = sqlStr.toUpperCase();return sqlStr.contains("WHERE");}

具体的判断就直接将字符串转成大写后进行匹配即可。

简单使用

Mapper接口

@Mapper
public interface UserMapper {@Select("select * from user where code = #{code}")@WhereConditionCheckpublic User findUserByCode(String code);@Select("select * from user")// 全量查询，需要拦截@WhereConditionCheckpublic List<User> findUserListWhole();

简单设置两个方法，where子句和全量查询。

controller

@Controller
@RequestMapping("/user")
public class WhereConditionCheckController {@AutowiredUserMapper userMapper;@ResponseBody@RequestMapping("/queryWhole")// 全量查询public String getWholeUser(){try {List<User> userList = userMapper.findUserListWhole();return JSONObject.toJSONString(userList);}catch(Exception ex){// 获取异常栈最底层以显示自定义信息Throwable cause = ex;Throwable result = null;while(cause != null){result = cause;cause = cause.getCause();}return result.getMessage();}}@ResponseBody@RequestMapping("/queryByCode")// where查询public String getUser(String code){try{User user = userMapper.findUserByCode(code);return JSONObject.toJSONString(user);}catch(Exception ex){/// 获取异常栈最底层以显示自定义信息Throwable cause = ex;Throwable result = null;while(cause != null){result = cause;cause = cause.getCause();}return result.getMessage();}}
}