Question

使用aspectj为某个特定类添加字段

package com.test;

public class MyClass {
    private String myField;
}

public aspect MyAspect
{
    private String MyClass.myHiddenField;
}

我们如何向使用某些自定义注释注释的类添加字段？

示例用法：如果使用@CustomLoggable注释类，则添加Logger字段和一些方法。

或

如果方法具有@ReadLocked注释，则类将具有ReentrantReadWriteLock字段并注入适当的逻辑等。

Answer 1

实际上你不能对注释类型进行类型间声明（ITD），即你需要知道具体的类名，以便直接声明静态或非静态成员或方法。

通常的解决方法是：

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

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

创建包含所需成员的方面。我们在此示例中将其称为LoggerHolder。
确保创建每个目标类的一个方面实例，而不是默认的单一方面实例。这是通过pertypewithin完成的。
为了避免运行时异常，您不能直接通过Logger logger = ...初始化成员，但需要懒惰地等待，直到目标类型的静态初始化阶段结束。
您还需要在方面提供类似LoggerHolder.getLogger()的访问方法，并在必要时调用它。
为了隐藏最终用户的所有丑陋的方面内容，我建议在上面提到的ITD界面中添加另一个访问方法LoggableAspect.getLogger()（为方便起见，方法名称相同），并提供一个提取成员的方法实现来自方面实例的引用LoggerHolder.aspectOf(this.getClass()).getLogger()。

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

通过ITD将助手接口+实施添加到您的核心代码
通过pertypewithin声明成员并与目标类相关联的持有者方面，以模拟静态成员

现在这里有一些示例代码：

<强>注释：

package de.scrum_master.app;

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

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

两个类，一个带有注释，一个带有注释：

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));
    }
}

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

持有伪静态成员实例的Aspect：

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()方法来获取命名记录器的目标类名。

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

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语句使每个目标类实现接口。最后的两个方法实现展示了如何提供“正常”方法实现以及如何通过aspectOf从持有者方面访问记录器。

带入口点的驱动程序类：

最后，但并非最不重要的是，我们希望运行代码并查看它是否符合我们的要求。

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

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

替代方法：

由于支持AspectJ 1.8.2 annotation processing，另请参阅this blog post。即你可以使用APT来生成每个带注释类型的一个方面，并直接引入静态成员和其他方法，而不需要任何技巧，例如per-type instantiation，holder方面实例和接口中的accessor方法成员。这是以额外构建步骤为代价的，但我认为这将是解决问题的一种非常简洁直接的方法。如果您对这些示例有所了解并需要更多帮助，请告诉我。

Answer 2

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

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

2 个答案: