1. Filter 介紹
Filter 過濾器這個概念應該大家不會陌生，特別是對與從 Servlet 開始入門學 Java 后臺的同學來說。那么這個東西我們能做什么呢？Filter 過濾器主要是用來過濾用戶請求的，它允許我們對用戶請求進行前置處理和后置處理，比如實現 URL 級別的權限控制、過濾非法請求等等。Filter 過濾器是面向切面編程——AOP 的具體實現（AOP切面編程只是一種編程思想而已）。
另外，Filter 是依賴于 Servlet 容器，Filter接口就在 Servlet 包下面，屬于 Servlet 規范的一部分。所以，很多時候我們也稱其為“增強版 Servlet”。
如果我們需要自定義 Filter 的話非常簡單，只需要實現 javax.Servlet.Filter 接口，然后重寫里面的 3 個方法即可！
Filter.java
public interface Filter {
//初始化過濾器后執行的操作
default void init(FilterConfig filterConfig) throws ServletException {
}
// 對請求進行過濾
void doFilter(ServletRequest var1, ServletResponse var2, FilterChain var3) throws IOException, ServletException;
// 銷毀過濾器后執行的操作，主要用戶對某些資源的回收
default void destroy() {
}
}
2. Filter是如何實現攔截的？
Filter接口中有一個叫做 doFilter 的方法，這個方法實現了對用戶請求的過濾。具體流程大體是這樣的：
- 用戶發送請求到 web 服務器,請求會先到過濾器；
- 過濾器會對請求進行一些處理比如過濾請求的參數、修改返回給客戶端的 response 的內容、判斷是否讓用戶訪問該接口等等。
- 用戶請求響應完畢。
- 進行一些自己想要的其他操作。
[圖片上傳失敗...(image-dc50a5-1618384077756)]
3. 如何自定義Filter
3.1 實習javax.Servlet.Filter接口
@Component
public class MyFilter1 implements Filter {
@Override
public void init(FilterConfig filterConfig) throws ServletException {
System.out.println("初始化方法：只在服務器啟動初始化的時候執行一次");
}
@Override
public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
System.out.println("執行過濾器操作");
/*放行操作*/
filterChain.doFilter(servletRequest,servletResponse);
/*執行完對應的方法回來之后還好經過過濾器*/
System.out.println("事情干完了,回顯到客戶端");
}
/*在服務器正常關閉的時候執行*/
@Override
public void destroy() {
System.out.println("銷毀方法，只在服務器關閉的時候執行一次");
}
}
3.2 在配置中注冊自定義的過濾器
@Configuration
public class MyFilterConfig {
@Autowired
MyFilter1 myFilter1;
@Bean
public FilterRegistrationBean<MyFilter1> Filter1(){
FilterRegistrationBean<MyFilter1> myFilter1FilterRegistrationBean = new FilterRegistrationBean<>();
/*設置Filter*/
myFilter1FilterRegistrationBean.setFilter(myFilter1);
/*設置訪問路徑*/
myFilter1FilterRegistrationBean.setUrlPatterns(new ArrayList<>(Arrays.asList("/filter/*")));
return myFilter1FilterRegistrationBean;
}
}
3.3 通過注解實現配置
注意：
**
使用WebFilter，需要在啟動類上加上 @ServletComponentScan 注解。
@WebFilter(filterName = "MyFilter1",urlPatterns = "/filter")
public class MyFilter1 implements Filter {
@Override
public void init(FilterConfig filterConfig) throws ServletException {
System.out.println("初始化方法：只在服務器啟動初始化的時候執行一次");
}
@Override
public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
System.out.println("執行過濾器操作");
/*放行操作*/
filterChain.doFilter(servletRequest,servletResponse);
/*執行完對應的方法回來之后還好經過過濾器*/
System.out.println("事情干完了,回顯到客戶端");
}
/*在服務器正常關閉的時候執行*/
@Override
public void destroy() {
System.out.println("銷毀方法，只在服務器關閉的時候執行一次");
}
}
4. 自定義多個過濾器，確定過濾器的執行順序
通過設置過濾器級別來進行操作，調用FilterRegistrationBean的setOrder方法
package com.pjh.Config;
import com.pjh.Filter.MyFilter1;
import com.pjh.Filter.MyFilter2;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.web.servlet.FilterRegistrationBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import java.util.ArrayList;
import java.util.Arrays;
/**
* @ClassName: MyFilterConfig
* @Author: 86151
* @Date: 2021/4/14 14:29
* @Description: TODO
*/
@Configuration
public class MyFilterConfig {
@Autowired
MyFilter1 myFilter1;
@Autowired
MyFilter2 myFilter2;
@Bean
public FilterRegistrationBean<MyFilter1> Filter1(){
FilterRegistrationBean<MyFilter1> myFilter1FilterRegistrationBean = new FilterRegistrationBean<>();
/*設置Filter*/
myFilter1FilterRegistrationBean.setFilter(myFilter1);
/*設置過濾器的級別*/
myFilter1FilterRegistrationBean.setOrder(1);
/*設置訪問路徑*/
myFilter1FilterRegistrationBean.setUrlPatterns(new ArrayList<>(Arrays.asList("/filter/*")));
return myFilter1FilterRegistrationBean;
}
@Bean
public FilterRegistrationBean<MyFilter2> Filter2(){
FilterRegistrationBean<MyFilter2> myFilter1FilterRegistrationBean = new FilterRegistrationBean<>();
/*設置Filter*/
myFilter1FilterRegistrationBean.setFilter(myFilter2);
/*設置過濾器的級別*/
myFilter1FilterRegistrationBean.setOrder(2);
/*設置訪問路徑*/
myFilter1FilterRegistrationBean.setUrlPatterns(new ArrayList<>(Arrays.asList("/filter/*")));
return myFilter1FilterRegistrationBean;
}
}
5.相關注解介紹
@WebFilter
概述
@WebFilter 用于將一個類聲明為過濾器，該注解將會在部署時被容器處理，容器將根據具體的屬性配置將相應的類部署為過濾器。該注解具有下表給出的一些常用屬性 ( 以下所有屬性均為可選屬性，但是 value、urlPatterns、servletNames 三者必需至少包含一個，且 value 和 urlPatterns 不能共存，如果同時指定，通常忽略 value 的取值 )
@WebFilter 的常用屬性
[圖片上傳失敗...(image-b928a3-1618384077756)]
注意事項
filterName的首字母一定要小寫！！！小寫！！！小寫！！！
Application啟動類添加@ServletComponentScan注解
@Order
概述
注解@Order或者接口Ordered的作用是定義Spring IOC容器中Bean的執行順序的優先級，而不是定義Bean的加載順序，Bean的加載順序不受@Order或Ordered接口的影響；
代碼實現
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE, ElementType.METHOD, ElementType.FIELD})
@Documented
public @interface Order {
/**
* 默認是最低優先級,值越小優先級越高
*/
int value() default Ordered.LOWEST_PRECEDENCE;
}
