1. 首頁 > 生活百科 > >

SpringBoot 過濾器和攔截器

生活百科

過濾器實現過濾器需要實現 javax.servlet.Filter 接口 。重寫三個方法 。其中 init() 方法在服務啟動時執行，destroy() 在服務停止之前執行 。
可用兩種方式注冊過濾器：

  • 使用 FilterRegistrationBean 來注入 ?？墒褂?setOrder(0) 設置過濾器的優先級，越小優先級越高 。
  • 使用 @WebFilter(filterName = "myFilter2" ,urlPatterns = "/*") 配合 @ServletComponentScan() 實現注入 。（@Order 注解無效）
編寫過濾器package com.example.recorddemo.filters;import javax.servlet.*;import javax.servlet.http.HttpServletRequest;import java.io.IOException;public class MyFilter1 implements Filter {@Overridepublic void init(FilterConfig filterConfig) throws ServletException {System.out.println("初始化過濾器：" + filterConfig.getFilterName());}@Overridepublic void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {System.out.println("在請求之前做處理");if (servletRequest instanceof HttpServletRequest) {System.out.println("URL:" + ((HttpServletRequest)servletRequest).getRequestURL());}// 調用filter鏈中的下一個filterfilterChain.doFilter(servletRequest, servletResponse);System.out.println("在請求之后做處理");}@Overridepublic void destroy() {System.out.println("銷毀：MyFilter1");}}注冊過濾器基于 FilterRegistrationBean在配置類中注冊一個 FilterRegistrationBean 類型的Bean 。
  • 如果沒有設置 UrlPatterns  ，  那么會自動關聯到 /* 上 。
  • 如果沒有設置過濾器的名字，那么會自動推理出一個過濾器名稱（bean的名字）
    【SpringBoot 過濾器和攔截器】When no URL pattern or servlets are specified the filter will be associated to '/*'. The filter name will be deduced if not specified.
  • fileter默認是enable的，將其設置為false表示關閉當前過濾器 。
  • 可通過 setOrder(0) 方法設置過濾器的優先級，如果優先級相同 ， 則先定義的優先級更高 。
@Configurationpublic class FilterConfiguration {@Beanpublic FilterRegistrationBean myFilter1(){MyFilter1 filter = new MyFilter1();FilterRegistrationBean filterRegistrationBean = new FilterRegistrationBean(filter);//filterRegistrationBean.addUrlPatterns("/*");//filterRegistrationBean.setEnabled(true);return filterRegistrationBean;}}基于 @WebFilter
  • 使用 @WebFilter 修飾filter 。
  • 在任意configuration類中添加 @ServletComponentScan("com.example.recorddemo.filters") ， 包名可以不填 。
import javax.servlet.*;import javax.servlet.annotation.WebFilter;import javax.servlet.http.HttpServletRequest;import java.io.IOException;@WebFilter(filterName = "myFilter2" ,urlPatterns = "/*")public class MyFilter2 implements Filter {@Overridepublic void init(FilterConfig filterConfig) throws ServletException {}@Overridepublic void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {// 調用filter鏈中的下一個filterfilterChain.doFilter(servletRequest, servletResponse);}@Overridepublic void destroy() {}}攔截器攔截器會在處理指定請求之前和之后進行相關操作，配置攔截器需要兩步
    1. 編寫攔截器類（實現 HandlerInterceptor 接口）
    1. 添加已實現的攔截器（實現 WebMvcConfigurer 接口，并重寫 addInterceptors() 方法）
    1. 添加addPathPatterns()規定攔截哪些請求 。（/*表示只攔截/下的所有目錄，但是不包括子目錄, /**表示攔截/下的所有目錄，及其子目錄）
攔截器類：
package com.example.recorddemo.interceptor;import org.springframework.stereotype.Component;import org.springframework.web.servlet.HandlerInterceptor;import org.springframework.web.servlet.ModelAndView;import javax.servlet.http.HttpServletRequest;import javax.servlet.http.HttpServletResponse;/** * @author wangchao */@Componentpublic class MyInterceptor implements HandlerInterceptor {@Overridepublic boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {// handle可拿到執行方法的反射對象 。System.out.println("preHandle: MyInterceptor");return true;}@Overridepublic void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {// 對于RESTful 接口用處不大}@Overridepublic void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {// 可捕捉異常，但是springboot已經有了全局異常捕捉}}

推薦閱讀