SpringBoot2系列——Aspectj使用

前言

• 本文只做記錄，不做具體源碼解析。
• 博主也是初學，系列文章只做入門，不建議當做范文。

代碼實現

• 只需要引入starter-aop即可

Maven配置

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

<!--簡化開發-->
 <dependency>
   <groupId>org.projectlombok</groupId>
   <artifactId>lombok</artifactId>
 </dependency>

項目結構

• 在工程目錄下新建一個Aspectj.java類，名字可隨意

• 以下是代碼實現，注釋以寫明白。

package com.itheima.boot.aop;

import lombok.extern.slf4j.Slf4j;
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.springframework.stereotype.Component;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;

import javax.servlet.http.HttpServletRequest;
import java.util.Arrays;

@Slf4j
@Aspect
@Component
public class Aspectj {
    @Pointcut("execution(public * com.itheima.boot.controller..*.*(..))")
    public void webLog(){}

    @Before("webLog()")
    public void doBefore(JoinPoint joinPoint) throws Throwable {
        // 接收到請求，記錄請求內容
        ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
        assert attributes != null;
        HttpServletRequest request = attributes.getRequest();

        // 記錄下請求內容
        log.info("URL : " + request.getRequestURL().toString());
        log.info("HTTP_METHOD : " + request.getMethod());
        log.info("IP : " + request.getRemoteAddr());
        log.info("CLASS_METHOD : " + joinPoint.getSignature().getDeclaringTypeName() + "." + joinPoint.getSignature().getName());
        log.info("ARGS : " + Arrays.toString(joinPoint.getArgs()));
    }

    /**
     * 1)pointcut/value:這兩個屬性的作用是一樣的，它們都屬於指定切入點對應的切入表達式。一樣既可以是已有的切入點，也可直接定義切入點表達式。
     * 當指定了pointcut屬性值后，value屬性值將會被覆蓋。
     *
     * 2)returning:該屬性指定一個形參名，用於表示Advice方法中可定義與此同名的形參，該形參可用於訪問目標方法的返回值。
     * 除此之外，在Advice方法中定義該形參（代表目標方法的返回值）時指定的類型，會限制目標方法必須返回指定類型的值或沒有返回值。
     *
     */
    @AfterReturning(returning = "ret",pointcut = "webLog()")
    public void doAfterReturning(Object ret) {
        // 處理完請求，返回內容
        log.info("RESPONSE : " + ret);
    }
}