前言

這裡瞭解一下restful api的攔截，文字主要介紹三種方式來對api進行攔截，參考本文可實現攔截api，進行一些附加操作，比如列印攔截到的方法所在類名，獲取原始的request，攔截到api的呼叫的方法名，還可以根據需要實現打印出方法的引數。當然，下面介紹的攔截器、過濾器、切片功能不全一樣，側重點不同。希望可以給大家帶來幫助。

應用

過濾器方式實現攔截

1、自定義過濾器：

/**
 * @author: zhoulitong
 * @date: 2018/4/23
 * @description:
 */
@Component
public class TimeFilter
 
 implements Filter {
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        System.out.println("time filter init");
    }
    /**
     * 處理服務的請求時間
     * @param request
     * @param response
     * @param chain
     * @throws IOException
     * @throws ServletException
     */
 

    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
        //System.out.println("time filter start");
        long start = System.currentTimeMillis();
        chain.doFilter(request,response);
        //System.out.println("time filter 耗時:" + (System.currentTimeMillis() - start));
 

        //System.out.println("time filter finish");

    }
    @Override
    public void destroy() {
        //System.out.println("time filter destroy");
    }
}

2、配置過濾器注入到spring容器：

/**
 * @author: zhoulitong
 * @date: 2018/4/23
 * @description: 
 */
@Configuration
public class WebConfig{
    @Bean
    public FilterRegistrationBean timeFilter(){
        FilterRegistrationBean registrationBean = new FilterRegistrationBean();
        TimeFilter timeFilter = new TimeFilter();
        registrationBean.setFilter(timeFilter);

        List<String> urls = new ArrayList<>();
        //此過濾器在以下url中會起作用
        urls.add("/*");
        registrationBean.setUrlPatterns(urls);
        return registrationBean;
    }
}

3、特點：此種方式配置可以實現自定義過濾URL的操作，不可從request中拿到

攔截器方式實現攔截

1、自定義攔截器：

/**
 * @author: zhoulitong
 * @date: 2018/4/23
 * @description: preHandle在控制器方法呼叫之前執行，postHandle在控制器方法正常執行後執行，afterCompletion不管控制器方法執行成功與否，都會執行;攔截器優於過濾器的地方就是攔截器有handler這個引數可以瞭解到針對哪個具體的方法進行了攔截。
 */
@Component
public class TimeInterceptor implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println("preHandle");
        //列印類名
        System.out.println(((HandlerMethod)handler).getBean().getClass().getName());
        //列印方法名
        System.out.println(((HandlerMethod)handler).getMethod().getName());
        request.setAttribute("startTime",System.currentTimeMillis());
        return true;
    }
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object o, ModelAndView modelAndView) throws Exception {
        System.out.println("postHandle");
        Long start = (Long)request.getAttribute("startTime");
        System.out.println("time intercept 耗時：" + (System.currentTimeMillis() - start));
    }
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object o, Exception ex) throws Exception {
        System.out.println("afterCompletion");
        Long start = (Long)request.getAttribute("startTime");
        System.out.println("time intercept 耗時：" + (System.currentTimeMillis() - start));
        System.out.println("ex is" + ex);
    }
}

2、配置攔截器注入到spring容器（配置類需要繼承WebMvcConfigurerAdapter，重寫addInterceptors，手動新增自定義攔截器來到達注入的目的），也可為非同步請求加入攔截器

/**
 * @author: zhoulitong
 * @date: 2018/4/23
 * @description: 配置TimeInterceptor需要extends WebMvcConfigurerAdapter
 */
@Configuration
public class WebConfig extends WebMvcConfigurerAdapter {
    @Autowired
    private TimeInterceptor timeInterceptor;

    /**
     * 針對非同步的攔截器配置，攔截非同步請求
     * @param configurer
     */
    @Override
    public void configureAsyncSupport(AsyncSupportConfigurer configurer) {
        super.configureAsyncSupport(configurer);
        //比如如下給非同步服務請求新增攔截器
        //configurer.registerCallableInterceptors((CallableProcessingInterceptor) timeInterceptor);
    }
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(timeInterceptor);
    }
}

3、特點：此種方式可以獲取到攔截的類名稱、方法名稱，不能獲取到方法引數，原因是在dispatcherservlet原始碼中，經過preHandle才對方法引數通過request裡面開始處理拼接）

切片方式實現攔截

1、自定義切片：

@Aspect
@Component
public class TimeAspect {
    //切入點
    @Around("execution(* com.zlt.web.controller.UserController.*(..))")
    //增強
    public Object handleControllerMethod(ProceedingJoinPoint pjp) throws Throwable {

            System.out.print("time aspect start");
            Object[] args = pjp.getArgs();
            for (Object arg :args){
            System.out.println("arg is" + arg);
            }
            long start = System.currentTimeMillis();
            //呼叫被攔截的方法
            Object object = pjp.proceed();
            System.out.println("time filter 耗時：" + (System.currentTimeMillis() - start));
            System.out.println("time aspect end");
            return object; 
    }
}

2、特點：可以攔截到類名、方法名，方法引數名

小結

區別：

過濾器：可以拿到原始的HTTP請求和響應資訊，拿不到處理請求的方法值資訊
攔截器：既可以拿到HTTP請求和響應資訊，也可以拿到請求的方法資訊，拿不到方法呼叫的引數值資訊
切片：可以拿到請求方法的傳入引數值，拿不到原始的HTTP請求和響應的物件

發起一個請求，若三者共存的情況下：

正常執行順序為：filter-interceptor-aspect
異常情況下：aspect-interceptor-filter