SpringBoot + AOP 统一处理日志

朱雀 2020-10-17 16:07 799阅读 1赞

Springboot + AOP 统一处理日志。然后系统日志持久化到文件保存起来，当程序方便发生问题的时候，能够快速、准确的定位到问题的所在。SpringBoot + Log4j 每天输出一个日志文件(分级别的)

------

### 一、AOP框架AspectJ

AspectJ是基于java开发的aop框架，自spring2.0以后，springaop引入对他支持。

使用aspectJ实现aop由两种方式：基于xml和基于注解

相对来说注解方式更加简单，开发中常用注解方式。

**基于注解的声明式aspectJ**

| **注解名称**        | **描述**                                                |
| ------------------- | ------------------------------------------------------- |
| **@Aspect**         | 定义一个切面                                            |
| **@Pointcut**       | 定义切面表达式                                          |
| **@Before**         | 定义前置通知，相当于BeforeAdvice                        |
| **@AfterReturning** | 定义后置通知，相当于AfterReturningAdvice                |
| **@Around**         | 定义环绕通知，相当于MethodIntercetor                    |
| **@AfterThrowing**  | 定义异常通知来处理程序中未处理的异常，相当于ThrowAdvice |
| **@After**          | 定义最终final通知                                       |

### 二、Springboot + AOP 统一处理日志

pom.xml

```xml

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

切面类

```java
package com.example.springBootdemo.aop;
import java.util.Objects;
import javax.servlet.http.HttpServletRequest;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.After;
import org.aspectj.lang.annotation.AfterReturning;
import org.aspectj.lang.annotation.AfterThrowing;
import org.aspectj.lang.annotation.Around;
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.core.annotation.Order;
import org.springframework.stereotype.Component;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;
/**
 * 切面类，日志
 * @author luolei
 * @date 2019年2月11日
 */
@Aspect //声明为切面类
@Component
@Order(1) //标记切点的优先级,i越小,优先级越高
public class MyAspectLog {
    //定义切点表达式：*，第一个返回值，第二个类名，第三个方法名
     @Pointcut("execution(public * com.example.springBootdemo.service.*.*(..))")
    //使用一个返回值为void，方法体为空的方法来命名切入点
    public void myPointCut(){};
    private final Logger logger = LoggerFactory.getLogger(getClass());
    //前置通知
    @Before("myPointCut()")
    public void myBefore(JoinPoint joinPoint) {
        logger.info("-----------@Before 前置通知-----------");
        logger.info("前置通知：模拟执行权限检查...");
        logger.info("目标类是={}", joinPoint.getTarget());
        logger.info("被植入增强目标为={}", joinPoint.getSignature());
        ServletRequestAttributes attributes= (ServletRequestAttributes)RequestContextHolder.getRequestAttributes();
        HttpServletRequest request =attributes.getRequest();
        //url
        logger.info("请求路径URL={}",request.getRequestURL());
        //method
        logger.info("请求方式Method={}",request.getMethod());
        //ip
        logger.info("请求IP={}",request.getRemoteAddr());
        //类方法
        logger.info("请求类方法ClassMethod={}",joinPoint.getSignature().getDeclaringTypeName()+"."+joinPoint.getSignature().getName());
        //参数
        logger.info("请求参数Args={}",joinPoint.getArgs());
    }
    //后置通知
/*  @AfterReturning("myPointCut()")
    public void myAfterReturning(JoinPoint joinPoint) {
        logger.info("-----------@AfterReturning 后置通知-----------");
        logger.info("后置通知：模拟记录日志...");
        logger.info("返回值 response={}", joinPoint.toString());
    }*/
    //后置通知
    @AfterReturning(returning = "objects", pointcut = "myPointCut()")
    public void myAfterReturning(Object objects) {
        logger.info("-----------@AfterReturning 后置通知-----------");
        logger.info("后置通知：模拟记录日志...");
        logger.info("返回值 response={}", objects);
    }
    /**
     * 环绕通知
     * @param proceedingJoinPoint 是JoinPoint的子接口，表示可以执行目标方法
     * @return Object
     * 必须接收一个参数，类型为ProceedingJoinPoint
     * @必须 throws Throwable
     */
    @Around("myPointCut()")
    public Object myAround(ProceedingJoinPoint proceedingJoinPoint) 
            throws Throwable{
        //开始
        logger.info("-----------@Around 环绕通知start-----------");
        logger.info("环绕开始：开启之前，模拟开启事务...");
        long time = System.currentTimeMillis();
        //执行当前目标方法
        Object obj=proceedingJoinPoint.proceed();
        //结束
        logger.info("环绕结束：模拟关闭事务...");
        time = System.currentTimeMillis() - time;
        logger.info("方法用时Time={}", time +"（毫秒）");
        logger.info("-----------@Around 环绕通知end-----------");
        return obj;
    }
    //异常通知
    @AfterThrowing(value="myPointCut()", throwing="e")
    public void myAfterThrowing(JoinPoint joinPoint,Throwable e) {
        logger.info("-----------@AfterThrowing 异常通知-----------");
        logger.info("异常通知：出错了"+ e);
        logger.info("异常通知：出错了getStackTrace={}", e.getStackTrace());
        logger.info("异常通知：出错了Throwable...具体如下", e);
    }
    //最终通知
    @After("myPointCut()")
    public void myAfter() {
        logger.info("-----------@After 最终通知-----------");
        logger.info("最终通知：模拟方法结束后的释放资源...");
    }
}
```