如何使用 AspectJ 将字段添加到自定义注释 class

Question

要使用 aspectj 向某些特定 class 添加字段，我们会这样做

package com.test;

public class MyClass {
    private String myField;
}

public aspect MyAspect
{
    private String MyClass.myHiddenField;
}

我们如何将一个字段添加到一个 class 并使用一些自定义注释进行注释？

示例用法：如果 class 注释为 @CustomLoggable 添加一个 Logger 字段和一些方法。

或

如果方法有 @ReadLocked 注释，那么 class 将有一个 ReentrantReadWriteLock 字段和适当的逻辑注入等。

Answer 1

您可以为具有特定注释的任何类型创建切入点。参见 Join Point Matching based on Annotations。

Answer 2

实际上你不能在注释类型上进行类型间声明 (ITD)，即你需要知道具体的 class 名称才能直接声明静态或非静态成员或方法。

通常的解决方法是：

创建一个包含您需要的所有方法的接口。
为每个接口方法提供实现。
使每个注释类型通过 ITD 实现接口。

现在，如果您还想向所有带注释的类型添加静态成员（例如记录器），如果您不知道确切的 class 名称，则需要使用变通方法：

创建一个包含所需成员的方面。在这个例子中我们称之为 LoggerHolder。
确保为每个目标 class 创建一个方面实例，而不是默认的单例方面实例。这是通过 pertypewithin.
为了避免运行时间异常，你不能直接通过Logger logger = ...初始化成员，而是需要延迟初始化，等到目标类型的静态初始化阶段完成后。
你还需要在切面中提供类似LoggerHolder.getLogger()的访问器方法，并在需要时调用它。
为了向最终用户隐藏所有丑陋的方面的东西，我建议向上面提到的 ITD 接口添加另一个访问器方法 LoggableAspect.getLogger()（为方便起见，使用相同的方法名称）并提供方法实现提取来自方面实例的成员引用 LoggerHolder.aspectOf(this.getClass()).getLogger().

注意：我在这里同时使用了两个概念，将它们混合在一个应用程序中，因为您要求将静态成员和非静态方法都添加到带注释的 classes:

Helper 接口 + 通过 ITD 添加到您的核心代码中的实现
Holder 方面声明成员并通过 pertypewithin 与目标 classes 相关联以模拟静态成员

下面是一些示例代码：

注解：

package de.scrum_master.app;

import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;

@Retention(RetentionPolicy.RUNTIME)
public @interface CustomLoggable {}

两个 classes，一个带有注释，一个不带有注释：

package de.scrum_master.app;

public class OrdinaryClass {
    public void doSomething() {
        System.out.println("Logging some action directly to console");
    }
}

package de.scrum_master.app;

import java.util.logging.Level;

@CustomLoggable
public class AnnotatedClass {
    public void doSomething() {
        getLogger().log(Level.INFO, "Logging some action via ITD logger");
        getLogger().log(Level.INFO, someOtherMethod(11));
    }
}

如您所见，第二个 class 使用两个未在 class 中直接声明的方法：getLogger() 和 someOtherMethod(int)。它们都将在下面通过 ITD 进一步声明，前者提供对伪静态成员的访问，后者只是您希望在每个带注释的 class.

上声明的另一种方法

持有伪静态成员实例的方面：

package de.scrum_master.aspect;

import java.util.logging.Logger;
import de.scrum_master.app.CustomLoggable;

public aspect LoggerHolder
    pertypewithin(@CustomLoggable *)
{
    private Logger logger;

    after() : staticinitialization(*) {
        logger = Logger.getLogger(getWithinTypeName());
    }

    public Logger getLogger() {
        return logger;
    }
}

前面说过，请注意pertypewithin和staticinitialization的用法。另一个方便的事情是使用方面的 getWithinTypeName() 方法来获取目标 class 名称以命名记录器。

声明接口+实现并将其应用于所有目标类型的方面：

package de.scrum_master.aspect;

import java.util.logging.Logger;
import de.scrum_master.app.CustomLoggable;

public aspect LoggableAspect {
    public static interface Loggable {
        Logger getLogger();
        String someOtherMethod(int number);
    }

    declare parents : (@CustomLoggable *) implements Loggable;

    public Logger Loggable.getLogger() {
        return LoggerHolder.aspectOf(this.getClass()).getLogger();
    }

    public String Loggable.someOtherMethod(int number) {
        return ((Integer) number).toString();
    }
}

为简单起见，我只是将接口声明为方面内的静态嵌套类型。您也可以单独声明接口，但在这里您可以在它的上下文中看到它，这对我来说更可取。

这里的关键是 declare parents 语句使每个目标 class 实现接口。最后的两个方法实现展示了如何提供 "normal" 方法实现以及如何通过 aspectOf.

从 holder 方面访问记录器

驱动程序 class 入口点：

最后但同样重要的是，我们想要运行代码并查看它是否符合我们的要求。

package de.scrum_master.app;

public class Application {
    public static void main(String[] args) {
        new OrdinaryClass().doSomething();
        new AnnotatedClass().doSomething();
    }
}

控制台输出：

Logging some action directly to console
Mrz 15, 2015 11:46:12 AM de.scrum_master.app.AnnotatedClass doSomething
Information: Logging some action via ITD logger
Mrz 15, 2015 11:46:12 AM de.scrum_master.app.AnnotatedClass doSomething
Information: 11

瞧！记录工作，记录器有一个很好的名字 de.scrum_master.app.AnnotatedClass 并且调用两个接口方法按预期工作。

替代方法：

自 AspectJ 1.8.2 annotation processing is supported, see also this blog post。 IE。您可以使用 APT 为每个注释类型生成一个方面，并直接引入静态成员和其他方法，而无需任何技巧，例如每个类型实例化、持有者方面实例和接口中的访问器方法成员。这是以额外的构建步骤为代价的，但我认为这将是解决您的问题的一种非常简洁明了的方法。如果您在理解示例时遇到任何困难并需要更多帮助，请告诉我。

如何使用 AspectJ 将字段添加到自定义注释 class

How to add a field to a custom-annotated class using AspectJ

java

aop

aspectj