過濾器與攔截器
濾器和攔截器都屬於面向切面編程的具體實現。而兩者的主要區別包括以下幾個方面：
-
Filter是依賴於Servlet容器，屬於Servlet規範的一部分，而攔截器則是獨立存在的，可以在任何情況下使用。
-
Filter的執行由Servlet容器回調完成，而攔截器通常通過動態代理的方式來執行。
-
Filter的生命週期由Servlet容器管理，而攔截器則可以通過IoC容器來管理，因此可以通過注入等方式來獲取其他Bean的實例，因此使用會更方便。
過濾器的配置
實例：通過過濾器來實現記錄請求執行時間的功能
import javax.servlet.*;
import java.io.IOException;
public class MyFilter implements Filter {
@Override
public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
long startTime = System.currentTimeMillis();
System.out.println("請求被執行了·····");
filterChain.doFilter(servletRequest, servletResponse);
long endTime = System.currentTimeMillis();
System.out.println("請求執行了"+(endTime-startTime)%1000+"s");
}
}
這段代碼的邏輯比較簡單，就是在方法執行前先記錄時間戳，然後通過過濾器鏈完成請求的執行，在返回結果之間計算執行的時間。這裏需要注意的是這個類必須繼承Filter類，這個是Servlet的規範，這個跟以前的Web項目沒區別。
FilterRegistrationBean
但是，有了過濾器類以後，以前的web項目可以在web.xml中進行配置，但是spring boot項目並沒有web.xml這個文件，那怎麼配置？在Spring boot中，我們需要FilterRegistrationBean來完成配置:
@Configuration
public class FilterConfig {
@Bean
public FilterRegistrationBean filterRegistrationBean(){
FilterRegistrationBean<Filter> filterRegistrationBean = new FilterRegistrationBean<>();
filterRegistrationBean.setFilter(new MyFilter());
filterRegistrationBean.addUrlPatterns("/*");
filterRegistrationBean.setName("myFilter");
filterRegistrationBean.setOrder(1);
return filterRegistrationBean;
}
}
這樣配置就完成了，需要配置的選項主要包括:
- 實例化Filter類;
- 然後指定url的匹配模式;
- 設置過濾器名稱和執行順序。
這個過程和在web.xml中配置其實沒什麼區別，只是形式不同而已。現在我們可以啓動服務器訪問任意URL：
@WebFilter
除了通過 FilterRegistrationBean 來配置以外，還有一種更直接的辦法，直接通過註解就可以完成了：
@WebFilter(urlPatterns = "/*",filterName = "myFilter2")
public class MyFilter2 implements Filter {
@Override
public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
long startTime = System.currentTimeMillis();
System.out.println("filter2:請求被執行了·····");
filterChain.doFilter(servletRequest, servletResponse);
long endTime = System.currentTimeMillis();
System.out.println("filter2:請求執行了"+(endTime-startTime)%1000+"s");
}
}
這裏直接用@WebFilter就可以進行配置，同樣，可以設置url匹配模式，過濾器名稱等。這裏需要注意一點的是@WebFilter這個註解是Servlet3.0的規範，並不是Spring boot提供的。除了這個註解以外，我們還需在配置類中加另外一個註解：@ServletComponetScan，指定掃描的包:
@SpringBootApplication
@ServletComponentScan(basePackages = "com.example") //掃描servlet組件
public class FiltersandinterceptorsdemoApplication {
public static void main(String[] args) {
SpringApplication.run(FiltersandinterceptorsdemoApplication.class, args);
}
}
現在，我們再來訪問一下任意URL：
可以看到，我們配置的兩個過濾器都生效了。細心的讀者會發現，第二個Filter我們並沒有指定執行的順序，但是卻在第一個Filter之前執行。這裏需要解釋一下，@WebFilter這個註解並沒有指定執行順序的屬性，其執行順序依賴於Filter的名稱，是根據Filter類名（注意不是配置的filter的名字）的字母順序倒序排列，並且@WebFilter指定的過濾器優先級都高於FilterRegistrationBean配置的過濾器。
攔截器的配置
我們使用攔截器來實現上面同樣的功能，記錄請求的執行時間。首先我們實現攔截器類：
public class MyInterceptor implements HandlerInterceptor {
private static Long startTime;
private static Long endTime;
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
startTime = System.currentTimeMillis();
System.out.println("interceptor: 執行前···");
return true;
}
@Override
public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
System.out.println("interceptor:執行後...");
endTime = System.currentTimeMillis();
}
@Override
public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
System.out.println("interceptor:渲染完...");
}
}
這裏我們需要實現HandlerInterceptor這個接口，這個接口包括三個方法:
- preHandle是請求執行前執行的;
- postHandler是請求結束執行的，但只有preHandle方法返回true的時候纔會執行;
- afterCompletion是視圖渲染完成後才執行，同樣需要preHandle返回true，該方法通常用於清理資源等工作。
實現了攔截器，我們需要增加下面配置：
@Configuration
public class InterceptorConfig extends WebMvcConfigurerAdapter {
@Override
public void addInterceptors(InterceptorRegistry registry) {
registry.addInterceptor(new MyInterceptor())
.addPathPatterns("/*")
.order(1);
super.addInterceptors(registry);
}
}
這裏我們繼承了WebMVCConfigurerAdapter，重寫了addInterceptors這個方法，進行攔截器的配置，主要配置項就兩個，一個是指定攔截器，第二個是指定攔截的URL。
現在我們再啓動系統訪問任意一個URL：
我們通過攔截器實現了同樣的功能。不過這裏還要說明一點的是，其實這個實現是有問題的，因爲preHandle和postHandle是兩個方法，所以我們這裏不得不設置一個共享變量start來存儲開始值，但是這樣就會存在線程安全問題。當然，我們可以通過其他方法來解決，比如通過ThreadLocal就可以很好的解決這個問題。
雖然攔截器在很多場景下優於過濾器，但是在這種場景下，過濾器比攔截器實現起來更簡單。
參考：https://mp.weixin.qq.com/s/dD_SzVc03HxQaz3tT7RX4A