2

我开发了一个框架和相应的 API，其中包括一个运行时可见的注释。API 还提供了一些帮助方法，供客户端在其类具有该注释的对象上使用。可以理解的是，助手与注解紧密耦合，但重要的是它们的内部被客户端封装。辅助方法当前通过注释类型中的静态内部类提供...

@Target(TYPE)
@Retention(RUNTIME)
public @interface MyAnnotation {
   // ... annotation elements, e.g. `int xyz();` ...

   public static final class Introspection {
       public static Foo helper(Object mightHaveMyAnnotation) {
           /* ... uses MyAnnotation.xyz() if annotation is present ... */
      }
   }
}

...但是助手可以很容易地存在于其他一些顶级实用程序类中。无论哪种方式都可以从客户端代码中提供必要的封装量，但是两者都会产生额外的成本来维护一个完全独立的类型，阻止它们实例化，因为所有有用的方法都是静态的，等等。

当 Java 8 在 Java 接口类型上引入静态方法时（参见JLS 9.4），该特性被吹捧为提供...

...在您的库中组织辅助方法；您可以将特定于接口的静态方法保留在同一接口中而不是单独的类中。

— 来自Java 教程 接口默认方法

这已在 JDK 库中用于提供诸如 、 等的实现List.of(...)，Set.of(...)而以前此类方法被归入单独的实用程序类，例如java.util.Collections. 通过在其相关接口中定位实用程序方法，它提高了它们的可发现性，并从 API 域中删除了可能不必要的辅助类类型。

由于注释类型的当前 JVM字节码表示与普通接口密切相关，我想知道注释是否也支持静态方法。当我将助手移动到注释类型时，例如：

@Target(TYPE)
@Retention(RUNTIME)
public @interface MyAnnotation {
   // ... annotation elements ...

   public static Foo helper(Object mightHaveMyAnnotation) { /* ... */ }
}

...我有点惊讶javac抱怨以下编译时错误：

OpenJDK 运行时环境 18.3（内部版本 10+46）

  • 此处不允许使用修饰符 static
  • 注解类型声明中的元素不能声明形参
  • 接口抽象方法不能有主体

显然，Java 语言目前不允许这样做。可能有很好的设计理由来禁止它，或者正如之前对静态接口方法所假定的那样，“没有令人信服的理由这样做；一致性不足以改变现状”。

这个问题的目的并不是问“为什么它不起作用？” 或“语言应该支持它吗？”，以避免基于意见的答案。

JVM 是一种强大的技术，并且在许多方面比 Java 语言所允许的更灵活。与此同时，Java 语言也在不断发展，今天的答案明天可能就过时了。理解必须非常小心地使用这种力量......

在技​​术上是否可以将静态行为直接封装在注释类型中，以及如何？

4

1 回答 1

3

在 JVM 中完成此操作并与标准 Java 代码互操作在技术上是可行的，但它带有重要的警告：

  1. 根据 JLS，Java 兼容的源代码不能在注释类型中定义静态方法。
  2. 如果存在这些方法， Java 源代码似乎能够使用这些方法，包括在编译时和运行时通过反射。
  3. 主题注释可能需要放在单独的编译单元中，以便在处理代码时它的二进制类可用于 IDE 和javac 。
  4. 这已在 OpenJDK 10 HotSpot 上得到验证，但观察到的行为可能取决于内部细节，可能会在以后的版本中发生变化。
  5. 在决定采用这种方法之前，请仔细考虑对长期维护和兼容性的影响。

使用一种直接操纵 JVM 字节码的机制，概念验证是成功的。

机制很简单。使用替代语言或字节码操作工具（即 ASM），它将发出一个 JVM*.class文件，该文件 (1) 与合法Java（语言）注释的功能和外观相匹配，并且 (2) 还包含所需的方法实现使用static访问修饰符集。这个类文件可以单独编译并打包到 JAR 中或直接放在类路径中，此时它可以被其他普通 Java 代码使用。

以下步骤将创建与以下不太合法的Java 注释类型相对应的工作字节码，它strlen在 POC 中为简单起见定义了一个简单的静态函数：

@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnnotation {

    String value();

    // not legal in Java, through at least JDK 10:
    public static int strlen(java.lang.String str) {
        return str.length(); // boring!
    }
}

首先，将带有“普通”value()参数的注释类设置为没有默认值的字符串：

import static org.objectweb.asm.Opcodes.*;
import java.util.*;
import org.objectweb.asm.*;
import org.objectweb.asm.tree.*;

/* ... */

final String fqcn = "com.example.MyAnnotation";
final String methodName = "strlen";
final String methodDesc = "(Ljava/lang/String;)I"; // int function(String)

ClassNode cn = new ClassNode(ASM6);
cn.version = V1_8; // Java 8
cn.access = ACC_SYNTHETIC | ACC_PUBLIC | ACC_INTERFACE | ACC_ABSTRACT | ACC_ANNOTATION;
cn.name = fqcn.replace(".", "/");
cn.superName = "java/lang/Object";
cn.interfaces = Arrays.asList("java/lang/annotation/Annotation");

// String value();
cn.methods.add(
    new MethodNode(
        ASM6, ACC_PUBLIC | ACC_ABSTRACT, "value", "()Ljava.lang.String;", null, null));

如果合适，可以选择用 注释注释@Retention(RUNTIME)：

AnnotationNode runtimeRetention = new AnnotationNode(ASM6, "Ljava/lang/annotation/Retention;");
runtimeRetention.values = Arrays.asList(
    "value", // parameter name; related value follows immediately next:
    new String[] { "Ljava/lang/annotation/RetentionPolicy;", "RUNTIME" } // enum type & value
);
cn.visibleAnnotations = Arrays.asList(runtimeRetention);

接下来，添加所需的static方法：

MethodNode method = new MethodNode(ASM6, 0, methodName, methodDesc, null, null);
method.access = ACC_PUBLIC | ACC_STATIC;
method.annotationDefault = Integer.MIN_VALUE; // see notes
AbstractInsnNode invokeStringLength =
    new MethodInsnNode(INVOKEVIRTUAL, "java/lang/String", "length", "()I", false);
method.instructions.add(new IntInsnNode(ALOAD, 0)); // push String method arg
method.instructions.add(invokeStringLength);        // invoke .length()
method.instructions.add(new InsnNode(IRETURN));     // return an int value
method.maxLocals = 1;
method.maxStack = 1;
cn.methods.add(method);

最后，将此注释的 JVM 字节码输出到*.class类路径上的文件中，或者使用自定义的 ClassLoader（未显示）将其直接加载到内存中：

ClassWriter cw = new ClassWriter(0);
cn.accept(cw);
byte[] bytecode = cw.toByteArray();

笔记：

  1. 这需要生成字节码版本 52 (Java 8) 或更高版本，并且只能在支持该版本的 JVM 下运行。
  2. 注释java.lang.Object作为它们的超类型，它们实现了java.lang.annotation.Annotation接口。
  3. MethodNode 构造函数的两个null参数用于泛型和声明的异常，本示例中均未使用。
  4. OpenJDK 10 的 HotSpot要求在静态方法上设置MethodNode.annotationDefault为非空值（适当类型），即使在将注释应用于另一个元素strlen时设置/覆盖永远不会是一个选项。这是这种“合法”方法的灰色地带。HS 字节码验证器似乎忽略了 ACC_STATIC 标志，并假定所有定义的方法都是正常的注释元素。
于 2018-06-12T05:01:46.817 回答