一、關系圖了解

二、差別

1.過濾器

過濾器是在web應用啟動的時候初始化一次, 在web應用停止的時候銷毀
可以對請求的URL進行過濾, 對敏感詞過濾
擋在攔截器的外層
實作的是 javax.servlet.Filter 接口，是 Servlet 規範的一部分
在請求進入容器後，但在進入servlet之前進行預處理，請求結束是在servlet處理完以後
依賴Web容器
會多次執行

1.1HttpServletRequestWrapper

在請求到達之前對 request 進行修改

package com.dingwen.lir.filter;

import lombok.extern.slf4j.Slf4j;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletRequestWrapper;
import java.util.Arrays;

/**
 *  在請求到達之前對 request 進行修改
 *
 * @author dingwen
 * 2021.04.30 14:54
 */
@Slf4j
public class RequestWrapper extends HttpServletRequestWrapper {
    public RequestWrapper(HttpServletRequest request) {
        super(request);
        log.info("RequestWrapper");
    }

    @Override
    public String getParameter(String name) {
        // 可以對請求參數進行過濾
        return super.getParameter(name);
    }

    @Override
    public String[] getParameterValues(String name) {
        // 對請求參數值進行過濾
//        String[] values =super.getRequest().getParameterValues(name);
//        return super.getParameterValues(name);
        return "t e s t".split(" ");
    }


}

1.2 OncePerRequestFilter

OncePerRequestFilter，顧名思義，它能夠確定在一次請求中隻通過一次filter

package com.dingwen.lir.filter;

import lombok.extern.slf4j.Slf4j;
import org.springframework.web.filter.OncePerRequestFilter;

import javax.servlet.FilterChain;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.io.PrintWriter;
import java.util.Arrays;

/**
 * 請求過濾器
 * OncePerRequestFilter:
 * OncePerRequestFilter，顧名思義，它能夠確定在一次請求中隻通過一次filter.
 * 大家常識上都認為，一次請求本來就隻filter一次，為什麼還要由此特别限定呢，往往我們的常識和實際的實作并不真的一樣，經過一番資料的查閱，此方法是為了相容不同的web container，
 * 也就是說并不是所有的container都入我們期望的隻過濾一次，servlet版本不同，執行過程也不同，
 * 是以，為了相容各種不同運作環境和版本，預設filter繼承OncePerRequestFilter是一個比較穩妥的選擇。
 *
 * @author dingwen
 * 2021.04.30 15:59
 */
@Slf4j
public class RequestFilter extends OncePerRequestFilter {


    @Override
    public void destroy() {
        super.destroy();
        log.info("RequestFilter destroy");
    }

    /*
            OncePerRequestFilter.doFilter方法中通過request.getAttribute判斷目前過濾器是否已執行
            若未執行過，則調用doFilterInternal方法，交由其子類實作
        */
    @Override
    protected void doFilterInternal(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, FilterChain filterChain) throws ServletException, IOException {
        try {
            RequestWrapper requestWrapper = new RequestWrapper(httpServletRequest);
            filterChain.doFilter(requestWrapper, httpServletResponse);
            log.info("RequestFilter");
            log.info(Arrays.toString(requestWrapper.getParameterValues("name")));
        } catch (Exception exception) {
            httpServletResponse.setCharacterEncoding("utf-8");
            httpServletResponse.setContentType("application/json; charset=utf-8");
            PrintWriter writer = httpServletResponse.getWriter();
            writer.write(exception.toString());
        }
    }
}

1.3 配置

package com.dingwen.lir.configuration;

import com.dingwen.lir.filter.RequestFilter;
import com.dingwen.lir.filter.RequestWrapper;
import org.springframework.boot.web.servlet.FilterRegistrationBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import javax.servlet.Filter;

/**
 * 過濾器配置類
 *
 * @author dingwen
 * 2021.04.30 16:10
 */
@Configuration
public class FilterConfig {

