springboot/spring使用AOP

AOP是什么

使用AOP之前得先知道AOP是什么。如果不了解，请自行百度或查看官网。

大佬翻译的官方文档

官网文档

本文所有的说明均可在官网找到

AOP可以用来干嘛

1. 做日志记录：这个应该是最常见的；记录系统的用户访问情况(访问接口，参数，返回结果等)
2. 需求变更/追加补救：(名字是我随便打的)。比如说现在有一个已经上线的系统做二开，需要在原先已经有的表添加字段，并写入数据，涉及到多个表(3个，10个…)，几十个方法，这个时候需要怎么做？
3. 没想到…

对于问题2来说，一个一个修改这几十个方法。但这样同时伴随着高风险，不是最好的解决方案。用AOP会是一个更好的解决方案。(只是个例子，这里不讨论)

概念

Pointcut：切点，主要是决定处理如权限校验、日志记录等在何处切入业务代码中（即织入切面）。切点分为 execution 方式和 annotation 方式。前者可以用路径表达式指定哪些类织入切面，后者可以指定被哪些注解修饰的代码织入切面。

Advice：处理（通知），包括处理时机和处理内容。处理内容就是要做什么事，比如校验权限和记录日志。处理时机就是在什么时机执行处理内容，分为前置处理（即业务代码执行前）、后置处理（业务代码执行后）等。这也回答了我们之前提到的什么时候切入，切入过后应该要做哪些事情。

Aspect：切面，即 Pointcut 和 Advice,在代码中就是我们定义的这个切面的类，选择在什么地方织入。

Joint point：连接点，是程序执行的一个点。例如，一个方法的执行或者一个异常的处理。在 AOP 中，一个连接点总是代表着一个方法执行。

Weaving：织入，就是通过动态代理的方式在目标对象方法中执行处理内容的过程。

示例

基于spring boot项目

1. 导包

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

2. 添加类

日志的@Slf4j log随意，自己配置好就行

@Pointcut自行修改

import lombok.extern.slf4j.Slf4j;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.*;
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.Map;
import java.util.Objects;

/**
 * @Description
 * @Author Bernie
 * @Date 2023/5/29 15:23
 **/
@Aspect
@Component
@Slf4j
public class AopLog {

    private static final String START_TIME = "request-start";

    /**
     * 切入点
     */
    @Pointcut("execution(public * com.fang.demo.controller.*Controller.*(..))")
    public void log() {

    }

    /**
     * 前置操作
     * @param point
     */
    @Before("log()")
    public void beforeLog(JoinPoint point) {
        ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();

        HttpServletRequest request = Objects.requireNonNull(attributes).getRequest();

        log.info("【请求 URL】：{}", request.getRequestURL());
        log.info("【请求 IP】：{}", request.getRemoteAddr());
        log.info("【请求类名】：{}，【请求方法名】：{}", point.getSignature().getDeclaringTypeName(), point.getSignature().getName());

        Map<String, String[]> parameterMap = request.getParameterMap();
        log.info("【请求参数】：{}，", parameterMap.toString());
        Long start = System.currentTimeMillis();
        request.setAttribute(START_TIME, start);
    }


    /**
     * 环绕操作
     * @param point
     * @return
     * @throws Throwable
     */
    @Around("log()")
    public Object aroundLog(ProceedingJoinPoint point) throws Throwable {
        Object result = point.proceed();
        log.info("【返回值】：{}", result.toString());
        return result;
    }

    /**
     * 后置操作
     */
    @AfterReturning("log()")
    public void afterReturning() {
        ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
        HttpServletRequest request = Objects.requireNonNull(attributes).getRequest();

        Long start = (Long) request.getAttribute(START_TIME);
        Long end = System.currentTimeMillis();
        log.info("【请求耗时】：{}毫秒", end - start);

        String header = request.getHeader("User-Agent");
        log.info("【浏览器信息】：{}", header);
    }

}

3. 自己写comtroller测试

有疑问看官方文档，最正确的答案！！！！