java面向切面编程AOP案例,记录请求日志

原创

mob649e8154f2e5 2023-08-20 05:44:52 ©著作权

©著作权归作者所有：来自51CTO博客作者mob649e8154f2e5的原创作品，请联系作者获取转载授权，否则将追究法律责任

Java面向切面编程AOP案例：记录请求日志

面向切面编程（Aspect-Oriented Programming，AOP）是一种编程范式，主要用于解决横切关注点（cross-cutting concerns）的问题。横切关注点是指在一个应用程序的多个模块中存在的相同功能或行为，例如日志记录、安全性检查等。AOP通过在横切关注点上织入代码，实现了模块化和重用性。

在Java中，我们可以使用AspectJ来实现AOP。AspectJ是一个成熟、功能强大的AOP框架，它支持广泛的AOP功能，包括方法拦截、前置通知、后置通知、异常处理等。下面我们将以一个记录请求日志的案例来介绍Java AOP的使用。

案例背景

假设我们有一个Web应用程序，包含多个RESTful API接口。我们希望在每次请求到达接口时记录请求的相关信息，例如请求的URL、请求方法、请求参数等。

实现步骤

首先，我们需要添加AspectJ的依赖到项目中。可以通过Maven或Gradle等构建工具来实现。

<!-- Maven -->
<dependency>
    <groupId>org.aspectj</groupId>
    <artifactId>aspectjweaver</artifactId>
    <version>1.9.6</version>
</dependency>

接下来，我们需要定义一个切面（Aspect）来实现请求日志记录的功能。切面是一个类，其中包含了一组切点和通知的定义。切点用于选择目标方法，通知用于在目标方法执行前后织入代码。

import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.AfterReturning;
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.stereotype.Component;

@Aspect
@Component
public class RequestLoggingAspect {
    private final Logger logger = LoggerFactory.getLogger(this.getClass());

    @Pointcut("execution(* com.example.api.*Controller.*(..))")
    public void controllerMethods() {}

    @Before("controllerMethods()")
    public void logBefore(JoinPoint joinPoint) {
        String methodName = joinPoint.getSignature().getName();
        String className = joinPoint.getTarget().getClass().getSimpleName();
        Object[] args = joinPoint.getArgs();

        logger.info("Request received for {}.{} with arguments: {}", className, methodName, args);
    }

    @AfterReturning(pointcut = "controllerMethods()", returning = "result")
    public void logAfterReturning(JoinPoint joinPoint, Object result) {
        String methodName = joinPoint.getSignature().getName();
        String className = joinPoint.getTarget().getClass().getSimpleName();

        logger.info("Request processed for {}.{} with result: {}", className, methodName, result);
    }
}

在上述代码中，我们使用了AspectJ的注解来定义切面和通知。@Aspect注解用于标识该类为切面类，@Component注解用于将切面类交给Spring容器管理。@Pointcut注解定义了一个切点，它选择了所有位于com.example.api包下的Controller类的所有方法作为目标方法。@Before注解表示在目标方法执行前织入代码，@AfterReturning注解表示在目标方法执行后织入代码。

最后，我们需要在Spring配置文件中开启AspectJ自动代理的支持。
```
<aop:aspectj-autoproxy />
```
这样，Spring将会自动检测并代理所有带有@Aspect注解的切面类。

案例测试

现在我们可以启动Web应用程序，并发送请求来测试我们的记录请求日志功能。

假设我们有一个UserController类，其中包含一个名为getUser的方法。

@RestController
public class UserController {
    @GetMapping("/users/{id}")
    public User getUser(@PathVariable String id) {
        // 获取用户信息的逻辑
    }
}

当我们发送一个GET请求到/users/123时，切面将会记录请求的相关信息。