Spring Boot實戰：攔截器與過濾器

時間 2019-12-05

原文原文鏈接

1、攔截器與過濾器

在講Spring boot以前，咱們先了解一下過濾器和攔截器。這二者在功能方面很相似，可是在具體技術實現方面，差距仍是比較大的。在分析二者的區別以前，咱們先理解一下AOP的概念，AOP不是一種具體的技術，而是一種編程思想。在面向對象編程的過程當中，咱們很容易經過繼承、多態來解決縱向擴展。web

可是對於橫向的功能，好比，在全部的service方法中開啓事務，或者統一記錄日誌等功能，面向對象的是沒法解決的。因此AOP——面向切面編程實際上是面向對象編程思想的一個補充。而咱們今天講的過濾器和攔截器都屬於面向切面編程的具體實現。spring

而二者的主要區別包括如下幾個方面：

Filter是依賴於Servlet容器，屬於Servlet規範的一部分，而攔截器則是獨立存在的，能夠在任何狀況下使用。編程
Filter的執行由Servlet容器回調完成，而攔截器一般經過動態代理的方式來執行。安全
Filter的生命週期由Servlet容器管理，而攔截器則能夠經過IoC容器來管理，所以能夠經過注入等方式來獲取其餘Bean的實例，所以使用會更方便。服務器

2、過濾器的配置

如今咱們經過過濾器來實現記錄請求執行時間的功能，其實現以下：app

public class LogCostFilter implements Filter {ide
@Overridepost
public void init(FilterConfig filterConfig) throws ServletException {url
}spa
@Override
public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
long start = System.currentTimeMillis();
filterChain.doFilter(servletRequest,servletResponse);
System.out.println("Execute cost="+(System.currentTimeMillis()-start));
}
@Override
public void destroy() {
}
}

這段代碼的邏輯比較簡單，就是在方法執行前先記錄時間戳，而後經過過濾器鏈完成請求的執行，在返回結果之間計算執行的時間。這裏須要主要，這個類必須繼承Filter類，這個是Servlet的規範，這個跟之前的Web項目沒區別。

可是，有了過濾器類之後，之前的web項目能夠在web.xml中進行配置，可是spring boot項目並無web.xml這個文件，那怎麼配置？在Spring boot中，咱們須要FilterRegistrationBean來完成配置。其實現過程以下：

@Configuration
public class FilterConfig {
@Bean
public FilterRegistrationBean registFilter() {
FilterRegistrationBean registration = new FilterRegistrationBean();
registration.setFilter(new LogCostFilter());
registration.addUrlPatterns("/*");
registration.setName("LogCostFilter");
registration.setOrder(1);
return registration;
}
}

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

你們能夠看到上面的配置已經生效了。除了經過 FilterRegistrationBean 來配置之外，還有一種更直接的辦法，直接經過註解就能夠完成了：

@WebFilter(urlPatterns = "/*", filterName = "logFilter2")
public class LogCostFilter2 implements Filter {
@Override
public void init(FilterConfig filterConfig) throws ServletException {
}
@Override
public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
long start = System.currentTimeMillis();
filterChain.doFilter(servletRequest, servletResponse);
System.out.println("LogFilter2 Execute cost=" + (System.currentTimeMillis() - start));
}
@Override
public void destroy() {
}
}

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

@SpringBootApplication
@MapperScan("com.pandy.blog.dao")
@ServletComponentScan("com.pandy.blog.filters")
public class Application {
public static void main(String[] args) throws Exception {
SpringApplication.run(Application.class, args);
}
}

如今，咱們再來訪問一下任意URL：

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

3、攔截器的配置

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

public class LogCostInterceptor implements HandlerInterceptor {
long start = System.currentTimeMillis();
@Override
public boolean preHandle(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o) throws Exception {
start = System.currentTimeMillis();
return true;
}
@Override
public void postHandle(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, ModelAndView modelAndView) throws Exception {
System.out.println("Interceptor cost="+(System.currentTimeMillis()-start));
}
@Override
public void afterCompletion(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, Exception e) throws Exception {
}
}

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

@Configuration
public class InterceptorConfig extends WebMvcConfigurerAdapter {
@Override
public void addInterceptors(InterceptorRegistry registry) {
registry.addInterceptor(new LogCostInterceptor()).addPathPatterns("/**");
super.addInterceptors(registry);
}
}

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

能夠看到，咱們經過攔截器實現了一樣的功能。不過這裏還要說明一點的是，其實這個實現是有問題的，由於preHandle和postHandle是兩個方法，因此咱們這裏不得不設置一個共享變量start來存儲開始值，可是這樣就會存在線程安全問題。固然，咱們能夠經過其餘方法來解決，好比經過ThreadLocal就能夠很好的解決這個問題，有興趣的同窗能夠本身實現。不過經過這一點咱們其實能夠看到，雖然攔截器在不少場景下優於過濾器，可是在這種場景下，過濾器比攔截器實現起來更簡單。