annotation java log_基于注解的的AOP日志记录

简介

在前段时间,看自己写的代码的时候,发现存在大量繁琐的日志记录,影响观感不说,后期的维护上也是十分麻烦,决定通过AOP去解决这个问题,先做记录。

与SpringBoot框架的整合所需要的依赖包

org.springframework.boot

spring-boot-starter-aop

org.projectlombok

lombok

com.alibaba

fastjson

通过查阅网上资料,了解到通过AOP记录日志,存在两种方式

基于注解

基于表达式

详细说明

一、基于注解的AOP日志

在使用注解这种方式前,我们需要自定义一个属于自己的注解@VoiceLog

import java.lang.annotation.ElementType;

import java.lang.annotation.Retention;

import java.lang.annotation.RetentionPolicy;

import java.lang.annotation.Target;

@Target(ElementType.METHOD)

@Retention(RetentionPolicy.RUNTIME)

public @interface VoiceLog {

}

@@Target说明该注解的使用范围,包含10个枚举值;

@Retention说明编译程序如何对待自定义的Annotation,包含三个枚举值:SOURCE,CLASS,RUNTIME;

完成之后,继续下面的步骤

import com.alibaba.fastjson.JSON;

import com.alibaba.fastjson.JSONObject;

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.reflect.MethodSignature;

import org.springframework.stereotype.Component;

@Aspect // 声明这是一个切面类

@Component // 注册为一个bean

@Slf4j // lombok日志注解

public class AspectLog {

/**

* 对存在注解 `VoiceLog`的方法做日志记录

*

* @param joinPoint joinPoint

* @param voiceLog voiceLog

* @throws Throwable Throwable

* @see VoiceLog

*/

@Around(value = "@annotation(voiceLog)") // aspect增强注解,对存在该注解方法的前后做拦截

public Object logAroud(ProceedingJoinPoint joinPoint, VoiceLog voiceLog) throws Throwable {

// 获取当前毫秒

long beginTime = System.currentTimeMillis();

// 执行方法体

Object result = joinPoint.proceed();

// 计算方法执行时间

long time = System.currentTimeMillis() - beginTime;

//获取当前方法的类名

String className = joinPoint.getTarget().getClass().getSimpleName();

// 获取切点处的签名

MethodSignature methodSignature = (MethodSignature) joinPoint.getSignature();

// 获取当前的方法名

String methodName = methodSignature.getMethod().getName();

// 获取参数名称

String[] paramNames = methodSignature.getParameterNames();

// 获取参数值

Object[] params = joinPoint.getArgs();

// 把参数名称和参数值组装成json格式

JSONObject paramsJson = new JSONObject(paramNames.length);

for (int i = 0; i < paramNames.length; i++) {

paramsJson.put(paramNames[i], params[i]);

}

// 日志输出

log.info("TargetClass:{}; method:{}; requestParams:{}; response:{}; time:{}ms", className, methodName, paramsJson.toJSONString(), result, time);

return Object;

}

}

配置文件添加配置

spring.aop.proxy-target-class=true

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
Java自定义注解AOP切面是两个不同的概念,但它们可以结合使用来实现一些非常有用的功能。 Java自定义注解Java语言中的一种特殊的语法结构,它允许开发者在代码中添加一些元数据,以便后续处理程序能够基于这些元数据来进行特定的操作。Java自定义注解可以在类、方法、属性等各种代码元素上进行声明,并且可以指定注解的属性,以提供更多的元数据信息。 AOP(面向切面编程)是一种编程思想,它允许开发者在不改变原有代码的情况下,通过添加额外的代码来实现某些横切关注点的功能。AOP切面是一个包含一组通知(Advice)和切点(Pointcut)的类,它可以在程序运行时自动拦截指定的方法或类,并执行相应的通知。 在Java中,我们可以通过将自定义注解AOP切面结合使用,来实现一些非常有用的功能。例如,我们可以定义一个名为 @Log注解,在程序中使用该注解来标记需要记录日志的方法,然后编写一个AOP切面来拦截这些方法,并在方法执行前后记录日志。这样,我们就可以轻松地实现统一的日志记录功能,而不需要在每个方法中都编写日志记录代码。 下面是一个简单的示例代码,演示了如何使用Java自定义注解AOP切面来实现统一的日志记录功能: ```java // 定义一个名为 @Log注解 @Retention(RetentionPolicy.RUNTIME) @Target(ElementType.METHOD) public @interface Log { } // 编写一个AOP切面,拦截带有 @Log 注解的方法,并记录日志 @Aspect @Component public class LogAspect { @Around("@annotation(log)") public Object around(ProceedingJoinPoint joinPoint, Log log) throws Throwable { String methodName = joinPoint.getSignature().getName(); System.out.println("方法 " + methodName + " 开始执行..."); Object result = joinPoint.proceed(); System.out.println("方法 " + methodName + " 执行完成,返回值为:" + result); return result; } } // 在程序中使用 @Log 注解标记需要记录日志的方法 @Service public class UserService { @Log public String getUserInfo(String userId) { // ... } } ``` 在上面的代码中,我们首先定义了一个名为 @Log注解,并指定了它的作用范围为方法。然后,我们编写了一个AOP切面 LogAspect,使用 @Around 注解来指定切点为所有带有 @Log 注解的方法。在切面的 around 方法中,我们通过 ProceedingJoinPoint 对象获取当前执行的方法名,并在方法执行前后打印日志。最后,我们在 UserService 类的 getUserInfo 方法上使用了 @Log 注解,表示这个方法需要记录日志。 当程序运行时,LogAspect 切面会自动拦截 UserService 类的 getUserInfo 方法,并执行 around 方法中的逻辑,从而实现了统一的日志记录功能。

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值