SpringBoot過濾器與攔截器使用方法深入分析

更新時間：2022年12月27日 12:01:50 作者：一個雙子座的Java攻城獅

大家應(yīng)該都曉得實現(xiàn)過濾器需要實現(xiàn) javax.servlet.Filter 接口，而攔截器會在處理指定請求之前和之后進行相關(guān)操作，配置攔截器需要兩步，本文通過實例代碼給大家介紹SpringBoot 過濾器和攔截器的相關(guān)知識，感興趣的朋友一起看看吧

什么是過濾器

過濾器 Filter 基于 Servlet 實現(xiàn)，過濾器的主要應(yīng)用場景是對字符編碼、跨域等問題進行過濾。Servlet 的工作原理是攔截配置好的客戶端請求，然后對 Request 和 Response 進行處理。Filter 過濾器隨著 web 應(yīng)用的啟動而啟動，只初始化一次。

Filter 使用時需要繼承 Filter 接口，實現(xiàn)對應(yīng)的 init、doFilter 以及 destroy 方法即可。

import javax.servlet.Filter;
import javax.servlet.FilterChain;
import javax.servlet.FilterConfig;
import javax.servlet.ServletException;
import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;
import org.springframework.stereotype.Component;
@Component
public class MyFilter implements Filter {
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        System.out.println("初始化攔截器");
    }
    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
        //做一些處理
        System.out.println("doSomeThing");
        chain.doFilter(request,response);
    }
    @Override
    public void destroy() {
        System.out.println("銷毀攔截器");
    }
}

1、init：在容器啟動時調(diào)用初始化方法，只會初始化一次

2、doFilter：每次請求都會調(diào)用 doFilter 方法，通過 FilterChain 調(diào)用后續(xù)的方法。

3、destroy：當(dāng)容器銷毀時，執(zhí)行 destory 方法，只會被調(diào)用一次。

什么是攔截器

攔截器是 SpringMVC 中實現(xiàn)的一種基于 Java 反射（動態(tài)代理）機制的方法增強工具，攔截器的實現(xiàn)是繼承 HandlerInterceptor 接口，并實現(xiàn)接口的 preHandle、postHandle 和 afterCompletion 方法。

1、preHandle：請求方法前置攔截，該方法會在 Controller 處理之前進行調(diào)用，Spring 中可以有多個 Interceptor，這些攔截器會按照設(shè)定的 Order 順序調(diào)用，當(dāng)有一個攔截器在 preHandle 中返回 false 的時候，請求就會終止。

2、postHandle：preHandle 返回結(jié)果為 true 時，在 Controller 方法執(zhí)行之后，視圖渲染之前被調(diào)用

3、afterCompletion：在 preHandle 返回 ture，并且整個請求結(jié)束之后，執(zhí)行該方法。

具體的代碼實現(xiàn)如下，首先編寫一個攔截器：

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.springframework.stereotype.Component;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;
@Component
public class UserInterceptor implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println("preHandle");
        String userName=request.getParameter("username");
        String password = request.getParameter("password");
        if (userName==null||password==null){
            response.setStatus(500);
            response.setContentType("text/html; charset=UTF-8");
            response.getWriter().print("參數(shù)缺失");
            return false;
        }
        //進行用戶校驗
        if (userName.equals("admin")&&password.equals("admin")){
            return true;
        }else {
            response.setStatus(500);
            response.setContentType("text/html; charset=UTF-8");
            response.getWriter().print("用戶名或密碼錯誤");
            return false;
        }
    }
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        System.out.println("postHandle");
    }
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        System.out.println("afterCompletion");
    }
}

編寫完攔截器之后，通過一個配置類設(shè)置攔截器，并且可以通過 addPathPatterns 和 excludePathPatterns 執(zhí)行哪些請求需要被攔截，哪些不需要被攔截。

import org.springframework.beans.factory.annotation.Autowired;
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 MvcConfig implements WebMvcConfigurer {
    @Autowired
    private UserInterceptor userInterceptor;
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(userInterceptor)
                .addPathPatterns("/**")
                .excludePathPatterns("/error");
    }
}

再次訪問 /test 頁面，如果不帶任何參數(shù)，就會在頁面上提示參數(shù)缺失。只有當(dāng)帶上參數(shù) /test?username=admin&password=admin 才能夠訪問。

攔截器與過濾器的區(qū)別

相同點：

1、攔截器與過濾器都是體現(xiàn)了 AOP 的思想，對方法實現(xiàn)增強，都可以攔截請求方法。

2、攔截器和過濾器都可以通過 Order 注解設(shè)定執(zhí)行順序

不同點：

1、過濾器屬于 Servlet 級別，攔截器屬于 Spring 級別。

Filter 是在 javax.servlet 包中定義的，要依賴于網(wǎng)絡(luò)容器，因此只能在 web 項目中使用。

Interceptor 是 SpringMVC 中實現(xiàn)的，歸根揭底攔截器是一個 Spring 組件，由 Spring 容器進行管理。

2、過濾器和攔截器的執(zhí)行順序不同：

下面通過一張圖展示 Filter 和 Interceprtor 的執(zhí)行順序：

首先當(dāng)一個請求進入 Servlet 之前，過濾器的 doFilter 方法進行過濾，進入 Servlet 容器之后，執(zhí)行 Controller 方法之前，攔截器的 preHandle 方法進行攔截，執(zhí)行 Controller 方法之后，視圖渲染之前，攔截器的 postHandle 方法進行攔截，請求結(jié)束之后，執(zhí)行攔截器的 postHandle 方法。

3、過濾器基于函數(shù)回調(diào)方式實現(xiàn)，攔截器基于 Java 反射（動態(tài)代理）機制實現(xiàn)。

到此這篇關(guān)于SpringBoot過濾器與攔截器使用方法深入分析的文章就介紹到這了,更多相關(guān)SpringBoot過濾器與攔截器內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: