SpringBoot Filter和Interceptors的使用和配製

本篇文章是轉的，留着做方便使用原文地址：http://www.cnblogs.com/paddix/p/8365558.html

一、攔截器與過濾器

　在講Spring boot之前，我們先了解一下過濾器和攔截器。這兩者在功能方面很類似，但是在具體技術實現方面，差距還是比較大的。在分析兩者的區別之前，我們先理解一下AOP的概念，AOP不是一種具體的技術，而是一種編程思想。在面向對象編程的過程中，我們很容易通過繼承、多態來解決縱向擴展。 但是對於橫向的功能，比如，在所有的service方法中開啓事務，或者統一記錄日誌等功能，面向對象的是無法解決的。所以AOP——面向切面編程其實是面向對象編程思想的一個補充。而我們今天講的過濾器和攔截器都屬於面向切面編程的具體實現。而兩者的主要區別包括以下幾個方面：

　　1、Filter是依賴於Servlet容器，屬於Servlet規範的一部分，而攔截器則是獨立存在的，可以在任何情況下使用。

　　2、Filter的執行由Servlet容器回調完成，而攔截器通常通過動態代理的方式來執行。

　　3、Filter的生命週期由Servlet容器管理，而攔截器則可以通過IoC容器來管理，因此可以通過注入等方式來獲取其他Bean的實例，因此使用會更方便。

 

二、過濾器的配置

　　現在我們通過過濾器來實現記錄請求執行時間的功能，其實現如下：

 1 public class LogCostFilter implements Filter {
 2     @Override
 3     public void init(FilterConfig filterConfig) throws ServletException {
 4  
 5     }
 6  
 7     @Override
 8     public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
 9         long start = System.currentTimeMillis();
10         filterChain.doFilter(servletRequest,servletResponse);
11         System.out.println("Execute cost="+(System.currentTimeMillis()-start));
12     }
13  
14     @Override
15     public void destroy() {
16  
17     }
18 }

這段代碼的邏輯比較簡單，就是在方法執行前先記錄時間戳，然後通過過濾器鏈完成請求的執行，在返回結果之間計算執行的時間。這裏需要主要，這個類必須繼承Filter類，這個是Servlet的規範，這個跟以前的Web項目沒區別。但是，有了過濾器類以後，以前的web項目可以在web.xml中進行配置，但是spring boot項目並沒有web.xml這個文件，那怎麼配置？在Spring boot中，我們需要FilterRegistrationBean來完成配置。其實現過程如下：

 1 @Configuration
 2 public class FilterConfig {
 3  
 4     @Bean
 5     public FilterRegistrationBean registFilter() {
 6         FilterRegistrationBean registration = new FilterRegistrationBean();
 7         registration.setFilter(new LogCostFilter());
 8         registration.addUrlPatterns("/*");
 9         registration.setName("LogCostFilter");
10         registration.setOrder(1);
11         return registration;
12     }
13  
14 }

這樣配置就完成了，需要配置的選項主要包括實例化Filter類，然後指定url的匹配模式，設置過濾器名稱和執行順序，這個過程和在web.xml中配置其實沒什麼區別，只是形式不同而已。現在我們可以啓動服務器訪問任意URL：

 

大家可以看到上面的配置已經生效了。除了通過 FilterRegistrationBean 來配置以外，還有一種更直接的辦法，直接通過註解就可以完成了：

 1 @WebFilter(urlPatterns = "/*", filterName = "logFilter2")
 2 public class LogCostFilter2 implements Filter {
 3     @Override
 4     public void init(FilterConfig filterConfig) throws ServletException {
 5  
 6     }
 7  
 8     @Override
 9     public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
10         long start = System.currentTimeMillis();
11         filterChain.doFilter(servletRequest, servletResponse);
12         System.out.println("LogFilter2 Execute cost=" + (System.currentTimeMillis() - start));
13     }
14  
15     @Override
16     public void destroy() {
17  
18     }
19 }

