日本综合一区二区|亚洲中文天堂综合|日韩欧美自拍一区|男女精品天堂一区|欧美自拍第6页亚洲成人精品一区|亚洲黄色天堂一区二区成人|超碰91偷拍第一页|日韩av夜夜嗨中文字幕|久久蜜综合视频官网|精美人妻一区二区三区

[[411912]]

springboot 攔截器

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

武昌ssl適用于網(wǎng)站、小程序/APP、API接口等需要進行數(shù)據(jù)傳輸應(yīng)用場景，ssl證書未來市場廣闊！成為創(chuàng)新互聯(lián)的ssl證書銷售渠道，可以享受市場價格4-6折優(yōu)惠！如果有意向歡迎電話聯(lián)系或者加微信：13518219792（備注：SSL證書合作）期待與您的合作！

本文首先為大家介紹 HTTP 請求中三種常見的攔截實現(xiàn)，并且比較一下其中的差異。

(1)基于 Aspect 的攔截器

(2)基于 HandlerInterceptor 的攔截器

(3)基于 ResponseBodyAdvice 的攔截器

springboot 入門案例

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

maven 引入

引入必須的 jar 包。

 
 
 
 

  
  
  
  
 
  
  
  
  
    org.springframework.boot 
  
  
  
  
    spring-boot-starter-parent 
  
  
  
  
    1.5.9.RELEASE 
  
  
  
  
 
  
  
  
  
 
  
  
  
  
 
  
  
  
  
     
  
  
  
  
        org.springframework.boot 
  
  
  
  
        spring-boot-starter-web 
  
  
  
  
     
  
  
  
  
     
  
  
  
  
        org.aspectj 
  
  
  
  
        aspectjrt 
  
  
  
  
        1.8.10 
  
  
  
  
     
  
  
  
  
     
  
  
  
  
        org.aspectj 
  
  
  
  
        aspectjweaver 
  
  
  
  
        1.8.10 
  
  
  
  
     
  
  
  
  
 
  
  
  
  
 
  
  
  
  
 
  
  
  
  
     
  
  
  
  
         
  
  
  
  
            org.springframework.boot 
  
  
  
  
            spring-boot-maven-plugin 
  
  
  
  
         
  
  
  
  
     
  
  
  
  
 
 
 
 
 

啟動類

實現(xiàn)最簡單的啟動類。

 
 
 
 

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

定義 Controller

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

 
 
 
 

  
  
  
  
@RestController 
  
  
  
  
public 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 
  
  
  
  
@EnableAspectJAutoProxy 
  
  
  
  
public class AspectLogInterceptor { 
  
  
  
  
 
  
  
  
  
    /** 
  
  
  
  
     * 日志實例 
  
  
  
  
     * @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 
  
  
  
  
 
  
  
  
  
            // 獲取當前攔截的方法簽名 
  
  
  
  
            String signatureShortStr = point.getSignature().toShortString(); 
  
  
  
  
            //2. 打印入?yún)⑿畔?nbsp;
  
  
  
  
            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 
  
  
  
  
        } 
  
  
  
  
    } 
  
  
  
  
 
  
  
  
  
} 
 
 
 
 

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

是個人非常喜歡的一種方式。

主要用途：

(1)日志的出參/入?yún)?/p>

(2)統(tǒng)一設(shè)置 TraceId

(3)方法的調(diào)用耗時統(tǒng)計

基于 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 
  
  
  
  
 */ 
  
  
  
  
@Component 
  
  
  
  
public 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)限校驗、路由等 
  
  
  
  
        logger.info("LogHandlerInterceptor#preHandle 請求地址：{}", 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 { 
  
  
  
  
 
  
  
  
  
    } 
  
  
  
  
 
  
  
  
  
} 
 
 
 
 

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

 
 
 
 

  
  
  
  
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 
  
  
  
  
 */ 
  
  
  
  
@Configuration 
  
  
  
  
public 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)點就是可以根據(jù) url 靈活指定不同的攔截器。

缺點是主要用于 Controller 層。

基于 ResponseBodyAdvice

此接口有beforeBodyWrite方法，參數(shù)body是響應(yīng)對象response中的響應(yīng)體，那么我們就可以用此方法來對響應(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 
  
  
  
  
 */ 
  
  
  
  
@ControllerAdvice 
  
  
  
  
public class MyResponseBodyAdvice implements ResponseBodyAdvice