Micrometer TimedAspect 不会拦截对使用 @Timed

如何解决Micrometer TimedAspect 不会拦截对使用 @Timed

我正在尝试使用 Micrometer 在我的 Java 应用程序中记录执行时间。这与我关于使用的 @Timed 注释的其他 question 相关。

我有一个 Countedobject 类，它有以下 2 个方法：

@Measured
@Timed(value = "timer1")
public void measuredFunction() {
    try {
        int sleepTime = new Random().nextInt(3) + 1;
        Thread.sleep(sleepTime * 1000L);
    } catch (InterruptedException e) {}
}

@Timed(value = "timer2")
public void timedFunction() {
    try {
        int sleepTime = new Random().nextInt(3) + 1;
        Thread.sleep(sleepTime * 1000L);
    } catch (InterruptedException e) {}
}

我定义了一个自定义注解 @Measured

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface Measured {
    
}

还有一个 MeasuredAspect 来拦截对用我的 @Measured 注释注释的方法的调用：

@Aspect
public class MeasuredAspect {
    @Around("execution(* *(..)) && @annotation(Measured)")
    public Object around(ProceedingJoinPoint pjp) throws Throwable {
        return AppMetrics.getInstance().handle(pjp);

    }
}

在我的 AppMetrics 类中，我初始化了一个千分尺的 TimedAspect 实例，并在 handle(ProceedingJoinPoint pjp) 方法中将 ProceedingJoinPoint pjp 传递给 TimedAspect 实例。

public class AppMetrics {
    private static final AppMetrics instance = new AppMetrics();
    
    private MeterRegistry registry;
    private TimedAspect timedAspect;
    
    public static AppMetrics getInstance() {
        return instance;
    }
    
    private AppMetrics() {
        this.registry = new SimpleMeterRegistry();
        this.timedAspect = new TimedAspect(registry);
    }
    
    public Object handle(ProceedingJoinPoint pjp) throws Throwable {
        return timedAspect.timedMethod(pjp);
    }
}

在我的应用程序主程序中，我创建了一个 Countedobject 对象并调用了 measuredFunction() 和 timedFunction() 然后我检查了我的 registry.getMeters(); 只使用了 timer1由measuredFunction() [由@Measured 和@Timed 注释] 找到，而应由timedFunction() 使用的timer2 [仅由{{3} 注释}] 不存在。

我将 eclipse 与 @Timed 一起使用，我的项目是具有 AspectJ 功能的 Gradle 项目。我在 Gradle 插件中使用了 id "io.freefair.aspectj" version "5.1.1" 插件。这是一个基本的 Java 应用程序，而不是 Spring 应用程序。

需要做哪些配置或者需要修改哪些代码才能让千分尺AspectJ Development Tools Plugin可以直接拦截我的方法调用【即timedFunction()应该是定时的，timer2应该是在注册表中找到]而不需要我的自定义注释？

解决方法

我为您创建了一个示例项目：

https://github.com/kriegaex/SO_AJ_MicrometerTimed_67803726

引用自述文件（抱歉，StackOverflow 上不赞成仅包含链接的答案）：

在 https://github.com/micrometer-metrics/micrometer/issues/1149 和 StackOverflow 上，关于 Micrometer 的 @Timed 注释的常见问题解答是，为什么它可以与 Spring AOP 一起使用，但在编译时编织 (CTW) 的上下文中使用 Micrometer 作为本机 AspectJ 的方面库时却不能使用，例如使用 AspectJ Maven 插件。当提供指向 aop.xml 的 TimedAspect 时，它可以与加载时编织 (LTW) 一起工作，但在 CTW 中，方面永远不会开始。

原因是aspect是用Javac编译的，而不是用AspectJ编译器（AJC），这是“完成”Java类所必需的，即增强其字节码以成为完整的 AspectJ 方面。 LTW 代理在类加载期间即时执行此操作，但在 CTW 上下文中您需要明确告诉 AJC 在 Micrometer 库上进行编译后编织（也称为二进制编织），生成新编织的类文件。这是通过将 Micrometer 放在 AJC 的 inpath 上来完成的，以确保其类文件被转换并写入目标目录。 AspectJ Maven 中的 inpath 是通过 <weaveDependencies> 配置的。至少有两种方法可以做到这一点：

