Spring aop实现日志的打印

本文介绍了一个使用Spring AOP实现的Web日志切面案例,详细展示了如何通过AOP在Controller方法前后记录请求和响应日志,包括请求URL、HTTP方法、调用方法、客户端IP及请求参数等关键信息。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

package com.xiaochuang;

import com.google.gson.Gson;
import org.apache.http.protocol.RequestContent;
import org.aspectj.lang.JoinPoint;
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 aopWebLogAspect {
    private final static Logger logger = LoggerFactory.getLogger(aopWebLogAspect.class);

    /**
     * 以Controller包下定义所有请求的方法
     */
    @Pointcut("com.xiaochuang")
    public void webLog() {
    }

    /**
     * 在切入点之前进行
     */
    @Before("webLog()")
    public void doBefore(JoinPoint joinPoint) {
        ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
        HttpServletRequest request = attributes.getRequest();
        logger.info("========================================== Start ==========================================");
        //打印请求参数相关日志
        // 打印请求 url
        logger.info("url:{}", request.getRequestURI().toString());
        // 打印 Http method
        logger.info("HTTP Method:{}", request.getMethod());
        // 打印调用 controller 的全路径以及执行方法
        logger.info("Class Method:{}.{}", joinPoint.getSignature().getDeclaringTypeName(), joinPoint.getSignature().getName());
        // 打印请求的 IP
        logger.info("IP :{}", request.getRemoteAddr());
        // 打印请求入参
        logger.info("Request Args:{}", new Gson().toJson(joinPoint.getArgs()));
    }

    /**
     * 在切入点之后执行
     */
    @After("webLog()")
    public void doAfter() {
        logger.info("========================================== end ==========================================");
    }

    @Around("webLog()")
    public Object doAroud(ProceedingJoinPoint proceedingJoinPoint) throws Throwable {
        long startTime = System.currentTimeMillis();
        Object result = proceedingJoinPoint.proceed();
        //打印出参
        logger.info("Response Args : {}", new Gson().toJson(result));
        // 执行耗时
        logger.info("Time-Consuming : {} ms", System.currentTimeMillis() - startTime);
        return result;
    }
}
### 使用 Spring AOP 实现日志记录 Spring AOP 是一种强大的工具,能够帮助开发者实现横切关注点的分离。通过使用 AOP 技术,可以轻松地在应用程序中实现日志记录功能,而无需修改核心业务逻辑代码。 #### 启用 AOP 支持 为了在项目中启用 AOP 功能,需要确保配置文件中启用了 AspectJ 自动代理支持。如果是在 Spring Boot 项目中,则可以通过添加 `@EnableAspectJAutoProxy` 注解来完成这一操作[^3]: ```java import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; import org.springframework.context.annotation.EnableAspectJAutoProxy; @SpringBootApplication @EnableAspectJAutoProxy public class MyApplication { public static void main(String[] args) { SpringApplication.run(MyApplication.class, args); } } ``` #### 定义切面类 切面类是用来定义通知(Advice)的地方。下面是一个简单的例子,展示了如何创建一个用于日志记录的切面类[^1]: ```java 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.slf4j.Logger; import org.slf4j.LoggerFactory; import org.springframework.stereotype.Component; @Aspect @Component public class LoggingAspect { private final Logger logger = LoggerFactory.getLogger(this.getClass()); @Before("execution(* com.example.service.*.*(..))") public void logMethodEntry(JoinPoint joinPoint) { String methodName = joinPoint.getSignature().getName(); Object[] arguments = joinPoint.getArgs(); logger.info("Entering method: {} with arguments {}", methodName, arguments); } @AfterReturning(pointcut = "execution(* com.example.service.*.*(..))", returning = "result") public void logMethodExit(Object result) { logger.info("Exiting method with result: {}", result); } } ``` 上述代码片段中的 `LoggingAspect` 类被标记为 `@Aspect` 和 `@Component`,这意味着它会被 Spring 容器识别并自动注册为一个 Bean。该类中有两个主要的通知方法:一个是 `@Before` 方法,另一个是 `@AfterReturning` 方法。这两个方法分别会在目标方法执行前和执行后触发,并打印相应的日志信息[^2]。 #### 日志框架的选择 在这个示例中,选择了 SLF4J 作为日志框架。SLF4J 提供了一个抽象层,使得切换底层的日志实现变得非常容易。当然,也可以选择其他日志框架,比如 Log4j 或者 Java Util Logging[^4]。 --- ###
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值