Java注解属性值限制

codingman included in Java

2020-03-02 1640 words 4 minutes

Contents

1. 概述

如今，很难想象没有注解的 Java 是 Java 语言中的一个强大工具。

Java 提供了一组内置的注解。此外，还有来自不同库的大量注解。我们甚至可以定义和处理我们自己的注解。我们可以使用属性值调整这些注解，但是，这些属性值有局限性。特别是，注解属性值必须是常量表达式。

在本教程中，我们将了解该限制的一些原因，并深入了解 JVM 以更好地解释它。我们还将看一些涉及注解属性值的问题和解决方案的示例。

2. Java 注解属性底层

让我们考虑一下 Java 类文件是如何存储注解属性的。Java 有一个特殊的结构，称为*element_value *。此结构存储特定的注解属性。

结构element_value可以存储四种不同类型的值：

常量池中的一个常量
类文字
嵌套注解
一组值

因此，注解属性中的常量是编译时常量。否则，编译器将不知道应该将什么值放入常量池并用作注解属性。

Java 规范定义了产生常量表达式的操作。如果我们将这些操作应用于编译时常量，我们将得到编译时常量。

假设我们有一个注解*@Marker*，它有一个属性value：

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface Marker {
    String value();
}

例如，此代码编译没有错误：

@Marker(Example.ATTRIBUTE_FOO + Example.ATTRIBUTE_BAR)
public class Example {
    static final String ATTRIBUTE_FOO = "foo";
    static final String ATTRIBUTE_BAR = "bar";
    // ...
}

在这里，我们将注解属性定义为两个字符串的连接。连接运算符产生一个常量表达式。

3. 使用静态初始化器

让我们考虑一个在static块中初始化的常量：

@Marker(Example.ATTRIBUTE_FOO)
public class Example {
    static final String[] ATTRIBUTES = {"foo", "Bar"};
    static final String ATTRIBUTE_FOO;
    static {
        ATTRIBUTE_FOO = ATTRIBUTES[0];
    }
    
    // ...
}

它初始化static块中的字段并尝试将该字段用作注解属性。这种方法会导致编译错误。

首先，变量ATTRIBUTE_FOO具有static和final修饰符，但编译器无法计算该字段。应用程序在运行时计算它。

其次，注解属性在 JVM 加载类之前必须有一个准确的值。但是，当static初始化程序运行时，该类已经加载。所以，这个限制是有道理的。

在字段初始化时出现相同的错误。由于相同的原因，此代码不正确：

@Marker(Example.ATTRIBUTE_FOO)
public class Example {
    static final String[] ATTRIBUTES = {"foo", "Bar"};
    static final String ATTRIBUTE_FOO = ATTRIBUTES[0];
    // ...
}

JVM 如何初始化ATTRIBUTE_FOO？数组访问运算符*ATTRIBUTES[0]*在类初始化程序中运行。因此，ATTRIBUTE_FOO是一个运行时常量。它不是在编译时定义的。

4. 数组常量作为注解属性

让我们考虑一个数组注解属性：

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface Marker {
    String[] value();
}

此代码将无法编译：

@Marker(value = Example.ATTRIBUTES)
public class Example {
    static final String[] ATTRIBUTES = {"foo", "bar"};
    // ...
}

首先，虽然final修饰符保护引用不被更改，但我们仍然可以修改数组元素。

其次，数组文字不能是运行时常量。JVM 在静态初始化器中设置每个元素——我们之前描述的一个限制。

最后，类文件存储该数组的每个元素的值。因此，编译器计算属性数组的每个元素，并在编译时发生。

因此，我们每次只能指定一个数组属性：

@Marker(value = {"foo", "bar"})
public class Example {
    // ...
}

我们仍然可以使用常量作为数组属性的原始元素。

5. 标记界面中的注解：为什么不起作用？

所以，如果一个注解属性是一个数组，我们每次都要重复一遍。但我们想避免这种复制粘贴。为什么我们不做我们的注解*@Inherited*呢？我们可以将注解添加到标记界面：

@Marker(value = {"foo", "bar"})
public interface MarkerInterface {
}

然后，我们可以让需要这个注解的类实现它：

public class Example implements MarkerInterface {
    // ...
}

这种方法行不通。代码将无错误地编译。但是，Java 不支持从接口继承注解，即使注解本身具有*@Inherited*注解。因此，实现标记接口的类不会继承注解。

原因是多重继承的问题。确实，如果多个接口有相同的注解，Java 不能选择一个。

所以，我们无法避免这种带有标记界面的复制粘贴。

6. 数组元素作为注解属性

假设我们有一个数组常量并且我们使用这个常量作为注解属性：

@Marker(Example.ATTRIBUTES[0])
public class Example {
    static final String[] ATTRIBUTES = {"Foo", "Bar"};
    // ...
}

此代码不会编译。注解参数必须是编译时常量。但是，正如我们之前所考虑的，数组不是编译时常量。

此外，数组访问表达式不是常量表达式。

如果我们有一个list而不是一个数组怎么办？方法调用不属于常量表达式。因此，使用List类的get方法会导致相同的错误。

相反，我们应该明确地引用一个常量：

@Marker(Example.ATTRIBUTE_FOO)
public class Example {
    static final String ATTRIBUTE_FOO = "Foo";
    static final String[] ATTRIBUTES = {ATTRIBUTE_FOO, "Bar"};
    // ...
}

这样，我们在字符串常量中指定注解属性值，Java编译器就可以明确地找到属性值。