在 Java 限定类型中有注释 tmesis/inside 的目的是什么？

Question

这有什么目的吗 static @NotNull @Other My.@NotNull @Other Builder createBuilder()

import java.lang.annotation.ElementType;
import java.lang.annotation.Target;

public class A {
    static class My {
        static class Builder {
            public My build() {
                return new My(); } } }

    @Target({ElementType.METHOD, ElementType.TYPE_USE})
    public @interface NotNull { }

    @Target({ElementType.METHOD, ElementType.TYPE_USE})
    public @interface Other { }

    public static @NotNull @Other My.@NotNull @Other Builder createBuilder() {
        return new My.Builder();
    }
}

Answer 1

使用这种结构的主要原因是向后兼容。

在 Java 8 之前，没有类型注解，因此通常使用方法注解来实际描述方法的返回类型，例如

@Target(ElementType.METHOD)
public @interface NotNull { }

@Target(ElementType.METHOD)
public @interface Other { }

public static @NotNull @Other My.Builder createBuilder() {
    return new My.Builder();
}

从 Java 8 开始，您可以注释返回类型本身，这就是您通常会做的事情。但是为了支持仍在寻找方法注释的旧工具，您可以保留@Target METHOD. 对于由简单名称组成的返回类型，方法注解和返回类型注解的代码位置是一样的，所以可以同时创建一个方法注解和一个返回类型注解，只出现一次，即

@MethodAndTypeAnnotation ReturnType method() …

但是，对于限定名称，语法是不同的，因为类型注释必须紧接在被注释元素的简单名称之前，即

@Target(ElementType.TYPE_USE)
public @interface NotNull { }

@Target(ElementType.TYPE_USE)
public @interface Other { }

public static My.@NotNull @Other Builder createBuilder() {
    return new My.Builder();
}

对于纯类型注解，使用public static @NotNull @Other My.Builder createBuilder()会导致编译器错误，因为它是尝试注解My，这里仅用作限定符，而不是实际的类型使用。请注意，如果Builder是内部类而不是嵌套类（即 not static），则注释外部类型是合法的，尽管不太可能需要。

所以在你的情况下

@Target({ElementType.METHOD, ElementType.TYPE_USE})
public @interface NotNull { }

@Target({ElementType.METHOD, ElementType.TYPE_USE})
public @interface Other { }

//            method annotation    type annotation
public static @NotNull @Other   My.@NotNull @Other Builder createBuilder() {
    return new My.Builder();
}

两种情况都需要注释方法和返回类型。如前所述，如果Builder是一个内部类，第一次出现对外部类型进行注释是合法的，无论您是否愿意，它都会对其进行注释。

因此，一般而言，不建议将“类型使用”注释范围与其他范围混合使用，而是更新代码处理工具仍然需要方法或字段注释的任务，这些任务实际上是类型注释的工作。

如前所述，对于简单的名称，您可以同时注释方法和返回类型，这也适用于使用import语句时的嵌套类型。但这需要顶级类在一个包中：

package example;

import example.A.My.Builder;

public class A {
    static class My {
        static class Builder {
            public My build() {
                return new My(); } } }

    @Target({ElementType.METHOD, ElementType.TYPE_USE})
    public @interface NotNull { }

    @Target({ElementType.METHOD, ElementType.TYPE_USE})
    public @interface Other { }

    public static @NotNull @Other Builder createBuilder() {
        return new My.Builder();
    }
}