java - 如何使用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实现接口。


现在，如果您还想将静态成员（例如logger）添加到所有带注释的类型，那么再次，如果您不知道确切的类名，则需要使用替代方法：


创建一个包含所需成员的方面。在此示例中，我们将其称为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中声明，前者提供对伪静态成员的访问，后者只是您要在每个带注释的类上声明的另一种方法。

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

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

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

替代方法：

由于支持AspectJ 1.8.2 annotation processing，因此另请参见 this blog post。即您可以使用APT来为每个带注释的类型生成一个方面，并直接引入静态成员和其他方法，而无需任何技巧，例如，每个类型的实例化，持有者方面实例和接口内的访问器方法成员。这是以额外的构建步骤为代价的，但是我认为这将是解决问题的非常简洁明了的方法。如果您在理解示例方面有任何困难并需要更多帮助，请告诉我。