【Spring学习】AOP实现日志记录

AOP知识点

AOP，面向切面编程。通过预编译方式和运行时动态代理实现在不修改源代码的情况下给程序动态统一添加功能的一种技术。

AOP编程思想就是把很多类对象中的横切问题点，从业务逻辑中分离出来，减少代码的冗余和降低模块间的耦合度，提高开发效率。

简单说就是：把程序里重复的代码抽取出来，在需要执行的时候，使用动态代理的技术，在不修改源码的基础上，对已有方法进行增强。常用于日志记录、事务处理、权限验证等等。

AOP的核心原理

Spring AOP就是基于动态代理的，通过JDK动态代理或CGLib代理在运行时期在对象初始化阶段织入代码的。如果要代理的对象，实现了某个接口，那么AOP会使用JDK Proxy，去创建代理对象，而对于没有实现接口的对象， AOP会使用CGLib生成一个被代理对象的子类来作为代理。

AOP中主要概念理解

• aspect：切面，切面由切点和通知组成，即包括横切逻辑的定义也包括连接点的定义；
• pointcut：切点，每个类都拥有多个连接点，可以理解是连接点的集合；
• joinpoint：连接点，程序执行的某个特定位置，如某个方法调用前后等；
• weaving：织入，将增强添加到目标类的具体连接点的过程；
• advice：通知，织入到目标类连接点上的一段代码，就是增强到什么地方？增强什么内容？
• target：目标对象，通知织入的目标类；
• aop Proxy：代理对象，即增强后产生的对象。

AOP五种通知工作

• 前置通知：在目标方法调用之前执行，可以获得切入点信息；
• 后置通知：在目标方法执行后执行，目标方法有异常不执行；
• 异常通知：在目标方法抛出异常时执行，可以获取异常信息；
• 最终通知：在目标方法执行后执行，无论是否有异常都执行；
• 环绕通知：最强大的通知类型，在目标方法执行前后操作，可以阻止目标方法执行。

实现AOP的三种方式

• 通过Spring API实现；
• 自定义类来实现AOP；
• 使用注解实现（常用）。

Spring里执行步骤

1、定义一个切面类Aspect

声明一个切面类，增加@Component和@Aspect两个注解，同时SpringBoot要引入spring-boot-stater-aop依赖包。

2、定义切点Pointcut

定义切点，并定义切点在哪些地方执行，采用@Pointcut注解完成，如@Pointcut(public * com.xxx.xxx.*.*(...))

规则：修饰符(可以不写)+返回类型+包下的类+方法+方法参数 “*”代表不限，“..”两个点代表参数不限，例如：

切点名称myPointcut，在返回类型不限的com.binlog.study.aop.controller包下的所有类，所有方法并且参数不限。

参考：@Pointcut(value="execution(* com.binlog.study.aop.controller.*.*(..))")

3、定义Advice通知

利用通知的5种类型注解@Before、@After、@AfterReturning、@AfterThrowing、@Around来完成在某些切点的增强动作。

使用Spring实现AOP

1、创建一个新的springboot工程，然后添加依赖包：

    org.aspectj
    aspectjweaver

2、分别创建两个包，一个是aspect和controller。

3、controller包里创建一个普通访问类AopUserController，代码如下：

import org.springframework.web.bind.annotation.*;
import java.util.ArrayList;
import java.util.List;
@RestController
@RequestMapping("/api/aop")
public class AopUserController {
    @GetMapping("/getUserByName")
    public String name(@RequestParam("name") String name) {
        return "Hello：" + name;
    }
    @GetMapping("/getUserList")
    public List getUser() {
        List list = new ArrayList<>();
        list.add("张三");
        list.add("李四");
        list.add("王五");
        return list;
    }
}

4、aspect包里创建日志切面类AopLog，代码如下：

import com.fasterxml.jackson.databind.ObjectMapper;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.*;
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 AopLog {
    private Logger logger = LoggerFactory.getLogger(this.getClass());
    ThreadLocal startTime = new ThreadLocal<>();
    //定义切点
    @Pointcut(value = "execution(* com.binlog.study.aop.controller.*.*(..))")
    public void aopWebLog() {
    }
    //使用环绕通知
    @Around("aopWebLog()")
    public Object myLogger(ProceedingJoinPoint pjp) throws Throwable {
        startTime.set(System.currentTimeMillis());
        //使用ServletRequestAttributes请求上下文获取方法更多
        ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
        HttpServletRequest request = attributes.getRequest();
        String className = pjp.getSignature().getDeclaringTypeName();
        String methodName = pjp.getSignature().getName();
        //使用数组来获取参数
        Object[] array = pjp.getArgs();
        ObjectMapper mapper = new ObjectMapper();
        //执行函数前打印日志
        logger.info("调用前：{}：{},传递的参数为：{}", className, methodName, mapper.writeValueAsString(array));
        logger.info("URL:{}", request.getRequestURL().toString());
        logger.info("IP地址：{}", request.getRemoteAddr());
        //调用整个目标函数执行
        Object obj = pjp.proceed();
        //执行函数后打印日志
        logger.info("调用后：{}：{},返回值为：{}", className, methodName, mapper.writeValueAsString(obj));
        logger.info("耗时：{}ms", System.currentTimeMillis() - startTime.get());
        return obj;
    }
}

5、项目启动后，浏览器页面访问：

（1）http://localhost:8060/api/aop/getUserByName?name=张三

控制台输出结果：

（2）http://localhost:8060/api/aop/getUserList

控制台输出结果：

至此一个简单的日志记录就完成了。平时开发里还需根据业务进行优化或补充！