過濾器 和 攔截器 6個區別，別再傻傻分不清了
阿新 • • 發佈：2020-06-04
>本文收錄在個人部落格：[www.chengxy-nds.top](http://www.chengxy-nds.top)，技術資料共享，同進步
週末有個小夥伴加我微信，向我請教了一個問題：老哥，**過濾器 (`Filter`) 和 攔截器 (`Interceptor`) 有啥區別啊？** 聽到題目我的第一感覺就是：**簡單**！
畢竟這兩種工具開發中用到的頻率都相當高，應用起來也是比較簡單的，可當我準備回覆他的時候，竟然不知道從哪說起，支支吾吾了半天，場面炒雞尷尬有木有，工作這麼久一個基礎問題答成這樣，丟了大人了。
平時覺得簡單的知識點，但通常都不會太關注細節，一旦被別人問起來，反倒說不出個所以然來。
歸根結底，還是對這些知識瞭解的不夠，一直停留在會用的階段，以至於現在**一看就會一說就廢**！這是典型基礎不紮實的表現，哎·~，其實我也就是個虛胖！
知恥而後勇，下邊結合實踐，更直觀的來感受一下兩者到底有什麼不同？
### 準備環境
我們在專案中同時配置 `攔截器` 和 `過濾器`。
#### 1、過濾器 (Filter)
過濾器的配置比較簡單，直接實現`Filter` 介面即可，也可以通過`@WebFilter`註解實現對特定`URL`攔截，看到`Filter` 介面中定義了三個方法。
- `init()` ：該方法在容器啟動初始化過濾器時被呼叫，它在 `Filter` 的整個生命週期只會被呼叫一次。**注意**：這個方法必須執行成功，否則過濾器會不起作用。
- `doFilter()` ：容器中的每一次請求都會呼叫該方法， `FilterChain` 用來呼叫下一個過濾器 `Filter`。
- `destroy()`： 當容器銷燬 過濾器例項時呼叫該方法，一般在方法中銷燬或關閉資源，在過濾器 `Filter` 的整個生命週期也只會被呼叫一次
```javascript
@Component
public class MyFilter implements Filter {
@Override
public void init(FilterConfig filterConfig) throws ServletException {
System.out.println("Filter 前置");
}
@Override
public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
System.out.println("Filter 處理中");
filterChain.doFilter(servletRequest, servletResponse);
}
@Override
public void destroy() {
System.out.println("Filter 後置");
}
}
```
#### 2、攔截器 (Interceptor)
攔截器它是鏈式呼叫，一個應用中可以同時存在多個攔截器`Interceptor`， 一個請求也可以觸發多個攔截器 ，而每個攔截器的呼叫會依據它的宣告順序依次執行。
首先編寫一個簡單的攔截器處理類，請求的攔截是通過`HandlerInterceptor` 來實現，看到`HandlerInterceptor` 介面中也定義了三個方法。
- `preHandle()` ：這個方法將在請求處理之前進行呼叫。**注意**：如果該方法的返回值為`false` ，將視為當前請求結束，不僅自身的攔截器會失效，還會導致其他的攔截器也不再執行。
- `postHandle()`：只有在 `preHandle()` 方法返回值為`true` 時才會執行。會在Controller 中的方法呼叫之後，DispatcherServlet 返回渲染檢視之前被呼叫。 **有意思的是**：`postHandle()` 方法被呼叫的順序跟 `preHandle()` 是相反的，先宣告的攔截器 `preHandle()` 方法先執行，而`postHandle()`方法反而會後執行。
- `afterCompletion()`：只有在 `preHandle()` 方法返回值為`true` 時才會執行。在整個請求結束之後， DispatcherServlet 渲染了對應的檢視之後執行。
```javascript
@Component
public class MyInterceptor implements HandlerInterceptor {
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
System.out.println("Interceptor 前置");
return true;
}
@Override
public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
System.out.println("Interceptor 處理中");
}
@Override
public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
System.out.println("Interceptor 後置");
}
}
```
將自定義好的攔截器處理類進行註冊，並通過`addPathPatterns`、`excludePathPatterns`等屬性設定需要攔截或需要排除的 `URL`。
```javascript
@Configuration
public class MyMvcConfig implements WebMvcConfigurer {
@Override
public void addInterceptors(InterceptorRegistry registry) {
registry.addInterceptor(new MyInterceptor()).addPathPatterns("/**");
registry.addInterceptor(new MyInterceptor1()).addPathPatterns("/**");
}
}
```
### 我們不一樣
過濾器 和 攔截器 均體現了`AOP`的程式設計思想，都可以實現諸如日誌記錄、登入鑑權等功能，但二者的不同點也是比較多的，接下來一一說明。
#### 1、實現原理不同
過濾器和攔截器 底層實現方式大不相同，`過濾器` 是基於函式回撥的，`攔截器` 則是基於Java的反射機制（動態代理）實現的。
這裡重點說下過濾器！
在我們自定義的過濾器中都會實現一個 `doFilter()`方法，這個方法有一個`FilterChain` 引數，而實際上它是一個回撥介面。`ApplicationFilterChain`是它的實現類， 這個實現類內部也有一個 `doFilter()` 方法就是回撥方法。
```javascript
public interface FilterChain {
void doFilter(ServletRequest var1, ServletResponse var2) throws IOException, ServletException;
}
```
`ApplicationFilterChain`裡面能拿到我們自定義的`xxxFilter`類，在其內部回撥方法`doFilter()`裡呼叫各個自定義`xxxFilter`過濾器，並執行 `doFilter()` 方法。
```javascript
public final class ApplicationFilterChain implements FilterChain {
@Override
public void doFilter(ServletRequest request, ServletResponse response) {
...//省略
internalDoFilter(request,response);
}
private void internalDoFilter(ServletRequest request, ServletResponse response){
if (pos < n) {
//獲取第pos個filter
ApplicationFilterConfig filterConfig = filters[pos++];
Filter filter = filterConfig.getFilter();
...
filter.doFilter(request, response, this);
}
}
}
```
而每個`xxxFilter` 會先執行自身的 `doFilter()` 過濾邏輯，最後在執行結束前會執行`filterChain.doFilter(servletRequest, servletResponse)`，也就是回撥`ApplicationFilterChain`的`doFilter()` 方法，以此迴圈執行實現函式回撥。
```javascript
@Override
public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
filterChain.doFilter(servletRequest, servletResponse);
}
```
#### 2、使用範圍不同
我們看到過濾器 實現的是 `javax.servlet.Filter` 介面，而這個介面是在`Servlet`規範中定義的，也就是說過濾器`Filter` 的使用要依賴於`Tomcat`等容器，導致它只能在`web`程式中使用。
而攔截器(`Interceptor`) 它是一個`Spring`元件，並由`Spring`容器管理，並不依賴`Tomcat`等容器，是可以單獨使用的。不僅能應用在`web`程式中，也可以用於`Application`、`Swing`等程式中。
#### 3、觸發時機不同
`過濾器` 和 `攔截器`的觸發時機也不同，我們看下邊這張圖。
過濾器`Filter`是在請求進入容器後，但在進入`servlet`之前進行預處理，請求結束是在`servlet`處理完以後。
攔截器 `Interceptor` 是在請求進入`servlet`後，在進入`Controller`之前進行預處理的，`Controller` 中渲染了對應的檢視之後請求結束。
#### 4、攔截的請求範圍不同
在上邊我們已經同時配置了過濾器和攔截器，再建一個`Controller`接收請求測試一下。
```javascript
@Controller
@RequestMapping()
public class Test {
@RequestMapping("/test1")
@ResponseBody
public String test1(String a) {
System.out.println("我是controller");
return null;
}
}
```
專案啟動過程中發現，過濾器的`init()`方法，隨著容器的啟動進行了初始化。
此時瀏覽器傳送請求，F12 看到居然有兩個請求，一個是我們自定義的 `Controller` 請求，另一個是訪問靜態圖示資源的請求。
看到控制檯的列印日誌如下：
執行順序 ：`Filter 處理中` ->