当前位置：首页 > article >正文

关于springboot中使用AOP方式记录日志的思路和灵感

article 2025/2/21 0:40:44

日志级别

切点和通知区别：

在项目中实现日志记录功能方法

日志持久化

AOP方式：

1. 添加AOP依赖

2. 创建日志切面

3. 配置application.properties或application.yml

4. 使用切面

5. 测试日志功能

日志级别

通过设置不同的日志级别来查看不同程度的问题信息：

切点和通知区别：

切点（Pointcut）：定义了哪些方法会被增强，即“在哪里”进行增强。
通知（Advice）：定义了在匹配到切点时应该执行的具体行为，即“做什么”。

在项目中实现日志记录功能方法

使用AOP来实现日志记录功能
使用lombok框架的

配置Spring AOP：确保Spring AOP自动代理开启。

spring:
  aop:
    auto: true #启动aop配置

如何设置根日志记录级别：(在yml文件中)

logging:
  level:
    root:error

也可以针对某个子目录设置日志级别：

logging:
  level:
    root:error
    com:
      lyp:
        controller:debug

日志持久化

在生产环境中，我们常常把日志信息保存下来。而将日志信息保存下来的过程就叫做日志持久化

logging:
  file:
    name: D:\\home\\log\\spring-1024.log

使用lombok简单记录日志

AOP方式：

使用AOP（面向切面编程）在Spring Boot项目中添加日志功能是一种非常灵活和强大的方法。以下是通过AOP添加日志功能的步骤：

1. 添加AOP依赖

首先，确保你的项目中包含了Spring AOP和AspectJ的依赖。对于Maven项目，可以在pom.xml中添加如下依赖：

<dependencies>
  <!-- Spring Boot AOP starter -->
  <dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-aop</artifactId>
  </dependency>

  <!-- AspectJ -->
  <dependency>
    <groupId>org.aspectj</groupId>
    <artifactId>aspectjweaver</artifactId>
  </dependency>
</dependencies>

2. 创建日志切面

创建一个使用@Aspect注解的类来定义日志切面，并在其中定义切点和通知。


import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Pointcut;
import org.aspectj.lang.annotation.Before;
import org.aspectj.lang.annotation.After;
import org.aspectj.lang.annotation.AfterReturning;
import org.aspectj.lang.annotation.AfterThrowing;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.aspectj.lang.JoinPoint;

@Aspect
@Component
public class LoggingAspect {

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

    // 定义切点，这里以所有包下的类的所有方法为例子
    @Pointcut("execution(* *..*(..))")
    public void loggable() {
    }

    // 前置通知：在方法执行前执行
    @Before("loggable()")
    public void beforeAdvice(JoinPoint joinPoint) {
        logger.info("Before method: " + joinPoint.getSignature().getName());
    }

    // 后置通知：在方法执行后执行
    @After("loggable()")
    public void afterAdvice(JoinPoint joinPoint) {
        logger.info("After method: " + joinPoint.getSignature().getName());
    }

    // 返回通知：在方法成功执行后执行
    @AfterReturning(pointcut = "loggable()", returning = "result")
    public void afterReturningAdvice(JoinPoint joinPoint, Object result) {
        logger.info("After returning method: " + joinPoint.getSignature().getName() + ", returned: " + result);
    }

    // 异常通知：在方法抛出异常后执行
    @AfterThrowing(pointcut = "loggable()", throwing = "error")
    public void afterThrowingAdvice(JoinPoint joinPoint, Exception error) {
        logger.error("Exception in method: " + joinPoint.getSignature().getName() + ", exception: " + error);
    }
}

3. 配置`application.properties`或`application.yml`

确保你的日志配置是正确的，以便日志可以被正确记录。

# application.properties
logging.level.root=INFO
logging.level.org.springframework.web=DEBUG

4. 使用切面

一旦切面类被Spring容器管理，并且切点表达式匹配到相应的方法，AOP框架就会自动执行定义在切面类中的通知。

5. 测试日志功能

运行你的Spring Boot应用并调用一些方法，检查日志输出是否符合预期。

通过以上步骤，你可以在Spring Boot项目中使用AOP来添加日志功能。这种方式的好处是可以集中管理日志逻辑，减少业务代码的复杂性，并且可以灵活地调整日志级别和输出格式。

@Order(6)
@Aspect
@Component
@Slf4j
public class BcocServiceLogAspect {

    Logger logger = org.slf4j.LoggerFactory.getLogger(BcocServiceLogAspect.class);

    @Pointcut("execution(public * com.ztesoft.local.project.openservice.bcoc.*.*(..))")
    public void callIntfTimes(){
        logger.info("callIntfTimes 开始执行了...");
    }
    //统计请求的处理时间
    ThreadLocal<Long> startTime = new ThreadLocal<>();

    @Before("callIntfTimes()")
    public void doBefore(JoinPoint joinPoint) throws Throwable{
        long time = System.currentTimeMillis() ;
        startTime.set(time);
        //接收到请求，记录请求内容
        //记录请求的内容
        logger.info("doBefore: time的值为:"+time);
    }

    @AfterReturning(returning = "ret" , pointcut = "callIntfTimes()")
    public void doAfterReturning(Object ret){
        //处理完请求后，返回内容
        logger.info("方法返回值:"+ JSON.toJSONString(ret) +",方法执行时间:"+ (System.currentTimeMillis() - startTime.get()));
        startTime.remove();
    }

}