一. 什么是攔截器?

• 需要修改每個(gè)接口的處理邏輯
• 需要修改每個(gè)接口的返回結(jié)果
• 接口定義修改,前端代碼也需要跟著修改

有沒有更簡(jiǎn)單的辦法,統(tǒng)?攔截所有的請(qǐng)求,并進(jìn)行Session校驗(yàn)?zāi)?這里我們學(xué)習(xí)?種新的解決辦法:攔截器

攔截器是Spring框架提供的核心功能之?,主要用來攔截用戶的請(qǐng)求,在指定方法前后,根據(jù)業(yè)務(wù)需要執(zhí)行預(yù)先設(shè)定的代碼.也就是說,允許開發(fā)?員提前預(yù)定義?些邏輯,在用戶的請(qǐng)求響應(yīng)前后執(zhí)行.也可以在用戶請(qǐng)求前阻止其執(zhí)行.

在攔截器當(dāng)中，開發(fā)?員可以在應(yīng)用程序中做?些通用性的操作,比如通過攔截器來攔截前端發(fā)來的
請(qǐng)求,判斷Session中是否有登錄用戶的信息.如果有就可以放行,如果沒有就進(jìn)行攔截.

二. 攔截器執(zhí)行流程

正常的調(diào)用順序:

有了攔截器之后，會(huì)在調(diào)用Controller之前進(jìn)行相應(yīng)的業(yè)務(wù)處理，執(zhí)行的流程如下圖

• 添加攔截器后,執(zhí)行Controller的方法之前,請(qǐng)求會(huì)先被攔截器攔截住.執(zhí)行 preHandle() 方法，這個(gè)方法需要返回?個(gè)布爾類型的值.如果返回true,就表示放行本次操作,繼續(xù)訪問controller中的方法.如果返回false，則不會(huì)放行(controller中的方法也不會(huì)執(zhí)行).
• controller當(dāng)中的方法執(zhí)行完畢后，再回過來執(zhí)行 postHandle() 這個(gè)方法以及afterCompletion() 方法，執(zhí)行完畢之后，最終給瀏覽器響應(yīng)數(shù)據(jù).

三. 攔截器

攔截器的基本使用.

攔截器的使用步驟分為兩步：

• 定義攔截器
• 注冊(cè)配置攔截器
• 攔截器的攔截路徑配置

3.1 定義攔截器

自定義攔截器：實(shí)現(xiàn)HandlerInterceptor接口，并重寫其所有方法

@Slf4j
@Component
public class LoginInterceptor implements HandlerInterceptor {

	@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponseresponse, Object handler) throws Exception {
	log.info("LoginInterceptor 目標(biāo)方法執(zhí)行前執(zhí)行..");
	return true;
	}

@Override
public void postHandle(HttpServletRequest request, HttpServletResponseresponse, Object handler, ModelAndView modelAndView) throws Exception {
	log.info("LoginInterceptor 目標(biāo)方法執(zhí)行后執(zhí)行");
	}

@Override
public void afterCompletion(HttpServletRequest request,HttpServletResponse response, Object handler, Exception ex) throws Exception {
	log.info("LoginInterceptor 視圖渲染完畢后執(zhí)行，最后執(zhí)行");
	}
}

• preHandle()方法：目標(biāo)方法執(zhí)行前執(zhí)行.返回true:繼續(xù)執(zhí)行后續(xù)操作;返回false:中斷后續(xù)操作.
• postHandle()方法：目標(biāo)方法執(zhí)行后執(zhí)行
• afterCompletion()方法：視圖渲染完畢后執(zhí)行，最后執(zhí)行(后端開發(fā)現(xiàn)在?乎不涉及視圖,暫不了 解)

3.2 注冊(cè)配置攔截器

注冊(cè)配置攔截器：實(shí)現(xiàn)WebMvcConfigurer接口，并重寫addInterceptors方法

@Configuration
public class WebConfig implements WebMvcConfigurer {

//?定義的攔截器對(duì)象
@Autowired
private LoginInterceptor loginInterceptor;

@Override
public void addInterceptors(InterceptorRegistry registry) {
	//注冊(cè)?定義攔截器對(duì)象
	registry.addInterceptor(loginInterceptor).addPathPatterns("/**");//設(shè)置攔截器攔截的請(qǐng)求路徑（ /** 表示攔截所有請(qǐng)求）
	}
}

啟動(dòng)服務(wù),試試訪問任意請(qǐng)求,觀察后端日志

可以看到preHandle方法執(zhí)行之后就放行了,開始執(zhí)行目標(biāo)方法,目標(biāo)方法執(zhí)行完成之后執(zhí)行postHandle和afterCompletion方法.

我們把攔截器中preHandle方法的返回值改為false,再觀察運(yùn)行結(jié)果

可以看到,攔截器攔截了請(qǐng)求,沒有進(jìn)行響應(yīng).

3.3 攔截路徑的配置

攔截路徑是指我們定義的這個(gè)攔截器,對(duì)哪些請(qǐng)求生效.

我們?cè)谧?cè)配置攔截器的時(shí)候,通過 addPathPatterns() 方法指定要攔截哪些請(qǐng)求.也可以通過excludePathPatterns() 指定不攔截哪些請(qǐng)求.

上述代碼中,我們配置的是 /** ,表示攔截所有的請(qǐng)求.

比如用戶登錄校驗(yàn),我們希望可以對(duì)除了登錄之外所有的路徑生效

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 WebConfig implements WebMvcConfigurer {
	//?定義的攔截器對(duì)象
	@Autowired
	private LoginInterceptor loginInterceptor;
	
	@Override
	public void addInterceptors(InterceptorRegistry registry) {
	//注冊(cè)?定義攔截器對(duì)象
	registry.addInterceptor(loginInterceptor)
		.addPathPatterns("/**")
		.excludePathPatterns("/user/login");//設(shè)置攔截器攔截的請(qǐng)求路徑
	(/** 表示攔截所有請(qǐng)求)
	}
}

在攔截器中除了可以設(shè)置 /** 攔截所有資源外，還有?些常見攔截路徑設(shè)置：

以上攔截規(guī)則可以攔截此項(xiàng)目中的使用URL，包括靜態(tài)文件(圖片文件,JS和CSS等文件).

以上就是深入探究SpringBoot攔截器的自定義設(shè)計(jì)與實(shí)現(xiàn)全攻略的詳細(xì)內(nèi)容，更多關(guān)于SpringBoot攔截器設(shè)計(jì)與實(shí)現(xiàn)的資料請(qǐng)關(guān)注腳本之家其它相關(guān)文章！