過濾器Filter和攔截器Interceptor的聯系和區別
本文將對攔截器Interceptor進行簡單講解，并通過幾個例子對它們的差異進行簡要分析。
攔截器Interceptor簡介
一個應用中可以定義多個攔截器，spring在項目啟動時，會將這些攔截器注冊進來，并按照默認規則進行排序。如果是自定義的攔截器，可手動設置攔截器調用的先后順序。
各攔截器是鏈式調用，一個請求可以觸發多個攔截器，每個攔截器的調用會按照它加載到spring中的順序依次執行。
攔截器中有3個方法，功能如下：
- preHandle：該方法在調用Controller方法或獲取靜態資源前被調用(靜態資源包括html、js等)。
- postHandle：該方法在調用Controller方法或獲取靜態資源后，但是視圖還沒有被渲染前調用。
- afterCompletion：該方法在視圖渲染后進行調用，主要用來清除資源。
自定義攔截器Interceptor
- public class MyInterceptor implements HandlerInterceptor {
- @Override
- public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
- System.out.println("調用preHandle");
- return true;
- }
- @Override
- public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
- System.out.println("調用postHandle");
- }
- @Override
- public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
- System.out.println("調用afterCompletion");
- }
- }
注冊自定義攔截器Interceptor
編寫配置類并實現WebMvcConfigurer接口。
- @Configuration
- public class MyWebConfig implements WebMvcConfigurer {
- @Override
- public void addInterceptors(InterceptorRegistry registry) {
- registry.addInterceptor(new MyInterceptor()).addPathPatterns("/**");
- }
- }
過濾器Filter和攔截器Interceptor區別
過濾器和攔截器都可以實現例如編碼設置、日志記錄、權限控制等功能，但是二者還是有很多區別的。
(1)實現原理不同
Filter是基于函數回調實現的：
每個自定義過濾器都會實現一個doFilter()方法，這個方法有一個關鍵參數FilterChain。它是一個回調接口，ApplicationFilterChain是它的具體實現類，該類內部也有一個doFilter()方法，這個方法就是回調方法(ps：可以理解為方法遞歸調用，查看源碼比較容易理解)。
假設有2個濾器，調用流程圖如下(ps：畫的比較抽象)：
Interceptor是基于反射實現的：
為什么說攔截器是基于反射實現的呢?個人理解在攔截器內部的三個方法中，都有一個共同的參數handler，這個參數里包含的信息比較豐富。包含該請求所對應的方法、方法所在的Controller、方法參數等信息，而這些信息都是spring通過反射加載進來的。正是由于這些豐富的參數，使得攔截的功能相比過濾器功能更強大。
handler參數信息
(2)使用范圍不同
過濾器Filter實現了javax.servlet.Filter接口，也就是說過濾器的使用要依賴于Tomcat等容器，所以它只能在web程序中使用。
攔截器Interceptor實現了
org.springframework.web.servlet接口，它是由Spring容器進行管理，并不依賴Tomcat等容器，既可以應用在web程序中，也可以應用在非web程序中。
(3)觸發時機不同
過濾器Filter是在請求進入Tomcat等容器后，servlet處理之前進行調用的。
攔截器Interceptor是在請求進入servlet后，執行Controller之前進行調用的。
(4)攔截范圍不同
過濾器Filter幾乎可以攔截所有進入容器的請求。
攔截器Interceptor只會對Controller請求或訪問static目錄下的靜態資源請求起作用。
(5)初始化時機不同
過濾器Filter是隨著Tomcat等web容器啟動時而進行初始化。
攔截器Interceptor時隨著spring啟動而進行初始化。
過濾器和攔截器如何注入依賴服務
在實際開發中，當使用到過濾器或攔截器時，難免會引入一些依賴的service服務。下面就通過例子進行簡要說明：
Filter依賴service：直接采用注解@Autowired即可。
- @WebFilter(urlPatterns = {"/user/*"})
- @Log4j2
- public class MyFilter implements Filter {
- @Autowired
- private UserService userService;
- @Override
- public void doFilter(ServletRequest request, ServletResponse response, FilterChain filterChain) throws IOException, ServletException {
- HttpServletRequest httpServletRequest = (HttpServletRequest) request;
- log.info("Filter獲取到請求地址：" + httpServletRequest.getServletPath());
- filterChain.doFilter(request, response);
- HttpServletResponse httpServletResponse = (HttpServletResponse) response;
- log.info("Filter獲取到響應類型：" + httpServletResponse.getContentType());
- }
- @Override
- public void init(FilterConfig filterConfig) throws ServletException {
- System.out.println("Filter隨著項目的啟動而啟動，只初始化一次");
- }
- @Override
- public void destroy() {
- System.out.println("Filter隨著web項目的停止而銷毀，完成資源回收");
- }
- }
Interceptor依賴service：直接采用注解@Autowired，但是在將攔截器注入到spring容器中時，不能自己通過new來進行創建。需要將攔截器當做一個普通的bean注入到spring容器中，這樣就可以將service注入到攔截器中。
- public class MyInterceptor implements HandlerInterceptor {
- @Autowired
- private UserService userService;
- @Override
- public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
- System.out.println("調用preHandle");
- return true;
- }
- @Override
- public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
- System.out.println("調用postHandle");
- }
- @Override
- public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
- System.out.println("調用afterCompletion");
- }
- }
- @Configuration
- public class MyWebConfig implements WebMvcConfigurer {
- @Bean
- public MyInterceptor getMyInterceptor(){
- return new MyInterceptor();
- }
- @Override
- public void addInterceptors(InterceptorRegistry registry) {
- // getMyInterceptor()這種注冊方式可以在攔截器里注入bean
- registry.addInterceptor(getMyInterceptor()).addPathPatterns("/**");
- // 這種注冊方式由于是自己new出來的，所以在攔截器里注冊的bean都為null
- registry.addInterceptor(new MyInterceptor2()).addPathPatterns("/**");
- }
- }
過濾器和攔截器如何指定加載順序
(1)Filter：需要通過配置類指定加載順序，值越小，越先執行。采用@WebFilter無法指定順序。
- @Bean
- public FilterRegistrationBean myFilter(){
- MyFilter myFilter = new MyFilter();
- FilterRegistrationBean filterRegistrationBean = new FilterRegistrationBean(myFilter);
- filterRegistrationBean.setUrlPatterns(Arrays.asList("/user/*"));
- filterRegistrationBean.setOrder(2);
- return filterRegistrationBean;
- }
(2)Interceptor：需要通過配置類指定加載順序，值越小，越先執行。
- @Configuration
- public class MyWebConfig implements WebMvcConfigurer {
- @Override
- public void addInterceptors(InterceptorRegistry registry) {
- // getMyInterceptor()這種注冊方式可以在攔截器里注入bean
- registry.addInterceptor(new MyInterceptor()).addPathPatterns("/**").order(1);
- // 這種注冊方式由于是自己new出來的，所以在攔截器里注冊的bean都為null
- registry.addInterceptor(new MyInterceptor2()).addPathPatterns("/**").order(2);
- }
- }
過濾器Filter和攔截器Interceptor使用場景
二者相比攔截器功能更強大些，Filter能做的事情，它都能做，而且可以在請求前，請求后執行，比較靈活。Filter主要用來設置字符編碼、過濾敏感詞匯和URL級別的簡單權限控制。如果需要記錄比較詳細的信息或比較復雜的權限管理，還是建議用攔截器實現。
拓展
Servlet和Controller的區別是什么?
使用Servlet可以收集來自網頁表單的用戶輸入，還可以動態創建網頁。DispatcherServlet是SpringMVC中唯一的Servlet，Servlet容器(Tomcat)把所有的請求都轉發到DispatcherServlet，然后通過HandlerMapping把請求路由到具體的Controller中。因此，Controller只是一個普通的Java Bean。
