Spring Boot實際應用講解（五）：AOP之請求日誌 一、AOP超簡介紹 二、實例 三、最後

文/ZYRzyr
原文鏈接:http://www.jianshu.com/p/93216bf41182

本文提綱
一、AOP超簡介紹
二、實例
三、最後

本文運行環境

Ubuntu 16.04 LTS
JDK 8 +
IntelliJ IDEA ULTIMATE 2017.2
Maven 3.5.0
Spring Boot 1.5.8.RELEASE

---

一、AOP超簡介紹

首先強調，AOP並不僅僅是在Java中才有的。

網上有很多對AOP的詳細介紹，也有很多講的很好的，這裏就不再贅述。一句話描述就是：每當調用某些方法的過程中，都想做同樣的事A，用一種儘量不重複代碼的方式把A插入到這些方法中，這就是AOP，其中被插入的方法的某個過程（方法執行前、執行後、返回值時、拋出異常時等）即爲切點。

AOP最大的好處就在於：不用修改已有的代碼，即每個想做A的方法都單獨把A寫進去，同時減少了代碼的重複，降低了與業務邏輯無關的代碼的耦合。

二、實例

本文就以在控制檯輸出每個客戶端請求的詳細信息爲例展示AOP的便利之處。

2.1 添加依賴

要使用AOP，需要在pom.xml中添加如下依賴：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-aop</artifactId>
</dependency>

2.2 橫切類

新建類HttpAspect.java：

package com.zyr.demo.aspect;

import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.AfterReturning;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.aspectj.lang.annotation.Pointcut;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;

import javax.servlet.http.HttpServletRequest;

@Aspect
@Component
public class HttpAspect {

    private static final Logger logger = LoggerFactory.getLogger(HttpAspect.class);

    @Pointcut("execution(public * com.zyr.demo.controller..*.*(..))")
    public void logRequest() {
        //no-op
    }

    @Before("logRequest()")
    public void doBefore(JoinPoint joinPoint) {
        ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
        HttpServletRequest request = attributes.getRequest();

        logger.info("-------------------------------Request Log Begin----------------------------------------------");
        logger.info("url={}", request.getRequestURL());
        logger.info("method={}", request.getMethod());
        logger.info("ip={}", request.getRemoteAddr());
        logger.info("class_method={}", joinPoint.getSignature().getDeclaringTypeName() + "." + joinPoint.getSignature().getName());
        logger.info("args={}", joinPoint.getArgs());
        logger.info("-------------------------------Request Log End------------------------------------------------");
    }

    @AfterReturning(returning = "object", pointcut = "logRequest()")
    public void doAfterReturning(Object object) {
        if (object != null) {
            logger.info("response={}", object.toString());
        }
    }
}

1. @Aspect：表示該類是一個橫切類；

2. @Component：表示將該類放入Spring容器中；

3. @Pointcut：表示切入的地方，括號內execution的括號中表示com.zyr.demo.controller包中的所有public方法；

4. logRequest()：由@Pointcut表示該方法即爲上文提到的事A，方法名自定義，方法體內爲空，表示該方法單純指定切入點，具體內容在引用它的地方寫，如下面的doBefore和doAfterReturning；

5. @Before：括號中引用了上面的logRequest()，表示該方法的切入點與它相同，@Before表示在被切入的方法開始執行前，需要先執行該方法體內的代碼，此處即爲打印請求信息，方法名自定義；

6. @AfterReturning：括號中的object必須與方法的參數名相同，表示被切入的方法的返回值。pointcut即同上，表示切入點與logRequest()的切入點相同，@AfterReturning表示在被切入的方法返回值時，執行該方法中的內容；

7. 除了@Before和@AfterReturning，還有@After、AfterThrowing、@Around`等切入方式。

2.3 測試

運行項目，打開REST Client，測試上一節中的localhost:8080/user/register，提交成功後，可以看到控制檯輸出以下信息，說明切入成功，相應的可以測試其它方法：

2017-11-22 16:46:23.591 INFO 10526 --- [nio-8080-exec-1] com.zyr.demo.aspect.HttpAspect : -------------------------------Request Log Begin----------------------------------------------
2017-11-22 16:46:23.591 INFO 10526 --- [nio-8080-exec-1] com.zyr.demo.aspect.HttpAspect : url=http://localhost:8080/user/register
2017-11-22 16:46:23.592 INFO 10526 --- [nio-8080-exec-1] com.zyr.demo.aspect.HttpAspect : method=POST
2017-11-22 16:46:23.592 INFO 10526 --- [nio-8080-exec-1] com.zyr.demo.aspect.HttpAspect : ip=127.0.0.1
2017-11-22 16:46:23.592 INFO 10526 --- [nio-8080-exec-1] com.zyr.demo.aspect.HttpAspect : class_method=com.zyr.demo.controller.UserController.register
2017-11-22 16:46:23.592 INFO 10526 --- [nio-8080-exec-1] com.zyr.demo.aspect.HttpAspect : args=User{name='bob', age=22, password='123456'}
2017-11-22 16:46:23.592 INFO 10526 --- [nio-8080-exec-1] com.zyr.demo.aspect.HttpAspect : -------------------------------Request Log End------------------------------------------------
2017-11-22 16:46:23.595 INFO 10526 --- [nio-8080-exec-1] com.zyr.demo.aspect.HttpAspect : response=<200 OK,success,{}>

三、最後

本文介紹了Spring Boot中使用AOP的一個簡單例子，可以看見，在Spring Boot中很輕鬆就能使用AOP。

本文代碼已上傳至我的GitHub倉庫，進入以後將branches切換爲5-AOP即可看見。

前篇：
Spring Boot實際應用講解（一）：Hello World
Spring Boot實際應用講解（二）：配置詳解
Spring Boot實際應用講解（三）：表單驗證
Spring Boot實際應用講解（四）：RESTful API

後續將推出以下文章，敬請關注！

Spring Boot實際應用講解（六）：MySQL + Spring-data-jpa(Hibernate)
Spring Boot實際應用講解（七）：統一異常處理
Spring Boot實際應用講解（八）：MySQL + Mybatis
Spring Boot實際應用講解（九）：MySQL + Mybatis + Redis

文中若有錯之處，還請各位批評指正，謝謝！

原文作者/ZYRzyr
原文鏈接:http://www.jianshu.com/p/93216bf41182

請進入這裏獲取授權：https://101709080007647.bqy.mobi