AOP

1.什麼是 AOP ？

AOP 的全稱為 Aspect Oriented Programming，譯為面向切面程式設計，是通過預編譯方式和執行期動態代理實現核心業務邏輯之外的橫切行為的統一維護的一種技術。AOP 是面向物件程式設計（OOP）的補充和擴充套件。
利用 AOP 可以對業務邏輯各部分進行隔離，從而達到降低模組之間的耦合度，並將那些影響多個類的公共行為封裝到一個可重用模組，從而到達提高程式的複用性，同時提高了開發效率，提高了系統的可操作性和可維護性。

2.為什麼要用 AOP ？

在實際的 Web 專案開發中，我們常常需要對各個層面實現日誌記錄，效能統計，安全控制，事務處理，異常處理等等功能。如果我們對每個層面的每個類都獨立編寫這部分程式碼，那久而久之程式碼將變得很難維護，所以我們把這些功能從業務邏輯程式碼中分離出來，聚合在一起維護，而且我們能靈活地選擇何處需要使用這些程式碼。

3.AOP 的核心概念

Spring AOP

1.簡介

AOP 是 Spring 框架中的一個核心內容。在 Spring 中，AOP 代理可以用 JDK 動態代理或者 CGLIB 代理 CglibAopProxy 實現。Spring 中 AOP 代理由 Spring 的 IOC 容器負責生成和管理，其依賴關係也由 IOC 容器負責管理。

2.相關注解

其中 @Before、@After、@AfterReturning、@Around、@AfterThrowing 都屬於通知（Advice）。

利用 AOP 實現 Web 日誌處理

1.構建專案

2.新增依賴

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

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
        <!-- 熱部署模組 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-devtools</artifactId>
            <optional>true</optional> <!-- 這個需要為 true 熱部署才有效 -->
        </dependency>
        <!-- Spring AOP -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-aop</artifactId>
        </dependency>
    </dependencies>

3.Web 日誌註解

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface ControllerWebLog {
     String name();//所呼叫介面的名稱
     boolean intoDb() default false;//標識該條操作日誌是否需要持久化儲存
}

4.實現切面邏輯

@Aspect
@Component
@Order(100)
public class WebLogAspect {

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

    private ThreadLocal<Map<String, Object>> threadLocal = new ThreadLocal<Map<String, Object>>();

    /**
     * 橫切點
     */
    @Pointcut("execution(public * cn.zwqh.springboot.controller..*.*(..))")
    public void webLog() {
    }
    /**
     * 接收請求，並記錄資料
     * @param joinPoint
     * @param controllerWebLog
     */
    @Before(value = "webLog()&& @annotation(controllerWebLog)")
    public void doBefore(JoinPoint joinPoint, ControllerWebLog controllerWebLog) {
        // 接收到請求
        RequestAttributes ra = RequestContextHolder.getRequestAttributes();
        ServletRequestAttributes sra = (ServletRequestAttributes) ra;
        HttpServletRequest request = sra.getRequest();
        // 記錄請求內容，threadInfo儲存所有內容
        Map<String, Object> threadInfo = new HashMap<>();
        logger.info("URL : " + request.getRequestURL());
        threadInfo.put("url", request.getRequestURL());
        logger.info("URI : " + request.getRequestURI());
        threadInfo.put("uri", request.getRequestURI());
        logger.info("HTTP_METHOD : " + request.getMethod());
        threadInfo.put("httpMethod", request.getMethod());
        logger.info("REMOTE_ADDR : " + request.getRemoteAddr());
        threadInfo.put("ip", request.getRemoteAddr());
        logger.info("CLASS_METHOD : " + joinPoint.getSignature().getDeclaringTypeName() + "."
                + joinPoint.getSignature().getName());
        threadInfo.put("classMethod",
                joinPoint.getSignature().getDeclaringTypeName() + "." + joinPoint.getSignature().getName());
        logger.info("ARGS : " + Arrays.toString(joinPoint.getArgs()));
        threadInfo.put("args", Arrays.toString(joinPoint.getArgs()));
        logger.info("USER_AGENT"+request.getHeader("User-Agent"));
        threadInfo.put("userAgent", request.getHeader("User-Agent"));
        logger.info("執行方法：" + controllerWebLog.name());
        threadInfo.put("methodName", controllerWebLog.name());
        threadLocal.set(threadInfo);
    }
    /**
     * 執行成功後處理
     * @param controllerWebLog
     * @param ret
     * @throws Throwable
     */
    @AfterReturning(value = "webLog()&& @annotation(controllerWebLog)", returning = "ret")
    public void doAfterReturning(ControllerWebLog controllerWebLog, Object ret) throws Throwable {
        Map<String, Object> threadInfo = threadLocal.get();
        threadInfo.put("result", ret);
        if (controllerWebLog.intoDb()) {
            //插入資料庫操作
            //insertResult(threadInfo);
        }
        // 處理完請求，返回內容
        logger.info("RESPONSE : " + ret);
    }
    /**
     * 獲取執行時間
     * @param proceedingJoinPoint
     * @return
     * @throws Throwable
     */
    @Around(value = "webLog()")
    public Object doAround(ProceedingJoinPoint proceedingJoinPoint) throws Throwable {
        long startTime = System.currentTimeMillis();
        Object ob = proceedingJoinPoint.proceed();
        Map<String, Object> threadInfo = threadLocal.get();
        Long takeTime = System.currentTimeMillis() - startTime;
        threadInfo.put("takeTime", takeTime);
        logger.info("耗時：" + takeTime);
        threadLocal.set(threadInfo);
        return ob;
    }
    /**
     * 異常處理
     * @param throwable
     */
    @AfterThrowing(value = "webLog()", throwing = "throwable")
    public void doAfterThrowing(Throwable throwable) {
        RequestAttributes ra = RequestContextHolder.getRequestAttributes();

        ServletRequestAttributes sra = (ServletRequestAttributes) ra;

        HttpServletRequest request = sra.getRequest();
        // 異常資訊
        logger.error("{}介面呼叫異常，異常資訊{}", request.getRequestURI(), throwable);
    }

}

5.測試介面

@RestController
@RequestMapping("/user")
public class UserController {

    @GetMapping("/getOne")
    @ControllerWebLog(name = "查詢", intoDb = true)
    public String getOne(Long id, String name) {

        return "1234";
    }
}

6.執行測試

瀏覽器請求：http://127.0.0.1:8080/user/getOne?id=1&name=zwqh ，可以看到後臺日誌輸出：

小結

日誌記錄只是一個簡單的示例，而 Spring AOP 的應用讓整個系統變的更加有條不紊，在其他場景應用也很強大。
它幫助我們降低模組間耦合度，提高程式複用性，提高開發效率，提高系統可做性和可維護性。

示例程式碼

github

碼雲

非特殊說明，本文版權歸 朝霧輕寒 所有，轉載請註明出處.

原文標題：Spring Boot 2.X(八)：Spring AOP 實現簡單的日誌切面

原文地址：https://www.zwqh.top/article/info