日志模块自定义@SkipLogAspect注解跳过切面的操作方法

 更新时间:2025年02月07日 09:33:43   作者:S-X-S  
文章介绍了一个自定义注解@SkipLogAspect,用于在日志模块中跳过特定方法的日志切面,这个注解可以用于需要避免大对象转换为JSON时导致的OOM问题,文章还提供了注解的实现代码以及一个测试示例,展示了如何在控制器中使用该注解来跳过日志切面,感兴趣的朋友一起看看吧

1.增加原因

因为如果参数是一些大对象,比如HttpServletRequest request,在转化为json的时候就会导致OOM,所以选择新增一个注解让用户自己灵活的决定是否添加日志切面

2.common-log4j2-starter

1.目录结构

2.SkipLogAspect.java 自定义注解

package cn.sunxiansheng.log4j2.annotation;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
 * Description: 跳过日志切面的注解
 *
 * @Author sun
 * @Create 2025/1/24 18:08
 * @Version 1.0
 */
@Target({ElementType.METHOD, ElementType.TYPE}) // 可以标注在类或方法上
@Retention(RetentionPolicy.RUNTIME) // 运行时生效
public @interface SkipLogAspect {
}

3.LogAspect.java

1.核心改动

2.完整代码

package cn.sunxiansheng.log4j2.aspectj;
import cn.sunxiansheng.log4j2.annotation.SkipLogAspect;
import com.google.gson.Gson;
import com.google.gson.GsonBuilder;
import lombok.extern.slf4j.Slf4j;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Pointcut;
import org.aspectj.lang.reflect.MethodSignature;
import java.lang.reflect.Method;
/**
 * 日志切面
 *
 * @author sunxiansheng
 */
@Aspect
@Slf4j
public class LogAspect {
    private static final Gson GSON = new GsonBuilder()
            .setPrettyPrinting()
            .disableHtmlEscaping()
            .create();
    private static final String ANSI_RESET = "\u001B[0m";
    private static final String ANSI_CYAN = "\u001B[92m";
    @Pointcut("execution(public * *..controller..*(..)) || " +
            "execution(public * *..service..*(..))")
    public void applicationPackagePointcut() {
        // 切点定义
    }
    @Around("applicationPackagePointcut()")
    public Object logAround(ProceedingJoinPoint joinPoint) throws Throwable {
        // 获取目标类和方法
        MethodSignature signature = (MethodSignature) joinPoint.getSignature();
        Method method = signature.getMethod();
        Class<?> targetClass = joinPoint.getTarget().getClass();
        // 检查是否存在 @SkipLogAspect 注解
        if (method.isAnnotationPresent(SkipLogAspect.class) ||
                targetClass.isAnnotationPresent(SkipLogAspect.class)) {
            // 直接执行目标方法,不记录日志
            return joinPoint.proceed();
        }
        // 正常记录日志逻辑
        String className = signature.getDeclaringTypeName();
        String methodName = signature.getName();
        Object[] args = joinPoint.getArgs();
        String requestParams = GSON.toJson(args);
        log.info("==> 进入方法: {}.{}()", className, methodName);
        log.info("参数:\n" + ANSI_CYAN + "{}" + ANSI_RESET, requestParams);
        long startTime = System.currentTimeMillis();
        Object result = joinPoint.proceed();
        long endTime = System.currentTimeMillis();
        String response = GSON.toJson(result);
        log.info("<== 退出方法: {}.{}() | 耗时: {} ms", className, methodName, endTime - startTime);
        log.info("返回值:\n" + ANSI_CYAN + "{}" + ANSI_RESET, response);
        return result;
    }
}

3.common-log4j2-starter-demo

1.目录结构

2.TraceController.java 新增方法,测试跳过日志切面的注解

/**
 * 测试跳过日志切面的注解
 *
 * @param msg
 * @return
 */
@SkipLogAspect
@RequestMapping("/skipLogAspect")
public String skipLogAspect(String msg) {
    return "skip log aspect";
}

3.测试

到此这篇关于日志模块自定义@SkipLogAspect注解跳过切面的文章就介绍到这了,更多相关日志模块自定义@SkipLogAspect注解内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • 深入了解Java SpringBoot自动装配原理

    深入了解Java SpringBoot自动装配原理

    在使用springboot时,很多配置我们都没有做,都是springboot在帮我们完成,这很大一部分归功于springboot自动装配。本文将详细为大家讲解SpringBoot的自动装配原理,需要的可以参考一下
    2022-03-03
  • Logback 使用TurboFilter实现日志级别等内容的动态修改操作

    Logback 使用TurboFilter实现日志级别等内容的动态修改操作

    这篇文章主要介绍了Logback 使用TurboFilter实现日志级别等内容的动态修改操作,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-08-08
  • Java语言实现扫雷游戏(2)

    Java语言实现扫雷游戏(2)

    这篇文章主要为大家详细介绍了Java语言实现扫雷游戏第二部分代码,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2020-04-04
  • Java线程中断及线程中断的几种使用场景小结

    Java线程中断及线程中断的几种使用场景小结

    在并发编程中,合理使用线程中断机制可以提高程序的鲁棒性和可维护性,本文主要介绍了Java线程中断及线程中断的几种使用场景小结,具有一定的参考价值,感兴趣的可以了解一下
    2024-01-01
  • Scala小程序详解及实例代码

    Scala小程序详解及实例代码

    这篇文章主要介绍了Scala 第一个Scala小程序详解的相关资料,需要的朋友可以参考下
    2017-01-01
  • Spring Boot项目Jar包加密实战教程

    Spring Boot项目Jar包加密实战教程

    本文详细介绍了如何在Spring Boot项目中实现Jar包加密,我们首先了解了Jar包加密的基本概念和作用,然后学习了如何使用Spring Boot的Jar工具和第三方库来实现Jar包的加密和解密,感兴趣的朋友一起看看吧
    2024-02-02
  • Java后端传时间戳给前端的三种方式

    Java后端传时间戳给前端的三种方式

    时间戳是一份能够表示一份数据在一个特定时间点已经存在的完整的可验证的数据,本文给大家介绍了Java后端传时间戳给前端的三种方式,并通过代码示例讲解的非常详细,具有一定的参考价值,需要的朋友可以参考下
    2024-12-12
  • SpringBoot 2.6.x整合springfox 3.0报错问题及解决方案

    SpringBoot 2.6.x整合springfox 3.0报错问题及解决方案

    这篇文章主要介绍了SpringBoot 2.6.x整合springfox 3.0报错问题及解决方案,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2024-01-01
  • java 判断一个数组中的数值是否连续相邻的方法

    java 判断一个数组中的数值是否连续相邻的方法

    下面小编就为大家分享一篇java 判断一个数组中的数值是否连续相邻的方法,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2018-03-03
  • @FeignClient注解中属性contextId的使用说明

    @FeignClient注解中属性contextId的使用说明

    这篇文章主要介绍了@FeignClient注解中属性contextId的使用说明,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-06-06

最新评论