spring-boot在web層面使用了spring mvc的攔截器功能，并沒有做其他處理，故我們只要熟悉mvc的攔截器，自然而然可以將攔截器加入到spring-boot上
攔截器接口
package org.springframework.web.servlet;
public interface HandlerInterceptor {
boolean preHandle(
HttpServletRequest request, HttpServletResponse response,
Object handler)
throws Exception;
void postHandle(
HttpServletRequest request, HttpServletResponse response,
Object handler, ModelAndView modelAndView)
throws Exception;
void afterCompletion(
HttpServletRequest request, HttpServletResponse response,
Object handler, Exception ex)
throws Exception;
}
我們可能注意到攔截器一個有3個回調方法，而一般的過濾器Filter才兩個，這是怎么回事呢？馬上分析。
preHandle****：預處理回調方法，實現處理器的預處理（如登錄檢查），第三個參數為響應的處理器（如我們上一章的Controller實現）；
返回值：true表示繼續流程（如調用下一個攔截器或處理器）；
false表示流程中斷（如登錄檢查失敗），不會繼續調用其他的攔截器或處理器，此時我們需要通過response來產生響應；
postHandle****：后處理回調方法，實現處理器的后處理（但在渲染視圖之前），此時我們可以通過modelAndView（模型和視圖對象）對模型數據進行處理或對視圖進行處理，modelAndView也可能為null。
afterCompletion****：整個請求處理完畢回調方法，即在視圖渲染完畢時回調，如性能監控中我們可以在此記錄結束時間并輸出消耗時間，還可以進行一些資源清理，類似于try-catch-finally中的finally，但僅調用處理器執行鏈中preHandle返回true的攔截器的afterCompletion。
攔截運行圖
正常流程
中斷流程
中斷流程中，比如是HandlerInterceptor2中斷的流程（preHandle返回false），此處僅調用它之前攔截器的preHandle返回true的afterCompletion方法。
DispatcherServlet內部工作：
//doDispatch方法
//1、處理器攔截器的預處理（正序執行）
HandlerInterceptor[] interceptors = mappedHandler.getInterceptors();
if (interceptors != null) {
for (int i = 0; i < interceptors.length; i++) {
HandlerInterceptor interceptor = interceptors[i];
if (!interceptor.preHandle(processedRequest, response, mappedHandler.getHandler())) {
//1.1、失敗時觸發afterCompletion的調用
triggerAfterCompletion(mappedHandler, interceptorIndex, processedRequest, response, null);
return;
}
interceptorIndex = i;//1.2、記錄當前預處理成功的索引
}
}
//2、處理器適配器調用我們的處理器
mv = ha.handle(processedRequest, response, mappedHandler.getHandler());
//當我們返回null或沒有返回邏輯視圖名時的默認視圖名翻譯（詳解4.15.5 RequestToViewNameTranslator）
if (mv != null && !mv.hasView()) {
mv.setViewName(getDefaultViewName(request));
}
//3、處理器攔截器的后處理（逆序）
if (interceptors != null) {
for (int i = interceptors.length - 1; i >= 0; i--) {
HandlerInterceptor interceptor = interceptors[i];
interceptor.postHandle(processedRequest, response, mappedHandler.getHandler(), mv);
}
}
//4、視圖的渲染
if (mv != null && !mv.wasCleared()) {
render(mv, processedRequest, response);
if (errorView) {
WebUtils.clearErrorRequestAttributes(request);
}
//5、觸發整個請求處理完畢回調方法afterCompletion
triggerAfterCompletion(mappedHandler, interceptorIndex, processedRequest, response, null);
// triggerAfterCompletion方法
private void triggerAfterCompletion(HandlerExecutionChain mappedHandler, int interceptorIndex,
HttpServletRequest request, HttpServletResponse response, Exception ex) throws Exception {
// 5、觸發整個請求處理完畢回調方法afterCompletion （逆序從1.2中的預處理成功的索引處的攔截器執行）
if (mappedHandler != null) {
HandlerInterceptor[] interceptors = mappedHandler.getInterceptors();
if (interceptors != null) {
for (int i = interceptorIndex; i >= 0; i--) {
HandlerInterceptor interceptor = interceptors[i];
try {
interceptor.afterCompletion(request, response, mappedHandler.getHandler(), ex);
}
catch (Throwable ex2) {
logger.error("HandlerInterceptor.afterCompletion threw exception", ex2);
}
}
}
}
}
spring boot添加攔截器
- 方法一
@SpringBootApplication
public class Application {
public static void main(String[] args) {
SpringApplication application = new SpringApplication(Application.class);
// application.addListeners(new ApplicationListenerEnvironmentPrepared());
// application.addListeners(new ApplicationListenerFailed());
// application.addListeners(new ApplicationListenerPrepared());
// application.addListeners(new ApplicationListenerStarted());
application.run(args);
}
@Configuration
static class WebMvcConfigurer extends WebMvcConfigurerAdapter {
public void addInterceptors(InterceptorRegistry registry) {
registry.addInterceptor(new HandlerInterceptorAdapter() {
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response,
Object handler) throws Exception {
request.getContextPath();
System.out.println("interceptor====");
return true;
}
}).addPathPatterns("/*");
}
}
}
- 方法二
@Configuration
public class WebMvcConfigurer extends WebMvcConfigurerAdapter {
public void addInterceptors(InterceptorRegistry registry) {
registry.addInterceptor(new HandlerInterceptorAdapter() {
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response,
Object handler) throws Exception {
System.out.println("interceptor====222");
return true;
}
}).addPathPatterns("/*");
}
}
總結：只要能被springboot掃描到即可