這裏直接用@WebFilter就可以進行配置，同樣，可以設置url匹配模式，過濾器名稱等。這裏需要注意一點的是@WebFilter這個註解是Servlet3.0的規範，並不是Spring boot提供的。除了這個註解以外，我們還需在配置類中加另外一個註解：@ServletComponetScan，指定掃描的包。

1 @SpringBootApplication
2 @MapperScan("com.pandy.blog.dao")
3 @ServletComponentScan("com.pandy.blog.filters")
4 public class Application {
5     public static void main(String[] args) throws Exception {
6         SpringApplication.run(Application.class, args);
7     }
8 }

現在，我們再來訪問一下任意URL：

 

可以看到，我們配置的兩個過濾器都生效了。細心的讀者會發現，第二個Filter我們並沒有指定執行的順序，但是卻在第一個Filter之前執行。這裏需要解釋一下，@WebFilter這個註解並沒有指定執行順序的屬性，其執行順序依賴於Filter的名稱，是根據Filter類名（注意不是配置的filter的名字）的字母順序倒序排列，並且@WebFilter指定的過濾器優先級都高於FilterRegistrationBean配置的過濾器。有興趣的朋友可以自己實驗一下。

 

三、攔截器的配置

 　　上面我們已經介紹了過濾器的配置方法，接下來我們再來看看如何配置一個攔截器。我們使用攔截器來實現上面同樣的功能，記錄請求的執行時間。首先我們實現攔截器類：

 

 1 public class LogCostInterceptor implements HandlerInterceptor {
 2     long start = System.currentTimeMillis();
 3     @Override
 4     public boolean preHandle(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o) throws Exception {
 5         start = System.currentTimeMillis();
 6         return true;
 7     }
 8  
 9     @Override
10     public void postHandle(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, ModelAndView modelAndView) throws Exception {
11         System.out.println("Interceptor cost="+(System.currentTimeMillis()-start));
12     }
13  
14     @Override
15     public void afterCompletion(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, Exception e) throws Exception {
16     }
17 }

這裏我們需要實現HandlerInterceptor這個接口，這個接口包括三個方法，preHandle是請求執行前執行的，postHandler是請求結束執行的，但只有preHandle方法返回true的時候纔會執行，afterCompletion是視圖渲染完成後才執行，同樣需要preHandle返回true，該方法通常用於清理資源等工作。除了實現上面的接口外，我們還需對其進行配置：

1 @Configuration
2 public class InterceptorConfig extends WebMvcConfigurerAdapter {
3  
4     @Override
5     public void addInterceptors(InterceptorRegistry registry) {
6         registry.addInterceptor(new LogCostInterceptor()).addPathPatterns("/**");
7         super.addInterceptors(registry);
8     }
9 }

這裏我們繼承了WebMVCConfigurerAdapter，看過前面的文章的朋友應該已經見過這個類了，在進行靜態資源目錄配置的時候我們用到過這個類。這裏我們重寫了addInterceptors這個方法，進行攔截器的配置，主要配置項就兩個，一個是指定攔截器，第二個是指定攔截的URL。現在我們再啓動系統訪問任意一個URL：

 

 

　可以看到，我們通過攔截器實現了同樣的功能。不過這裏還要說明一點的是，其實這個實現是有問題的，因爲preHandle和postHandle是兩個方法，所以我們這裏不得不設置一個共享變量start來存儲開始值，但是這樣就會存在線程安全問題。當然，我們可以通過其他方法來解決，比如通過ThreadLocal就可以很好的解決這個問題，有興趣的同學可以自己實現。不過通過這一點我們其實可以看到，雖然攔截器在很多場景下優於過濾器，但是在這種場景下，過濾器比攔截器實現起來更簡單。

 

四、總結

　　本文主要對基於Spring boot對過濾器和攔截器的配置進行的講解。無論是過濾器還是攔截器都屬於AOP（面向切面編程）思想的具體實現。除了這兩種實現我們還見過另一種更靈活的AOP實現技術，即Aspect，我們可以通過Aspect來完成更多更強大的功能。這個後續再給大家分享。