您可以在单独的 Maven 模块中创建自己的库的编织版本，然后使用该模块而不是 Micrometer。在这种情况下，您需要在消费模块中排除原始的 Micrometer 库，以确保 unwoven 类文件不再位于类路径中，并且被意外使用。
本示例项目中显示的方式是单模块方法，使用 Maven Shade 构建可执行的 uber JAR。千分尺类文件不像第一种方法那样是一个可重用的库，但它非常适合演示目的，因为我们可以只运行示例应用程序并检查其输出：

$ mvn clean package

...
[INFO] --- aspectj-maven-plugin:1.12.6:compile (default) @ SO_AJ_MicrometerTimed_67803726 ---
[INFO] Showing AJC message detail for messages of types: [error,warning,fail]
[INFO] Join point 'method-execution(void de.scrum_master.app.Application.doSomething())' in Type 'de.scrum_master.app.Application' (Application.java:23) advised by around advice from 'io.micrometer.core.aop.TimedAspect' (micrometer-core-1.7.0.jar!TimedAspect.class(from TimedAspect.java))
...
[INFO] --- maven-shade-plugin:3.2.4:shade (default) @ SO_AJ_MicrometerTimed_67803726 ---
[INFO] Including org.hdrhistogram:HdrHistogram:jar:2.1.12 in the shaded jar.
[INFO] Including org.latencyutils:LatencyUtils:jar:2.0.3 in the shaded jar.
[INFO] Including org.aspectj:aspectjrt:jar:1.9.6 in the shaded jar.
[INFO] Excluding io.micrometer:micrometer-core:jar:1.7.0 from the shaded jar.
[INFO] Replacing original artifact with shaded artifact.
[INFO] Replacing C:\Users\me\java-src\SO_AJ_MicrometerTimed_67803726\target\SO_AJ_MicrometerTimed_67803726-1.0-SNAPSHOT.jar with C:\Users\me\java-src\SO_AJ_MicrometerTimed_67803726\target\SO_AJ_MicrometerTimed_67803726-1.0-SNAPSHOT-shaded.jar
[INFO] Dependency-reduced POM written at: C:\Users\me\java-src\SO_AJ_MicrometerTimed_67803726\target\dependency-reduced-pom.xml
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------

$ java -jar target/SO_AJ_MicrometerTimed_67803726-1.0-SNAPSHOT.jar

Juni 05,2021 1:12:27 PM io.micrometer.core.instrument.push.PushMeterRegistry start
INFO: publishing metrics for LoggingMeterRegistry every 1m
Juni 05,2021 1:13:00 PM io.micrometer.core.instrument.logging.LoggingMeterRegistry lambda$publish$5
INFO: method.timed{class=de.scrum_master.app.Application,exception=none,method=doSomething} throughput=0.166667/s mean=0.11842469s max=0.2146482s

请特别注意那些日志行（插入换行符以提高可读性）：

Join point 'method-execution(void de.scrum_master.app.Application.doSomething())'
  in Type 'de.scrum_master.app.Application' (Application.java:23)
  advised by around advice from 'io.micrometer.core.aop.TimedAspect'
  (micrometer-core-1.7.0.jar!TimedAspect.class(from TimedAspect.java))

以上证明 @Timed 注释实际上导致 Micrometer 的 TimedAspect 被编织到我们的应用程序代码中。这里有方面为示例应用程序创建的度量：

method.timed
  {class=de.scrum_master.app.Application,method=doSomething}
  throughput=0.166667/s mean=0.11842469s max=0.2146482s

我不确定您对此有何期望：

public Object handle(ProceedingJoinPoint pjp) throws Throwable {
    return timedAspect.timedMethod(pjp);
}

如果我理解正确的话，它什么都不做。您可以按照 guides 为您的项目正确设置 AspectJ。完成后 TimedAspect 应该可以工作，您不需要 MeasuredAspect 或 @Measured 只需设置 AspectJ。