摘要：接口日志有啥用在我們日常的開發過程中，我們可以通過接口日志去查看這個接口的一些詳細信息。在切入點返回內容之后切入內容可以用來對處理返回值做一些加工處理。

在我們日常的開發過程中，我們可以通過接口日志去查看這個接口的一些詳細信息。比如客戶端的IP，客戶端的類型，響應的時間，請求的類型，請求的接口方法等等，我們可以對這些數據進行統計分析，提取出我們想要的信息。

這里，我們使用的是Spring的兩大殺器之AOP，通過在Controller層定義切點，然后對請求對象進行分析獲取接口信息，同時開啟一個ThreadLocal來記錄響應時間。

@Aspect：將一個類定義為切面類。

@Pointcut：定義一個切入點。

@Before：在切入點開始處切入內容。

@After：在切入點結尾處切入內容。

@AfterReturning：在切入點返回內容之后切入內容（可以用來對處理返回值做一些加工處理。

@Around：在切入點前后切入內容，并自己控制何時執行切入點自身的內容

@AfterThrowing：用來處理當切入內容部分拋出異常之后的處理邏輯。

@Order：在切入點前的操作，按order的值由小到大執行；在切入點后的操作，按order的值由大到小執行。

首先，我們需要新增引入aop的依賴，以及用于分析客戶端信息的UserAgentUtils包，還有用于@Slf4j打印日志的Lombok的包：

        
            org.springframework.boot
            spring-boot-starter-aop
        
        
            eu.bitwalker
            UserAgentUtils
            1.20
        

在之前的統一返回值和異常處理中我們已經定義過這個類，這里是對其進行完善。這里我再把代碼再寫一下：

@Aspect
@Order(5)
@Component
@Slf4j
public class ResponseAop

直接在這里定義基本類型會有同步問題，所以我們定義一個ThreadLocal對象來記錄消耗的時間。

ThreadLocal startTime = new ThreadLocal<>();

這里需要注意的是切點的寫法，一定要正確才能保證AOP生效！這里附上一些簡單的寫法，后續會多帶帶開一章講解execution表達式的書寫。

任意公共方法：

execution(public * *(..))

任何一個以“set”開始的方法的執行：

execution(* set*(..))

Service接口的任意方法的執行：

execution(* com.xyz.service.Service.*(..))

定義在service包里的任意方法的執行：

execution(* com.xyz.service.*.*(..))

定義在service包和所有子包里的任意類的任意方法的執行：

execution(* com.xyz.service..*.*(..))

    /**
     * 切點
     */
    @Pointcut("execution(public * indi.viyoung.viboot.*.controller..*(..))")
    public void httpResponse() {
    }

@Before("httpResponse()")
    public void doBefore(JoinPoint joinPoint){
        //開始計時
        startTime.set(System.currentTimeMillis());
        ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
        HttpServletRequest request = attributes.getRequest();
        //打印請求的內容
        UserAgent userAgent = UserAgent.parseUserAgentString(request.getHeader("User-Agent"));//獲取請求頭中的User-Agent
        log.info("接口路徑：{}" , request.getRequestURL().toString());
        log.info("瀏覽器：{}", userAgent.getBrowser().toString());
        log.info("瀏覽器版本：{}",userAgent.getBrowserVersion());
        log.info("操作系統: {}", userAgent.getOperatingSystem().toString());
        log.info("IP : {}" , request.getRemoteAddr());
        log.info("請求類型：{}", request.getMethod());
        log.info("類方法 : " + joinPoint.getSignature().getDeclaringTypeName() + "." + joinPoint.getSignature().getName());
        log.info("請求參數 : {} " + Arrays.toString(joinPoint.getArgs()));
    }

    @AfterReturning(returning = "ret" , pointcut = "httpResponse()")
    public void doAfterReturning(Object ret){
        //處理完請求后，返回內容
        log.info("方法返回值：{}" , ret);
        log.info("方法執行時間：{}毫秒", (System.currentTimeMillis() - startTime.get()));
    }

下面，我們對一個接口進行訪問：

2019-02-21 21:03:31.358  INFO 11788 --- [nio-8090-exec-5] indi.viyoung.viboot.aop.ResponseAop      : 接口路徑：http://localhost:8090/users
2019-02-21 21:03:31.359  INFO 11788 --- [nio-8090-exec-5] indi.viyoung.viboot.aop.ResponseAop      : 瀏覽器：CHROME
2019-02-21 21:03:31.359  INFO 11788 --- [nio-8090-exec-5] indi.viyoung.viboot.aop.ResponseAop      : 瀏覽器版本：72.0.3626.109
2019-02-21 21:03:31.360  INFO 11788 --- [nio-8090-exec-5] indi.viyoung.viboot.aop.ResponseAop      : 操作系統: MAC_OS_X
2019-02-21 21:03:31.360  INFO 11788 --- [nio-8090-exec-5] indi.viyoung.viboot.aop.ResponseAop      : IP : 0:0:0:0:0:0:0:1
2019-02-21 21:03:31.360  INFO 11788 --- [nio-8090-exec-5] indi.viyoung.viboot.aop.ResponseAop      : 請求類型：GET
2019-02-21 21:03:31.360  INFO 11788 --- [nio-8090-exec-5] indi.viyoung.viboot.aop.ResponseAop      : 類方法 : indi.viyoung.viboot.apilog.controller.UserController.findAll
2019-02-21 21:03:31.360  INFO 11788 --- [nio-8090-exec-5] indi.viyoung.viboot.aop.ResponseAop      : 請求參數 : {} []
...
2019-02-21 21:03:31.393  INFO 11788 --- [nio-8090-exec-5] indi.viyoung.viboot.aop.ResponseAop      : 方法返回值：ReturnVO{code="2000", message="操作成功", data=[User(id=10000001, password=123456, userName=vi-young), User(id=10000002, password=123456, userName=vi-young), User(id=10000003, password=123123, userName=lxt), User(id=10000004, password=123456, userName=yangwei)]}
2019-02-21 21:03:31.393  INFO 11788 --- [nio-8090-exec-5] indi.viyoung.viboot.aop.ResponseAop      : 方法執行時間：36毫秒

可以看出，我們已經獲取到我們想要的信息~

在后面的應用實戰中，我們會將這些信息保存到數據庫中，并且使用一些數據分析工具進行分析。

您的推薦是對我最大的幫助！