    @Bean
    public RequestFilter requestFilter(){
        return new RequestFilter();
    }
    @Bean
    public FilterRegistrationBean<RequestFilter> registrationBean() {
        FilterRegistrationBean<RequestFilter> registrationBean = new FilterRegistrationBean<>();
        registrationBean.setFilter(requestFilter());
        registrationBean.addUrlPatterns("/filter/*");
        registrationBean.setName("RequestFilter");
        //過濾器的級别，值越小級别越高越先執行
        registrationBean.setOrder(1);
        return registrationBean;
    }
}

2.攔截器

實作 org.springframework.web.servlet.HandlerInterceptor 接口，動态代理
攔截器應用場景, 性能分析, 權限檢查, 日志記錄
是一個Spring元件，并由Spring容器管理，并不不依賴Tomcat等容器，是可以單獨使用的。不僅能應用在web程式中，也可以用于Application、Swing等程式中
是在請求進入servlet後，在進入Controller之前進行預處理的，Controller 中渲染了對應的視圖之後請求結束

2.1登入攔截

package com.dingwen.lir.interceptor;

import com.dingwen.lir.entity.User;
import org.springframework.stereotype.Component;
import org.springframework.util.ObjectUtils;
import org.springframework.web.servlet.HandlerInterceptor;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;

/**
 * 登入攔截
 *
 * @author dingwen
 * 2021.04.25 13:50
 */
@Component
public class PageInterceptor implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        User user = (User)request.getSession().getAttribute("user");
        if (!ObjectUtils.isEmpty(user)) {
            return true;
        } else {
            // 不管是轉發還是重定向，必須傳回false。否則出現多次送出響應的錯誤
            redirect(request, response);
            return false;
        }
    }

    /*
     * 對于請求是ajax請求重定向問題的處理方法
     * @param request
     * @param response
     *
     */
    public void redirect(HttpServletRequest request, HttpServletResponse response) throws IOException {

        if("XMLHttpRequest".equals(request.getHeader("X-Requested-With"))){// ajax
            //擷取目前請求的路徑
            response.setHeader("Access-Control-Expose-Headers", "REDIRECT,CONTENT_PATH");
            //告訴ajax我是重定向
            response.setHeader("REDIRECT", "REDIRECT");
            //告訴ajax我重定向的路徑
            StringBuffer url = request.getRequestURL();
            String contextPath = request.getContextPath();
            response.setHeader("CONTENT_PATH", url.replace(url.indexOf(contextPath) + contextPath.length(), url.length(), "/").toString());
        }else{// http
            response.sendRedirect( "/page/login");
        }

        response.getWriter().write(403);
        response.setStatus(HttpServletResponse.SC_FORBIDDEN);
    }

}

2.2配置

package com.dingwen.lir.configuration;

import com.dingwen.lir.interceptor.PageInterceptor;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
import org.springframework.web.servlet.config.annotation.ViewControllerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

/**
 * mvc 控制器配置
 * MyWebMvcConfigurer: Springboot2.x以後版本使用
 *
 * @author dingwen
 * 2021.04.26 17:52
 */
@Configuration
public class MyWebMvcConfigurer implements WebMvcConfigurer {

    /*
     * 攔截器依賴于Spring容器，此處攔截了所有，需要對靜态資源進行放行
     */
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        // 攔截器預設的執行順序，就是它的注冊順序，也可以通過Order手動設定控制，值越小越先執行。
//        registry.addInterceptor(new PageInterceptor()).addPathPatterns("/**").order()
        registry.addInterceptor(new PageInterceptor()).addPathPatterns("/**")
                .excludePathPatterns("/page/login", "/user/login","/page/ajax","/static/**");
    }


    /*
     * 不要要寫控制器即可完成頁面跳轉通路
     * @param registry
     */
    @Override
    public void addViewControllers(ViewControllerRegistry registry) {
        registry.addViewController("/page/ajax").setViewName("ajax");
    }


    /*
     * 自定義靜态資源映射
        Spring Boot 預設為我們提供了靜态資源映射：
                classpath:/META-INF/resources
                classpath:/resources
                classpath:/static
                classpath:/public
              優先級：META-INF/resources > resources > static > public
     * @param registry
     *
     */
//    @Override
//    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("/static/**").addResourceLocations("classpath:/static/");
        registry.addResourceHandler("/static/**").addResourceLocations("file:E:/static/");
//    }
}

3.監聽器

