Resultful API的拦截（拦截器——Interceptor）

一、Resultful API的拦截三种方式

• 过滤器(Filter)
• 拦截器(Interceptor)
• 切片(Aspect)

二、拦截器(Interceptor)的演示示例（springboot项目）

1、自定义一个名称为TimeInterceptor的拦截器，代码如下：

package com.xz.springsecuritydemo.interceptor;
import org.springframework.stereotype.Component;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.util.Date;
@Component//需要声明@Component注解，并需要额外配置,lz写的WebInterceptorConfig配置
public class TimeInterceptor implements HandlerInterceptor {
    //在控制器方法（即controller类中的方法）调用之前调用
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println("preHandle");
        System.out.println(handler.getClass().getName());//获取类名
        request.setAttribute("startTime",new Date().getTime());
        return true;//返回为flase表示后面的方法不执行
    }
    //控制器方法抛出异常，postHandle方法不会被调用
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        System.out.println("postHandle");
        //从preHandle方法的请求中获取的开始时间
        long startTime= (long) request.getAttribute("startTime");
        System.out.println("interceptor耗时："+(new Date().getTime()-startTime));
    }
    //在控制器方法调用之后调用
    //控制器方法抛出异常，afterCompletion方法仍然会被调用
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        System.out.println("afterCompletion");
    }
}

2、自定义一个Interceptor拦截器的配置类，代码如下：

package com.xz.springsecuritydemo.interceptor;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
/**
 * @description:此配置类需要实现WebMvcConfigurer接口，并实现addInterceptors方法进行注册拦截器
 * @author: xz
 */
@Configuration
public class WebInterceptorConfig implements WebMvcConfigurer {

    @Autowired
    private TimeInterceptor timeInterceptor;
	//注册拦截器
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(timeInterceptor);
    }
}

3、自定义一个控制类，代码如下：

@RestController//表示此Controller提供RestAPI
public class SysQueryController {
   /**
     * @RequestMapping  映射http请求url到java方法
     * @RequestParam    映射请求参数到java方法的参数
     */
    @RequestMapping(value = "/user1",method = RequestMethod.GET)
    public void query1(@RequestParam String username){
        System.out.println("query1====="+username);
    }
 }

4、测试步骤

• 启动项目，如下图：

• 再用postman测试工具发送请求，如下图：

• 最后查看控制态输出信息，如下图：

  //输出内容
  preHandle
  org.springframework.web.method.HandlerMethod
  query1=====xz
  postHandle
  interceptor耗时：26
  afterCompletion
  

  5、输出第4步的内容表示自定义的Interceptor拦截器成功。

三、Interceptor拦截器特点

• 由上面的示例可知：Interceptor拦截器即可以获取到原始的http请求和响应的信息，又可以获取到真正处理请求的方法信息。但是获取不到真正处理请求的方法的参数值

四、Filter过滤器、Interceptor拦截器 、Aspect切面 起作用的顺序

• 先是Filter过滤器起作用
• 然后Interceptor拦截器起作用
• 然后Aspect切面起作用
• 最后进入Controller方法中

五、当控制层（即Controller层）的方法抛异常时，Filter过滤器、Interceptor拦截器 、Aspect切面 抛异常的顺序

• 先是Aspect切面
• 如果使用@ControllerAdvice自定义异常,再进入这个处理异常类
• 然后Interceptor拦截器
• 然后Filter过滤器
• 如果都没处理，最后到tomcat