目錄springboot 攔截器springboot 入門案例maven 引入啟動(dòng)類定義 Controller攔截器定義基于 Aspect基于 HandlerInterceptor基于 ResponseBodyAdvice測試異步執(zhí)行定義異步線程池異步執(zhí)行的 Controller思考測試反思springboot 攔截器

實(shí)際項(xiàng)目中，我們經(jīng)常需要輸出請(qǐng)求參數(shù)，響應(yīng)結(jié)果，方法耗時(shí)，統(tǒng)一的權(quán)限校驗(yàn)等。

本文首先為大家介紹 HTTP 請(qǐng)求中三種常見的攔截實(shí)現(xiàn)，并且比較一下其中的差異。（1）基于 Aspect 的攔截器（2）基于 HandlerInterceptor 的攔截器（3）基于 ResponseBodyAdvice 的攔截器

推薦閱讀：

統(tǒng)一日志框架: https://github.com/houbb/auto-log

springboot 入門案例

為了便于大家學(xué)習(xí)，我們首先從最基本的 springboot 例子講起。

maven 引入

引入必須的 jar 包。

<parent> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-parent</artifactId> <version>1.5.9.RELEASE</version></parent><dependencies> <dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId> </dependency> <dependency><groupId>org.aspectj</groupId><artifactId>aspectjrt</artifactId><version>1.8.10</version> </dependency> <dependency><groupId>org.aspectj</groupId><artifactId>aspectjweaver</artifactId><version>1.8.10</version> </dependency></dependencies><!-- Package as an executable jar --><build> <plugins><plugin> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-maven-plugin</artifactId></plugin> </plugins></build>啟動(dòng)類

實(shí)現(xiàn)最簡單的啟動(dòng)類。

@SpringBootApplicationpublic class Application { public static void main(String[] args) {SpringApplication.run(Application.class, args); }}定義 Controller

為了演示方便，我們首先實(shí)現(xiàn)一個(gè)簡單的 controller。

@RestControllerpublic class IndexController { @RequestMapping('/index') public AsyncResp index() {AsyncResp asyncResp = new AsyncResp();asyncResp.setResult('ok');asyncResp.setRespCode('00');asyncResp.setRespDesc('成功');System.out.println('IndexController#index：' + asyncResp);return asyncResp; }}

其中 AsyncResp 的定義如下：

