SpringBoot 攔截器妙用你真的了解嗎

更新時間：2021年07月01日 11:32:17 作者：陳皮的JavaLib

關(guān)于springboot攔截器很多朋友掌握的不是多好，今天抽空給大家普及下這方面的知識，SpringBoot 攔截器妙用，讓你一個人開發(fā)整個系統(tǒng)的鑒權(quán)模塊，快來跟小編一起學(xué)習(xí)下吧

HandlerInterceptor 詳解

HandlerInterceptor 允許定制 handler 處理器執(zhí)行鏈的工作流接口。我們可以自定義攔截器用于攔截 handlers 處理器（你可以理解為 controller 層的接口），從而可以添加一些共同的重復(fù)性的處理行為（例如接口鑒權(quán)，接口日志記錄，性能監(jiān)控等），而不用修改每一個 handler 的實現(xiàn)。

注意，此基于 SpringBoot 2.3.12.RELEASE 版本講解。

HandlerInterceptor 接口只有三個默認空實現(xiàn)方法，在低版本中這三個方法不是默認方法，而是抽象方法。

public interface HandlerInterceptor {

	default boolean preHandle(HttpServletRequest request, HttpServletResponse response,                 Object handler) throws Exception {
		return true;
	}

	default void postHandle(HttpServletRequest request, HttpServletResponse response,                 Object handler, @Nullable ModelAndView modelAndView) throws Exception {
	}

	default void afterCompletion(HttpServletRequest request, HttpServletResponse response,             Object handler, @Nullable Exception ex) throws Exception {
	}
}

這三個方法的執(zhí)行順序圖如下：

在這里插入圖片描述

preHandle

preHandle 前置處理，攔截一個處理器（handler）的執(zhí)行，preHandle 方法會在 HandlerMapping 確定一個適當(dāng)?shù)奶幚砥鲗ο笾螅?HandlerAdapter 調(diào)用處理器之前被調(diào)用。可以簡單理解為 controller 接口被調(diào)用之前執(zhí)行。

Intercepter 是鏈式的，就是一個接著一個執(zhí)行。如果此方法返回 true，則會執(zhí)行下一個攔截器或者直接執(zhí)行處理器。如果此方法返回 false 或者拋出異常則終止執(zhí)行鏈，也不再調(diào)用處理器。

注意，此方法如果不返回 true，那么 postHandle 和 afterCompletion 不會被執(zhí)行。

那這個方法有什么用呢？其實可以做一些接口被調(diào)用前的預(yù)處理，例如用戶權(quán)限校驗。

package com.chenpi;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import org.springframework.lang.Nullable;
import org.springframework.stereotype.Component;
import org.springframework.web.method.HandlerMethod;
import org.springframework.web.servlet.HandlerInterceptor;

/**
 * @Description 用戶權(quán)限驗證攔截
 * @Author 陳皮
 * @Date 2021/6/27
 * @Version 1.0
 */
@Component
public class UserPermissionInterceptor implements HandlerInterceptor {

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response,
            Object handler) {

        if (handler instanceof HandlerMethod) {

            HandlerMethod handlerMethod = (HandlerMethod) handler;

            // 獲取用戶權(quán)限校驗注解
            UserAuthenticate userAuthenticate =
                    handlerMethod.getMethod().getAnnotation(UserAuthenticate.class);
            if (null == userAuthenticate) {
                userAuthenticate = handlerMethod.getMethod().getDeclaringClass()
                        .getAnnotation(UserAuthenticate.class);
            }
            if (userAuthenticate != null && userAuthenticate.permission()) {
                // 驗證用戶信息
                UserContext userContext = userContextManager.getUserContext(request);
                if (null == userContext) {
                    return false;
                }
            }
        }
        return true;
    }
}

postHandle

postHandle 后置處理，會在 HandlerAdapter 調(diào)用處理器之后，但在 DispatcherServlet 渲染視圖之前被調(diào)用。可以在此對 ModelAndView 做一些額外的處理。可以簡單理解為 controller 接口被調(diào)用之后執(zhí)行。

注意，此方法在執(zhí)行鏈中的執(zhí)行順序是倒著執(zhí)行的，即先聲明的攔截器后執(zhí)行。

afterCompletion

afterCompletion 完成之后，在請求處理完之后被執(zhí)行，也就是渲染完視圖之后。一般用于做一些資源的清理工作，配合 preHandle 計算接口執(zhí)行時間等。

注意，和 postHandle 一樣，此方法在執(zhí)行鏈中的執(zhí)行順序也是倒著執(zhí)行的，即先聲明的攔截器后執(zhí)行。

@Override
public void afterCompletion(HttpServletRequest request, HttpServletResponse response,
                            Object handler, @Nullable Exception ex) {
    // 請求完后，清除當(dāng)前線程的用戶信息
    UserContextHolder.removeUserContext();
}

注冊攔截器

注意，我們自定義的攔截器要通過 WebMvcConfigurer 的實現(xiàn)類進行注冊，才能生效。

package com.yzj.ehr.common.config;

import com.yzj.ehr.common.context.UserContextResolver;
import org.springframework.stereotype.Component;
import org.springframework.web.method.support.HandlerMethodArgumentResolver;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

import com.yzj.ehr.common.interceptor.UserPermissionInterceptor;

/**
 * @Description 注冊攔截器
 * @Author 陳皮
 * @Date 2021/6/27
 * @Version 1.0
 */
@Component
public class WebAppConfigurer implements WebMvcConfigurer {

    private UserPermissionInterceptor userPermissionInterceptor;

    public WebAppConfigurer(final UserPermissionInterceptor userPermissionInterceptor) {
        this.userPermissionInterceptor = userPermissionInterceptor;
    }

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        // 匹配所有接口，排除/base/test接口
        registry.addInterceptor(userPermissionInterceptor).addPathPatterns("/**")
                .excludePathPatterns("/base/test");
    }
}

到此這篇關(guān)于SpringBoot 攔截器妙用你真的了解嗎的文章就介紹到這了,更多相關(guān)SpringBoot 攔截器內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: