SpringMVC中使用注解清除拦截器

本文描述的是在springmvc中，通过注解清除（跳过）拦截器，支持在Controller类级别或者方法级别来清除，可同时清除多个拦截器。

在开发web后台时，我们的接口一般都需要加权限控制。比如一个简单的场景：用户需要登录后才能访问，没登录就直接跳转登录界面或者返回特定的错误码。通常我们会配置一个拦截器，验证一下用户请求携带的token，如果验证通过就返回true. 这时候有这么一个需求：几乎所有的controller都需要拦截，但某几个Controller或者Controller里面的方法需要跳过拦截器，比如用户登录的接口和错误处理的接口，虽然这时候我们可以在配置烂机器的时候配置忽略路径，但这样不够灵活。前几天用注解实现了这一功能，这里做一个简单描述。

首先创建一个注解，内容很简单，value为一个包含要清除的拦截器的数组。

@Target({ElementType.METHOD,ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface Clear {
    Class<? extends HandlerInterceptor>[] value() default {};
}

接下来要在你的拦截器里面来获取当前请求对应的方法或者该方法所处的类上面是否有清除当前拦截器的注解。如果有就直接返回true。比如我有一个ApiInterceptor，主要代码如下：

public class ApiInterceptor implements HandlerInterceptor {

  //只列出主要代码
    @Override
    public boolean preHandle(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o) throws Exception {
        HandlerMethod m= (HandlerMethod) o;
        Method method=m.getMethod();
        //判断是否用注解清除
        if(clearedByAnnotation(method)){
            return true;
        }
      
        //其他操作，比如验证token

        httpServletResponse.sendRedirect("/api/error/401");
        return false;
    }

    private boolean clearedByAnnotation(Method method){
        Clear clear=method.getAnnotation(Clear.class);
        if(clear!=null){
            if(Arrays.asList(clear.value()).contains(ApiInterceptor.class)){
                return true;
            }
        }
        Class clazz=method.getDeclaringClass();
        clear= (Clear) clazz.getDeclaredAnnotation(Clear.class);
        if(clear!=null){
            if(Arrays.asList(clear.value()).contains(ApiInterceptor.class)){
                return true;
            }
        }
        return false;
    }
}

然后，在使用的时候，我们只需要在Controller或者Controller里面的方法上面加上Clear注解即可：

@RestController
@RequestMapping("/api/user")
public class UserApi {
  
  @PostMapping("/login/{code}")
  @Clear(ApiInterceptor.class)
  public Res doLogin(@PathVariable String code, HttpServletRequest req){
    // TODO
    return Res.ok;
  }
}

清除多个拦截器：

@RestController
@RequestMapping("/api/error")
@Clear({ApiInterceptor.class,AdminInterceptor.class})
public class ErrorApi {
  
  @RequestMapping("/{code}")
  public Res error(@PathVariable int code){
    return Res.fail.code(code);
  }
}

然后，就没有然后了，这样就ok了，虽然说代码多一点，但比起配置忽略路径要更灵活，最重要的是更能装X。然后补充一点，如果拦截器比较多的话，每个都这么配会比较繁琐，可以写一个BaseInterceptor, 然后其他拦截器继承就可以。

你说我是有多无聊，无聊到开始上班写博客玩了……