【SpringBoot】SpringBoot中使用AOP实现日志记录功能

在Spring Boot中，使用AOP（面向切面编程）来实现日志记录功能是一种常见的实践。这种方式可以帮助我们在不侵入业务代码的情况下，对应用的多个方面进行横切关注点的处理，比如日志记录、事务管理等。

AOP的基本概念

在Spring框架中，AOP允许我们定义“切面”（Aspect），即一组关注点的模块化。切面通常通过“通知”（Advice）和“切入点”（Pointcut）来定义。通知指的是在特定的切入点上要执行的操作，而切入点则是指在哪些方法上应用这些通知。

创建Spring Boot项目

首先，确保你已经创建了一个Spring Boot项目，并在pom.xml中添加了所需的依赖：

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

创建日志切面

接下来，我们将创建一个日志切面，用于记录方法调用的相关信息。

import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.After;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;

@Component
@Aspect
public class LoggingAspect {

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

    @Before("execution(* com.example.demo.service..*(..))")
    public void logBefore(JoinPoint joinPoint) {
        logger.info("方法调用前: " + joinPoint.getSignature().getName());
    }

    @After("execution(* com.example.demo.service..*(..))")
    public void logAfter(JoinPoint joinPoint) {
        logger.info("方法调用后: " + joinPoint.getSignature().getName());
    }
}

在上述代码中，我们定义了一个LoggingAspect类，并使用@Aspect注解标记它。该切面针对com.example.demo.service包中的所有方法进行日志记录。

• @Before注解表明在目标方法执行前需要执行logBefore方法；
• @After注解表明在目标方法执行后需要执行logAfter方法。

创建一个服务

接下来，我们创建一个简单的服务，供切面使用。

import org.springframework.stereotype.Service;

@Service
public class UserService {

    public void addUser(String user) {
        // 模拟添加用户的业务逻辑
        System.out.println("添加用户: " + user);
    }

    public void deleteUser(String user) {
        // 模拟删除用户的业务逻辑
        System.out.println("删除用户: " + user);
    }
}

创建控制器

然后，我们创建一个控制器来测试我们的日志切面。

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class UserController {

    private final UserService userService;

    public UserController(UserService userService) {
        this.userService = userService;
    }

    @GetMapping("/addUser/{name}")
    public String addUser(@PathVariable String name) {
        userService.addUser(name);
        return "用户添加成功";
    }

    @GetMapping("/deleteUser/{name}")
    public String deleteUser(@PathVariable String name) {
        userService.deleteUser(name);
        return "用户删除成功";
    }
}

启动Spring Boot应用

当你启动应用并访问/addUser/张三或/deleteUser/李四时，你将在控制台中看到类似如下的日志输出：

2023-05-05 12:00:00 INFO  com.example.demo.LoggingAspect: 方法调用前: addUser
添加用户: 张三
2023-05-05 12:00:00 INFO  com.example.demo.LoggingAspect: 方法调用后: addUser
2023-05-05 12:00:00 INFO  com.example.demo.LoggingAspect: 方法调用前: deleteUser
删除用户: 李四
2023-05-05 12:00:00 INFO  com.example.demo.LoggingAspect: 方法调用后: deleteUser

总结

通过以上步骤，我们成功地使用Spring AOP实现了日志记录功能。这种方式的优点在于，将日志记录的关注点与业务逻辑分离，使代码更清晰、可维护。AOP不仅可以用来记录日志，还可以用于事务管理、权限验证等多种场景，是一个非常强大的工具。