實作 javax.servlet.ServletRequestListener, javax.servlet.http.HttpSessionListener, javax.servlet.ServletContextListener 等等接口
主要用來監聽對象的建立與銷毀的發生, 比如 session 的建立銷毀, request 的建立銷毀, ServletContext 建立銷毀

三、注意

1.靜态資源問題

SpringBoot2.x以後版本攔截器也會攔截靜态資源，在配置攔截器是需要将姿态資源放行。

/*
     * 攔截器依賴于Spring容器，此處攔截了所有，需要對靜态資源進行放行
     */
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new PageInterceptor()).addPathPatterns("/**")
                .excludePathPatterns("/page/login", "/user/login","/page/ajax","/static/**");
    }

SpringBoot2.x 自定義靜态資源映射

spring:
  mvc:
    static-path-pattern: /static/**

預設目錄

classpath:/META-INF/resources

classpath:/resources

classpath:/static

classpath:/public

優先級：META-INF/resources > resources > static > public

2.登入攔截ajax重定向

由于ajax是異步的，還在目前頁面進行的局部請求。當攔截到登入請求時，即使重定向也無法生效。需采用服務端給位址由前端進行跳轉。詳細見登入攔截器代碼。

// 前端處理// 前端處理
<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>AJAX</title>
    <script src="https://code.jquery.com/jquery-3.0.0.min.js"></script>
</head>
<body>
    <button>USER</button>
</body>
</html>

<script>
    $.ajaxSetup({
        complete:function(xhr,status){
            //攔截器實作逾時跳轉到登入頁面
            let win = window;
            // 通過xhr取得響應頭
            let REDIRECT = xhr.getResponseHeader("REDIRECT");
            //如果響應頭中包含 REDIRECT 則說明是攔截器傳回的需要重定向的請求
            if (REDIRECT === "REDIRECT")
            {
                while (win !== win.top)
                {
                    win = win.top;
                }
                win.location.href = xhr.getResponseHeader("CONTEXTPATH");
            }
        }
    });
    $("button").click(function(){
        $.get("/page/user", function(result){
            $("div").html(result);
        });
    });
</script>

四、測試

代碼位址：https://gitee.com/dingwen-gitee/filter-interceptor-study.git

1.攔截器測試

1.1啟動項目通路首頁

http://localhost:8080/page/index

由于沒有登入，直接重定向到了登入頁

1.2輸入使用者名密碼完成登入，調轉到使用者頁

此時在通路首頁

1.2 登出

成功退出後，通路為授權的頁面也相對會被重定向到登入頁

1.3 ajax未授權通路測試

點選通路user ，由于未登入，沒有全權通路。在前端進行了頁面跳轉，轉到了登入頁。

2.過濾器測試

可以看到過濾器進行了相對應的處理，重寫的getParameterValues()也生效了。配合使用HttpServletRequestWrapper & OncePerRequestFilter 實作了對request的修改。

作者：dingwen_blog

來源：https://blog.csdn.net/qq_38020915/article/details/116431612

點選關注，帶你了解更多

SpringBoot 過濾器、攔截器、監聽器對比及使用場景

一、關系圖了解

二、差別

三、注意

繼續閱讀

MyBatis-Plus 之AR模式

馴服爛代碼_馴服Tomcat：Tomcat 5的過濾技巧

基于Springboot+VUE+Mysql的大學生校園疫情防控管理系統

Using MessageConverter

馴服爛代碼_C＃中的馴服配置

Spring Cloud整合Sleuth，當請求完成後，Zipkin沒有鍊路資訊

JAVA自學之路——馬士兵

Rabbitmq指令行手動建立隊列

整合 Spring 開發架構及服務端技術

SSM整合02---Spring-SpringMVC層一、添加web架構支援二、web.xml三、spring-mvc.xml

SSM架構（二）------------表現層的SpringMVC

Intellij idea基于Maven 的SSM 架構整合

Spring資料和Redis

SpringMVC的啟動過程源碼分析1 SpringMVC 配置XML的方式啟動2 SpringMVC純注解模式啟動

Java Spring 架構

SpringCloud微服務（四）之ribbon筆記ribbon是什麼？入門案例自定義均衡負載算法