public class AsyncResp { private String respCode; private String respDesc; private String result; // getter & setter & toString()}攔截器定義基于 Aspect

import org.aspectj.lang.ProceedingJoinPoint;import org.aspectj.lang.annotation.Around;import org.aspectj.lang.annotation.Aspect;import org.aspectj.lang.annotation.Pointcut;import org.slf4j.Logger;import org.slf4j.LoggerFactory;import org.springframework.context.annotation.EnableAspectJAutoProxy;import org.springframework.stereotype.Component;import java.util.Arrays;/** * * @author binbin.hou * @since 1.0.0 */@Aspect@Component@EnableAspectJAutoProxypublic class AspectLogInterceptor { /** * 日志實(shí)例 * @since 1.0.0 */ private static final Logger LOG = LoggerFactory.getLogger(AspectLogInterceptor.class); /** * 攔截 controller 下所有的 public方法 */ @Pointcut('execution(public * com.github.houbb.springboot.learn.aspect.controller..*(..))') public void pointCut() {// } /** * 攔截處理 * * @param point point 信息 * @return result * @throws Throwable if any */ @Around('pointCut()') public Object around(ProceedingJoinPoint point) throws Throwable {try { //1. 設(shè)置 MDC // 獲取當(dāng)前攔截的方法簽名 String signatureShortStr = point.getSignature().toShortString(); //2. 打印入?yún)⑿畔? Object[] args = point.getArgs(); LOG.info('{} 參數(shù): {}', signatureShortStr, Arrays.toString(args)); //3. 打印結(jié)果 Object result = point.proceed(); LOG.info('{} 結(jié)果: {}', signatureShortStr, result); return result;} finally { // 移除 mdc} }}

這種實(shí)現(xiàn)的優(yōu)點(diǎn)是比較通用，可以結(jié)合注解實(shí)現(xiàn)更加靈活強(qiáng)大的功能。

是個(gè)人非常喜歡的一種方式。主要用途：（1）日志的出參/入?yún)ⅲ?）統(tǒng)一設(shè)置 TraceId（3）方法的調(diào)用耗時(shí)統(tǒng)計(jì)

基于 HandlerInterceptor

import org.slf4j.Logger;import org.slf4j.LoggerFactory;import org.springframework.stereotype.Component;import org.springframework.web.servlet.HandlerInterceptor;import org.springframework.web.servlet.ModelAndView;import javax.servlet.DispatcherType;import javax.servlet.http.HttpServletRequest;import javax.servlet.http.HttpServletResponse;/** * @author binbin.hou * @since 1.0.0 */@Componentpublic class LogHandlerInterceptor implements HandlerInterceptor { private Logger logger = LoggerFactory.getLogger(LogHandlerInterceptor.class); @Override public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {// 統(tǒng)一的權(quán)限校驗(yàn)、路由等logger.info('LogHandlerInterceptor#preHandle 請(qǐng)求地址：{}', request.getRequestURI());if (request.getDispatcherType().equals(DispatcherType.ASYNC)) { return true;}return true; } @Override public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {logger.info('LogHandlerInterceptor#postHandle 調(diào)用'); } @Override public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception { }}

然后需要指定對(duì)應(yīng)的 url 和攔截器之間的關(guān)系才會(huì)生效：

import com.github.houbb.springboot.learn.aspect.aspect.LogHandlerInterceptor;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.WebMvcConfigurerAdapter;/** * spring mvc 配置 * @since 1.0.0 */@Configurationpublic class SpringMvcConfig extends WebMvcConfigurerAdapter { @Autowired private LogHandlerInterceptor logHandlerInterceptor; @Override public void addInterceptors(InterceptorRegistry registry) {registry.addInterceptor(logHandlerInterceptor).addPathPatterns('/**').excludePathPatterns('/version');super.addInterceptors(registry); }}

這種方式的優(yōu)點(diǎn)就是可以根據(jù) url 靈活指定不同的攔截器。缺點(diǎn)是主要用于 Controller 層。

基于 ResponseBodyAdvice

此接口有beforeBodyWrite方法，參數(shù)body是響應(yīng)對(duì)象response中的響應(yīng)體，那么我們就可以用此方法來對(duì)響應(yīng)體做一些統(tǒng)一的操作。

比如加密，簽名等。

import org.slf4j.Logger;import org.slf4j.LoggerFactory;import org.springframework.core.MethodParameter;import org.springframework.http.MediaType;import org.springframework.http.converter.HttpMessageConverter;import org.springframework.http.server.ServerHttpRequest;import org.springframework.http.server.ServerHttpResponse;import org.springframework.http.server.ServletServerHttpRequest;import org.springframework.web.bind.annotation.ControllerAdvice;import org.springframework.web.servlet.mvc.method.annotation.ResponseBodyAdvice;import javax.servlet.http.HttpServletRequest;/** * @author binbin.hou * @since 1.0.0 */@ControllerAdvicepublic class MyResponseBodyAdvice implements ResponseBodyAdvice<Object> { /** * 日志實(shí)例 * @since 1.0.0 */ private static final Logger LOG = LoggerFactory.getLogger(MyResponseBodyAdvice.class); @Override public boolean supports(MethodParameter methodParameter, Class aClass) {//這個(gè)地方如果返回false, 不會(huì)執(zhí)行 beforeBodyWrite 方法return true; } @Override public Object beforeBodyWrite(Object resp, MethodParameter methodParameter, MediaType mediaType, Class<? extends HttpMessageConverter<?>> aClass, ServerHttpRequest serverHttpRequest, ServerHttpResponse serverHttpResponse) {String uri = serverHttpRequest.getURI().getPath();LOG.info('MyResponseBodyAdvice#beforeBodyWrite 請(qǐng)求地址：{}', uri);ServletServerHttpRequest servletServerHttpRequest = (ServletServerHttpRequest) serverHttpRequest;HttpServletRequest servletRequest = servletServerHttpRequest.getServletRequest();// 可以做統(tǒng)一的攔截器處理// 可以對(duì)結(jié)果做動(dòng)態(tài)修改等LOG.info('MyResponseBodyAdvice#beforeBodyWrite 響應(yīng)結(jié)果：{}', resp);return resp; }}測試

我們啟動(dòng)應(yīng)用，頁面訪問：http://localhost:18080/index頁面響應(yīng)：{'respCode':'00','respDesc':'成功','result':'ok'}

后端日志：

c.g.h.s.l.a.a.LogHandlerInterceptor : LogHandlerInterceptor#preHandle 請(qǐng)求地址：/indexc.g.h.s.l.a.aspect.AspectLogInterceptor : IndexController.index() 參數(shù): []IndexController#index：AsyncResp{respCode=’00’, respDesc=’成功’, result=’ok’}c.g.h.s.l.a.aspect.AspectLogInterceptor : IndexController.index() 結(jié)果: AsyncResp{respCode=’00’, respDesc=’成功’, result=’ok’}c.g.h.s.l.a.aspect.MyResponseBodyAdvice : MyResponseBodyAdvice#beforeBodyWrite 請(qǐng)求地址：/indexc.g.h.s.l.a.aspect.MyResponseBodyAdvice : MyResponseBodyAdvice#beforeBodyWrite 響應(yīng)結(jié)果：AsyncResp{respCode=’00’, respDesc=’成功’, result=’ok’}c.g.h.s.l.a.a.LogHandlerInterceptor : LogHandlerInterceptor#postHandle 調(diào)用

這里執(zhí)行的先后順序也比較明確，此處不再贅述。

異步執(zhí)行

當(dāng)然，如果只是上面這些內(nèi)容，并不是本篇文章的重點(diǎn)。接下來，我們一起來看下，如果引入了異步執(zhí)行會(huì)怎么樣。

定義異步線程池

springboot 中定義異步線程池，非常簡單。

import org.springframework.context.annotation.Bean;import org.springframework.context.annotation.Configuration;import org.springframework.core.task.AsyncTaskExecutor;import org.springframework.scheduling.annotation.EnableAsync;import org.springframework.scheduling.concurrent.ThreadPoolTaskExecutor;/** * 請(qǐng)求異步處理配置 * * @author binbin.hou */@Configuration@EnableAsyncpublic class SpringAsyncConfig { @Bean(name = 'asyncPoolTaskExecutor') public AsyncTaskExecutor taskExecutor() {ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();executor.setMaxPoolSize(10);executor.setQueueCapacity(10);executor.setCorePoolSize(10);executor.setWaitForTasksToCompleteOnShutdown(true);return executor; }}異步執(zhí)行的 Controller

@RestControllerpublic class MyAsyncController extends BaseAsyncController<String> { @Override protected String process(HttpServletRequest request) {return 'ok'; } @RequestMapping('/async') public AsyncResp hello(HttpServletRequest request) {AsyncResp resp = super.execute(request);System.out.println('Controller#async 結(jié)果：' + resp);return resp; }}

其中 BaseAsyncController 的實(shí)現(xiàn)如下：

@RestControllerpublic abstract class BaseAsyncController<T> { protected abstract T process(HttpServletRequest request); @Autowired private AsyncTaskExecutor taskExecutor; protected AsyncResp execute(HttpServletRequest request) {// 異步響應(yīng)結(jié)果AsyncResp resp = new AsyncResp();try { taskExecutor.execute(new Runnable() {@Overridepublic void run() { try {T result = process(request);resp.setRespCode('00');resp.setRespDesc('成功');resp.setResult(result.toString()); } catch (Exception exception) {resp.setRespCode('98');resp.setRespDesc('任務(wù)異常'); }} });} catch (TaskRejectedException e) { resp.setRespCode('99'); resp.setRespDesc('任務(wù)拒絕');}return resp; }}

execute 的實(shí)現(xiàn)也比較簡單：（1）主線程創(chuàng)建一個(gè) AsyncResp，用于返回。（2）線程池異步執(zhí)行具體的子類方法，并且設(shè)置對(duì)應(yīng)的值。

思考

接下來，問大家一個(gè)問題。如果我們請(qǐng)求 http://localhost:18080/async，那么：（1）頁面得到的返回值是什么？（2）Aspect 日志輸出的返回值是？（3）ResponseBodyAdvice 日志輸出的返回值是什么？你可以在這里稍微停一下，記錄下你的答案。

測試

我們頁面請(qǐng)求 http://localhost:18080/async。

頁面響應(yīng)如下：

{'respCode':'00','respDesc':'成功','result':'ok'}

后端的日志：

c.g.h.s.l.a.a.LogHandlerInterceptor : LogHandlerInterceptor#preHandle 請(qǐng)求地址：/asyncc.g.h.s.l.a.aspect.AspectLogInterceptor : MyAsyncController.hello(..) 參數(shù): [org.apache.catalina.connector.RequestFacade@7e931750]Controller#async 結(jié)果：AsyncResp{respCode=’null’, respDesc=’null’, result=’null’}c.g.h.s.l.a.aspect.AspectLogInterceptor : MyAsyncController.hello(..) 結(jié)果: AsyncResp{respCode=’null’, respDesc=’null’, result=’null’}c.g.h.s.l.a.aspect.MyResponseBodyAdvice : MyResponseBodyAdvice#beforeBodyWrite 請(qǐng)求地址：/asyncc.g.h.s.l.a.aspect.MyResponseBodyAdvice : MyResponseBodyAdvice#beforeBodyWrite 響應(yīng)結(jié)果：AsyncResp{respCode=’00’, respDesc=’成功’, result=’ok’}c.g.h.s.l.a.a.LogHandlerInterceptor : LogHandlerInterceptor#postHandle 調(diào)用

對(duì)比一下，可以發(fā)現(xiàn)我們上面問題的答案：（1）頁面得到的返回值是什么？

{'respCode':'00','respDesc':'成功','result':'ok'}

可以獲取到異步執(zhí)行完成的結(jié)果。（2）Aspect 日志輸出的返回值是？

AsyncResp{respCode=’null’, respDesc=’null’, result=’null’}

無法獲取異步結(jié)果。（3）ResponseBodyAdvice 日志輸出的返回值是什么？

AsyncResp{respCode=’00’, respDesc=’成功’, result=’ok’}

可以獲取到異步執(zhí)行完成的結(jié)果。

反思

可以發(fā)現(xiàn)，spring 對(duì)于頁面的響應(yīng)也許和我們想的有些不一樣，并不是直接獲取同步結(jié)果。寫到這里，發(fā)現(xiàn)自己對(duì)于 mvc 的理解一直只是停留在表面，沒有真正理解整個(gè)流程。Aspect 的形式在很多框架中都會(huì)使用，不過這里會(huì)發(fā)現(xiàn)無法獲取異步的執(zhí)行結(jié)果，存在一定問題。

到此這篇關(guān)于springboot實(shí)現(xiàn)攔截器的3種方式及異步執(zhí)行的思考的文章就介紹到這了,更多相關(guān)springboot 攔截器內(nèi)容請(qǐng)搜索好吧啦網(wǎng)以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持好吧啦網(wǎng)！