徹底明白Filter與Interceptor
Filter（過(guò)濾器）
概述
Servlet規(guī)范中定義的一種組件，用于在請(qǐng)求進(jìn)入Servlet之前或響應(yīng)返回客戶端之前執(zhí)行一些操作。它依賴(lài)于Servlet容器，幾乎可以對(duì)任何請(qǐng)求進(jìn)行過(guò)濾，隨著Web應(yīng)用的啟動(dòng)而啟動(dòng)，Web應(yīng)用停止則Filter銷(xiāo)毀。
工作原理
通過(guò)實(shí)現(xiàn)javax.servlet.Filter，對(duì)請(qǐng)求進(jìn)行過(guò)濾攔截，進(jìn)而做統(tǒng)一處理。最后將請(qǐng)求交給Servlet進(jìn)行處理并生成得到響應(yīng)。得到響應(yīng)以后，F(xiàn)ilter可以對(duì)響應(yīng)再次進(jìn)行處理。
圖片
應(yīng)用場(chǎng)景
如進(jìn)行過(guò)濾低俗文字，危險(xiǎn)字符，日志記錄、權(quán)限驗(yàn)證、字符編碼處理等等。如防XSS攻擊的XSSFilter過(guò)濾器。
代碼實(shí)現(xiàn)（SpringBoot舉例）
創(chuàng)建Filter類(lèi)
public class MyFilter implements Filter {
@Override
public void init(FilterConfig filterConfig) throws ServletException {
// 初始化操作
}
@Override
public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
throws IOException, ServletException {
// 在請(qǐng)求處理之前執(zhí)行的操作
// 可以對(duì)請(qǐng)求進(jìn)行修改、驗(yàn)證等操作
chain.doFilter(request, response);
// 在響應(yīng)返回客戶端之前執(zhí)行的操作
// 可以對(duì)響應(yīng)進(jìn)行修改、記錄日志等操作
}
@Override
public void destroy() {
// 銷(xiāo)毀操作
}
}注冊(cè)Filter
在Spring Boot中，我們可以通過(guò)配置類(lèi)或使用@WebFilter注解來(lái)注冊(cè)Filter。
@Configuration
public class FilterConfig {
@Bean
public FilterRegistrationBean<MyFilter> myFilter() {
FilterRegistrationBean<MyFilter> registrationBean = new FilterRegistrationBean<>();
registrationBean.setFilter(new MyFilter());
registrationBean.addUrlPatterns("/api/*"); // 設(shè)置過(guò)濾的路徑
return registrationBean;
}
}Interceptor 攔截器介紹
概述
Interceptor是Spring框架提供的一種攔截器,與Servlet無(wú)關(guān)，它依賴(lài)于Web框架，用于在Controller方法執(zhí)行前后進(jìn)行處理。與Filter不同，Interceptor是Spring MVC框架特有的組件。它可以將一些共有的行為動(dòng)作給通用化、標(biāo)準(zhǔn)化，進(jìn)而讓代碼更加簡(jiǎn)潔，可擴(kuò)展性更高。
原理
圖片
基于實(shí)現(xiàn)HandlerInterceptor接口，并重寫(xiě)它的方法。它有如下方法:
- preHandle方法：目標(biāo)資源方法執(zhí)行前執(zhí)行。返回true則繼續(xù)往下執(zhí)行 返回false則進(jìn)行攔截。
- postHandle方法：目標(biāo)資源方法執(zhí)行后執(zhí)行
- afterCompletion方法：視圖渲染完畢后執(zhí)行，最后執(zhí)行。
應(yīng)用場(chǎng)景
Interceptor主要用于處理與Controller相關(guān)的邏輯，比如權(quán)限驗(yàn)證、日志記錄、統(tǒng)一異常處理等。
代碼實(shí)現(xiàn)
創(chuàng)建Interceptor類(lèi)
public class MyInterceptor implements HandlerInterceptor {
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
throws Exception {
// 在Controller方法執(zhí)行前執(zhí)行的操作
// 返回true表示繼續(xù)執(zhí)行，返回false表示中斷執(zhí)行
return true;
}
@Override
public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler,
ModelAndView modelAndView) throws Exception {
// 在Controller方法執(zhí)行后、視圖渲染前執(zhí)行的操作
}
@Override
public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler,
Exception ex) throws Exception {
// 在整個(gè)請(qǐng)求完成后執(zhí)行的操作
}
}注冊(cè)Interceptor
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
@Configuration
public class InterceptorConfig implements WebMvcConfigurer {
@Override
public void addInterceptors(InterceptorRegistry registry) {
registry.addInterceptor(new MyInterceptor())
.addPathPatterns("/api/**") // 設(shè)置攔截的路徑
.excludePathPatterns("/api/public/**"); // 設(shè)置排除的路徑
}
}Filter與Interceptor的區(qū)別及如何選擇
執(zhí)行時(shí)機(jī)不同
- Filter：在請(qǐng)求進(jìn)入Servlet之前和響應(yīng)返回客戶端之前執(zhí)行。
- Interceptor：在Controller方法執(zhí)行前、執(zhí)行后、視圖渲染前以及整個(gè)請(qǐng)求完成后執(zhí)行。
范圍
- Filter：作用于整個(gè)Web應(yīng)用，不僅限于Spring MVC。
- Interceptor：僅作用于Spring MVC中的Controller層。
使用場(chǎng)景
- Filter：適用于通用的請(qǐng)求處理邏輯，比如字符編碼、日志記錄等。
- Interceptor：適用于與Controller相關(guān)的業(yè)務(wù)邏輯，比如權(quán)限驗(yàn)證、統(tǒng)一異常處理等。
