1.定义元注解
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Log {
String value() default "";
}
这段代码是Java语言中的元编程,用于创建一个注解(@Log)来标记特定的方法。以下是代码的两个主要方面:
-
功能:
- @Target(ElementType.METHOD): 这个注解告诉Java编译器,这个注解应该应用在方法上,也就是方法级别的元数据。
- @Retention(RetentionPolicy.RUNTIME): 这表示这个注解的信息会在运行时保留,也就是说,当程序运行时,可以通过反射机制获取到这个注解的信息。
- @Documented: 这个注解告诉Java文档生成工具(如Javadoc)要包含这个注解的描述,方便其他开发者查阅。
-
具体步骤:
- 创建注解:
@Log
: 定义一个名为Log
的注解,没有具体的实现,只是声明了一个元注解。
- 元数据处理:
@Target(ElementType.METHOD)
: 定义了注解的目标,告诉Java编译器它将作用于方法。@Retention(RetentionPolicy.RUNTIME)
: 说明这个注解的信息会在运行时可用,如通过反射获取。
- 使用场景:
- 在实际的代码中,当需要记录日志或者行为跟踪时,可以在方法上使用
@Log
,然后在日志库或者工具中,通过反射来读取这些带有@Log
的标记方法,记录相应的日志信息。
- 在实际的代码中,当需要记录日志或者行为跟踪时,可以在方法上使用
- 创建注解:
这个Log.java
文件可能包含一个@Log
注解的实现,用于在方法签名上添加额外的逻辑,比如记录调用日志。
2.导入maven包
在Maven中使用Aspect(面向切面编程)相关的功能,通常需要引入以下两个Maven依赖包:
- spring-aspects:
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-aspects</artifactId>
<version>5.3.23</version>
</dependency>
这个依赖包提供了Spring框架中与AOP(面向切面编程)相关的功能,包括切面定义、切点表达式等。
- aspectjweaver:
<dependency>
<groupId>org.aspectj</groupId>
<artifactId>aspectjweaver</artifactId>
<version>1.9.9.1</version>
</dependency>
这个依赖包提供了AspectJ的核心功能,包括切面定义、织入等。AspectJ是一个功能强大的面向切面编程框架,与Spring AOP集成使用效果更佳。
通常情况下,在使用Spring AOP时,需要同时引入这两个依赖包。具体的版本号可以根据项目的需求和Spring版本进行选择。
3.代码Demo
在这个示例中,ProceedingJoinPoint用于获取被拦截方法的信息,并控制方法的执行流程,同时记录方法调用前后的日志信息。
ProceedingJoinPoint
是AspectJ中的一个接口,它提供了对当前被拦截的方法调用(连接点)的访问和控制。以下是它的一些常见用法:
-
获取方法信息:
getTarget()
: 获取被拦截方法所属的目标对象实例。getArgs()
: 获取被拦截方法的参数列表。getSignature()
: 获取被拦截方法的签名信息,包括方法名、返回类型、参数类型等。
-
控制方法执行:
proceed()
: 执行被拦截的原始方法。如果不调用该方法,则不会执行原始方法。proceed(Object[] args)
: 使用新的参数列表执行被拦截的原始方法。
-
获取上下文信息:
getThis()
: 获取当前AOP代理对象实例。getStaticPart()
: 获取连接点的静态部分,如类、方法等。
-
记录日志:
- 可以使用
getSignature()
和getArgs()
方法获取被拦截方法的信息,并记录到日志中。
- 可以使用
示例代码:
@Around("execution(* com.example.service.*.*(..))")
public Object logMethodCall(ProceedingJoinPoint joinPoint) throws Throwable {
// 获取方法签名信息
MethodSignature signature = (MethodSignature) joinPoint.getSignature();
String methodName = signature.getMethod().getName();
// 记录方法调用前的日志
logger.info("Calling method: {}", methodName);
// 执行原始方法
Object result = joinPoint.proceed();
// 记录方法调用后的日志
logger.info("Method {} returned: {}", methodName, result);
return result;
}
在这个示例中,ProceedingJoinPoint
用于获取被拦截方法的信息,并控制方法的执行流程,同时记录方法调用前后的日志信息。