Springboot項目快速實現過濾器功能
前言
很多時候，當你以為掌握了事實真相的時間，如果你能再深入一點，你可能會發(fā)現另外一些真相。比如面向切面編程的最佳編程實踐是AOP，AOP的主要作用就是可以定義切入點，并在切入點縱向織入一些額外的統一操作，避免與業(yè)務代碼過度耦合。熟悉java web項目的都知道，另外還有過濾器（filter）、攔截器（interceptor）也有類似AOP的功能特性，那么問題來了：為什么一般說面向切面編程就是指AOP，而不是過濾器和攔截器？過濾器和攔截器在Spring boot中怎么實現？這三者之間有什么區(qū)別？Springboot項目快速實現Aop功能中分享了AOP的相關實現，下面將再用兩到三篇文章，分別和大家分享一下過濾器、攔截器的實現，以及AOP、過濾器、攔截器之間的橫向對比，以便在業(yè)務開發(fā)中，能夠快速、正確選對具體實現方法。
環(huán)境配置
jdk版本:1.8
開發(fā)工具：Intellij iDEA 2020.1
springboot:2.3.9.RELEASE
Filter簡介
Filter， 中文意思是過濾器，Filter的全限定類名是javax.servlet.Filter，可以看出這是與servelt相關的一個接口；SpringMVC核心是DispatcherServlet，而DispatcherServlet又繼承了Servlet，進而可以推測出Filter與SpringMVC也是關聯關系。
事實上這樣的推測也是正確的，在SpringMVC項目中，filter在瀏覽器與服務器之間起過濾的作用，可以截取客戶端和服務端之間的請求和響應信息，并根據這些請求-響應信息作一些其他的操作，但是要注意，filter并不能改變請求-響應信息；
核心類
Filter
Filter接口的全限定類名是javax.servlet.Filter，該接口有三個方法，分別是
1、init(...)：用于初始化Filter；
2、doFilter(...)：過濾請求和攔截響應信息的具體實現在這個方法里；
3、destroy(...)：Filter對象被銷毀時觸發(fā)，主要用于做一些收尾工作，如資源的釋放等；
FilterConfig
FilterConfig接口的全限定類名是javax.servlet.FilterConfig，該接口主要有四個方法，分別是：
1、getFilterName() 獲取Filter的名字；
2、getServletContext() 獲取ServletContext對象（即application）；
3、getInitParameter() 獲取Filter的初始化參數；
4、getInitParameterNames() 獲取所有初始化參數的名字；
FilterChain
FilterChainr接口的全限定類名是javax.servlet.FilterChain，該接口只有一個方法，是doFilter()方法，用于調用Filter鏈上的下一個過濾器，如果當前過濾器為最后一個或只有一個過濾器，則該過濾器則將請求發(fā)送到目標資源。
MyFilter2是自己實現的過濾器，實現了Filter接口；Filter接口依賴FilterChain接口和FilterConfig接口，其中FilterChain接口的實現類是org.apache.catalina.core.ApplicationFilterChain，FilterConfig接口的實現類是org.apache.catalina.core.ApplicationFilterConfig；
工作原理
1、項目啟動的時候，先執(zhí)行Filter的構造方法，完成相關Filter對象的注冊；
2、緊接著，Filter對象的init()方法被調用，開始對Filter做一些初始化操作；
3、項目啟動完成后，客戶端每次向服務端發(fā)起請求時，如果請求地址與過濾器定義的地址匹配，則會執(zhí)行Filter的doFilter()；如果匹配上多個過濾器，則會形成一個鏈路，依次調用各個過濾器對象的doFilter()；服務端作出響應后，也會再次執(zhí)行到各個過濾器對象的doFilter()；請求和響應時，過濾器鏈的執(zhí)行順序是先進后出；
4、服務器停止時調用Filter的destroy()方法，用來釋放資源。
實現方式
Springboot項目中一般有兩種方式：
1、@WebFilter注解，即javax.servlet.annotation.WebFilter；
2、FilterRegistrationBean，即org.springframework.boot.web.servlet.FilterRegistrationBean；
兩種方式，都需要在啟動類上增加注解@ServletComponentScan，用于開啟servlet相關bean的掃描，其中包含有過濾器（Filter）；
@SpringBootApplication
@ServletComponentScan
public class FanfuApplication {
public static void main(String[] args) {
SpringApplication.run(FanfuApplication.class, args);
}
}代碼實現
1、WebFilter注解里，定義一下過濾器的名字，以及要對哪些請求進行過濾，“/*”表示對所有的請求都過濾，在實際業(yè)務中，可具體對待；如果在初始化的時候，需要攜帶一些初始化的參數，可以在initParams屬性上，使用@WebInitParam注解來定義初始化參數名稱和具體的值，這些參數可以在filter對象初始化的時候獲取到；MyFIlter1和MyFIlter2使用的注解方式定義的過濾器；
@Slf4j
@WebFilter(filterName = "myFilter1", urlPatterns = "/*", initParams = {@WebInitParam(name = "creator", value = "fanfu")})
public class MyFilter1 implements Filter {
@Override
public void init(FilterConfig filterConfig) throws ServletException {
log.info("http://myFilter1初始化開始");
String creator = filterConfig.getInitParameter("creator");
log.info("http://初始化參數creator:{}",creator);
}
@Override
public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
log.info("http://myFilter1開始執(zhí)行");
chain.doFilter(request, response);
log.info("http://myFilter1結束執(zhí)行");
}
@Override
public void destroy() {
log.info("http://myfilter1被銷毀");
}
}@Slf4j
@WebFilter(filterName = "myFilter2", urlPatterns = "/*")
public class MyFilter2 implements Filter {
@Override
public void init(FilterConfig filterConfig) throws ServletException {
log.info("http://myFilter2初始化開始");
}
@Override
public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
log.info("http://myFilter2開始執(zhí)行");
chain.doFilter(request, response);
log.info("http://myFilter2結束執(zhí)行");
}
@Override
public void destroy() {
log.info("http://myFilter2被銷毀");
}
}2、FilterRegistrationBean方式
在Springboot項目的配置類中，使用FilterRegistrationBean來包裝自定義的過濾器，這種方式的最大好處就是可以自定義過濾器的執(zhí)行順序，數字越小，執(zhí)行時的優(yōu)先級就越高；MyFIlter3和MyFIlter4是使用FilterRegistrationBean方式定義的過濾器；
@Configuration
public class WebConfig {
@Bean
public FilterRegistrationBean filterRegistration1() {
FilterRegistrationBean filterRegistrationBean = new FilterRegistrationBean();
filterRegistrationBean.setFilter(new MyFilter3());
filterRegistrationBean.addUrlPatterns("/*");//定義過濾器對哪些請求路徑進行過濾，/*表示對所有請求都過濾
filterRegistrationBean.setOrder(2);//定義過濾器的執(zhí)行優(yōu)先級，數據越小優(yōu)先級越高
return filterRegistrationBean;
}
@Bean
public FilterRegistrationBean filterRegistration2() {
FilterRegistrationBean filterRegistrationBean = new FilterRegistrationBean();
filterRegistrationBean.setFilter(new MyFilter4());
filterRegistrationBean.addUrlPatterns("/*");
filterRegistrationBean.setOrder(1);
return filterRegistrationBean;
}
}@Slf4j
public class MyFilter3 implements Filter {
@Override
public void init(FilterConfig filterConfig) throws ServletException {
log.info("http://MyFilter3初始化開始");
}
@Override
public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
log.info("http://MyFilter3開始執(zhí)行");
chain.doFilter(request,response);
log.info("http://MyFilter3結束執(zhí)行");
}
@Override
public void destroy() {
log.info("http://MyFilter3被銷毀");
}
}@Slf4j
public class MyFilter4 implements Filter {
@Override
public void init(FilterConfig filterConfig) throws ServletException {
log.info("http://MyFilter4初始化開始");
}
@Override
public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
log.info("http://MyFilter4開始執(zhí)行");
chain.doFilter(request,response);
log.info("http://MyFilter4結束執(zhí)行");
}
@Override
public void destroy() {
log.info("http://MyFilter4被銷毀");
}
}未定義myFilter3、myFilter4的執(zhí)行優(yōu)先級，即采取自然排序時的執(zhí)行結果：在請求前myFilter3的執(zhí)行時機早于myFilter4，響應后myFilter3的執(zhí)行時機要晚于myFilter4；
定義myFilter4的優(yōu)先級高于myFilter3時，執(zhí)行結果：在請求前myFilter4的執(zhí)行時機早于myFilter3，響應后的myFilter4的執(zhí)行時機要晚于myFilter3；
總結
過濾器的實現是比較簡單，通過梳理這個過程，我get到以下幾個點：
1、過濾器是用于SpringMVC項目中，即與servlet相關的項目；
2、過濾器的執(zhí)行時機是在請求前和響應后，有兩種實現方式，即@WebFilter注解和FilterRegistrationBean；如果對過濾器的執(zhí)行順序沒有限制要求，則可以使用第一種；如果對過濾器的執(zhí)行順序有明確限制，則可以使用第二種；
3、如果有多個過濾器對象時，會形成一個過濾器鏈，過濾器的執(zhí)行順序是先進后出；
4、過濾器可以過濾請求和攔截響應，但是不能改變請求值和響應值；
到此這篇關于Springboot項目快速實現過濾器功能的文章就介紹到這了,更多相關Springboot實現過濾器內容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家！
相關文章
這篇文章主要介紹了Java創(chuàng)建對象的四種方式詳解,如果我們不想利用默認構造器來創(chuàng)建java對象,而想利用指定的構造器來創(chuàng)建java對象,則需要利用Construtor對象,每個Construtor對應一個構造器,需要的朋友可以參考下2023-11-11
Mybatis-plus 批量插入太慢的問題解決(提升插入性能)
公司使用的Mybatis-Plus操作SQL,用過Mybatis-Plus的小伙伴一定知道他有很多API提供給我們使用，但是批量插入大數據太慢應該怎么解決，本文就詳細的介紹一下，感興趣的可以了解一下2021-11-11
springboot+jersey+tomcat實現跨域方式上傳文件到服務器的方式
這篇文章主要介紹了springboot+jersey+tomcat實現跨域方式上傳文件到服務器,本文結合實例代碼給大家介紹的非常詳細，對大家的學習或工作具有一定的參考借鑒價值，需要的朋友可以參考下2023-03-03
這篇文章主要介紹了Spring Boot將Word轉換為 PDF,本文通過示例代碼給大家介紹的非常詳細,對大家的學習或工作具有一定的參考借鑒價值,需要的朋友可以參考下2023-08-08
這篇文章主要介紹了基于java構造方法中對Vector刪除元素的源碼分析，有需要的朋友可以借鑒參考下，希望可以有所幫助，祝大家早日升職加薪2021-09-09
Swagger 是一個規(guī)范和完整的框架，用于生成、描述、調用和可視化 RESTful 風格的 Web 服務?？傮w目標是使客戶端和文件系統作為服務器以同樣的速度來更新。文件的方法，參數和模型緊密集成到服務器端的代碼，允許API來始終保持同步2021-09-09
什么是堆污染呢？是指當參數化類型變量引用的對象不是該參數化類型的對象時而發(fā)生的。我們知道在JDK5中，引入了泛型的概念，在創(chuàng)建集合類的時候，指定該集合類中應該存儲的對象類型。如果在指定類型的集合中，引用了不同的類型，那么這種情況就叫做堆污染。2021-06-06
這篇文章主要介紹了Java數據結構之常見排序算法（下），與之相對有（上），想了解的朋友可以去本網站掃搜，在這兩篇文章里涵蓋關于八大排序算法的所有內容,需要的朋友可以參考下2023-01-01
這篇文章主要為大家介紹了如何使用位運算來實現加減功能，也就是在整個運算過程中不能出現加減符號。文中的示例代碼講解詳細，感興趣的可以了解一下2022-12-12
這篇文章主要介紹了Java中的RabbitMQ交換機詳解,消息隊列是指利用高效可靠的消息傳遞機制進行與平臺無關的數據交流,并基于數據通信來進行分布式系統的集成,是在消息的傳輸過程中保存消息的容器,需要的朋友可以參考下2023-07-07