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

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()

  实例。

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

• Helper 接口 + 实现通过 ITD 添加到您的核心代码中
• Holder 方面声明成员并通过

  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 进一步声明，前者提供对伪静态成员的访问，后者只是您想要在每个带注释的类上声明的另一个方法。

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

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()

方法来获取用于命名记录器的目标类名。

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

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 起支持注释处理，另请参阅此博文。 IE。您可以使用 APT 为每个带注释的类型生成一个切面，并直接引入静态成员和其他方法，而无需任何技巧，例如每个类型实例化、持有方切面实例和接口中的访问器方法成员。这是以额外的构建步骤为代价的，但我认为这将是解决您的问题的一种非常简洁的方法。如果您在理解示例时遇到任何困难并需要更多帮助，请告诉我。

Answer 2

您可以使用特定注释为任何类型创建切入点。请参阅基于注释的连接点匹配。