springboot自定义注解实现日志切面（基于类和方法）

最新推荐文章于 2024-10-06 02:11:52 发布

进击的木偶

最新推荐文章于 2024-10-06 02:11:52 发布

阅读量324

点赞数

分类专栏： java 文章标签： java

本文链接：https://blog.csdn.net/bobjy_happybird/article/details/128975011

版权

java 专栏收录该内容

4 篇文章 0 订阅

订阅专栏

这段代码定义了一个名为`ParamResultLog`的注解，用于标记需要记录参数和返回值的日志的方法或类。`ParamResultLogAspect`是一个切面组件，使用AOP的`@Before`、`@AfterReturning`和`@AfterThrowing`注解来分别在方法执行前、正常返回后和抛出异常后记录日志，包括方法名、参数、返回值和执行耗时。

摘要由CSDN通过智能技术生成

@Documented
@Retention(RUNTIME)
@Target({ElementType.METHOD,ElementType.TYPE})
public @interface ParamResultLog {

}

@Component
@Aspect
public class ParamResultLogAspect {

    private Logger logger = LoggerFactory.getLogger(getClass());

  
    @Pointcut("@annotation(com.*类全路径*.ParamResultLog) || @within(com.*类全路径*.ParamResultLog)")
    private void cut() { }

    private Map<String,Long> timeMap = new HashMap<>();

    @Before("cut()")
    public void doBefore(JoinPoint joinPoint) {
        //类名
        String className = joinPoint.getSignature().getDeclaringTypeName();
        //方法名称
        String methodName = joinPoint.getSignature().getName();
        //方法开始时间
        timeMap.put(Thread.currentThread().getId()+className+":"+methodName+"start",System.currentTimeMillis());
        //防止参数转换报错
        try{
            //方法参数
            Object[] param = new Object[joinPoint.getArgs().length];
            for (int i = 0;i<joinPoint.getArgs().length;i++){
                if(joinPoint.getArgs()[i] != null&&!(joinPoint.getArgs()[i] instanceof Proxy)){
                    param[i] = joinPoint.getArgs()[i];
                }else{
                    param[i] = null;
                }
            }
            String argsJsonStr = JSON.toJSONString(param);
            logger.info("【{}:{}】开始执行,参数：{}",className,methodName,argsJsonStr);

        }catch (Exception e){
            logger.warn("Before日志参数转换异常，不影响业务逻辑！信息：{}",e.getMessage());
        }
    }

    @AfterReturning(returning = "ret", pointcut = "cut()")
    public void doAfterReturning(JoinPoint joinPoint, Object ret) {
        //类名
        String className = joinPoint.getSignature().getDeclaringTypeName();
        //方法名称
        String methodName = joinPoint.getSignature().getName();
        //防止参数转换报错
        try{
            //方法开始时间
            timeMap.put(Thread.currentThread().getId()+className+":"+methodName+"end",System.currentTimeMillis());
            Long cost = timeMap.get(Thread.currentThread().getId()+className+":"+methodName+"end")-timeMap.get(Thread.currentThread().getId()+className+":"+methodName+"start");
            String retStr = JSON.toJSONString(ret);
            logger.info("【{}:{}】执行完毕,返回值：{};花费时间{}ms",className,methodName,retStr,cost);
        }catch (Exception e){
            logger.warn("AfterReturning日志参数转换异常，不影响业务逻辑！信息：{}",e.getMessage());
        }finally {
            timeMap.remove(Thread.currentThread().getId()+className+":"+methodName+"start");
            timeMap.remove(Thread.currentThread().getId()+className+":"+methodName+"end");
        }

    }

    @AfterThrowing(pointcut = "cut()", throwing = "e")
    public void doAfterThrowing(JoinPoint joinPoint, Throwable e) {
        //类名
        String className = joinPoint.getSignature().getDeclaringTypeName();
        //方法名称
        String methodName = joinPoint.getSignature().getName();
        try{
            //方法开始时间
            timeMap.put(Thread.currentThread().getId()+className+":"+methodName+"end",System.currentTimeMillis());
            Long cost = timeMap.get(Thread.currentThread().getId()+className+":"+methodName+"end")-timeMap.get(Thread.currentThread().getId()+className+":"+methodName+"start");
            logger.warn("【{}:{}】执行完毕,发生异常：{};花费时间{}ms",className,methodName,e.getMessage(),cost);
        }catch (Exception e1){
            logger.warn("AfterThrowing日志参数转换异常，不影响业务逻辑！信息：{}",e.getMessage());
        }finally {
            timeMap.remove(Thread.currentThread().getId()+className+":"+methodName+"start");
            timeMap.remove(Thread.currentThread().getId()+className+":"+methodName+"end");
        }
    }

}

@ParamResultLog 可作用于类或者某个方法，实现方法的出入参打印，方法执行时间捕获。