将表达式分配给局部变量时如何防止Eclipse生成类型注释

Question

假设我有这样的 Java 代码：

package test;

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

public class Test {

    @NotNull
    public static Object object() {
        return new Object();
    }

    public static void test() {
        object();
    }
}

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

当我在“object();”上使用快速修复 (Ctrl+1) 操作“Assign statement to new local variable”时打电话，我收到了：

public static void test() {
    @NotNull
    Object object = object();
}

我不想在我的客户端 Java 代码中添加注释，因为这对我来说只是噪音。我怎样才能防止它一直被生成，而是得到它？

public static void test() {
    Object object = object();
}

所有这一切只发生在注解有@Target(TYPE_USE)时，并且只有当org.eclipse.jdt.core.compiler.compliance=8或更高版本的.settings/org.eclipse.jdt.core.prefs时发生

为了记录，我还提交了enhancement request 565463。

（现实世界的 API 正在声明此类注释以实现更好的 Kotlin 互操作性（使用 JetBrains 注释），因为 Kotlin 可以使用它来区分 T 和 T?，并避免使用 T!）

Answer 1

@NotNull，在您的情况下是不需要的，当且仅当未启用或错误配置基于注释的空值分析时才会添加。

在Project > Properies: Java > Compiler部分中Null analysis：

1. 确保选中复选框启用基于注释的空值分析
2. 不选中复选框Use default annotation for null specification，点击配置...链接并将test.NotNull（或org.jetbrains.annotations.NotNull）配置为'NonNull'注释

请注意，只会添加 ElementType.TYPE_USE 注释。对于带有ElementType.TYPE_USE 注释的方法（不能添加到void 方法），注释指的是返回类型，而不是方法本身。换句话说，当调用这样的方法时，您会得到一个带注释的对象。对我来说，为变量的类型添加 Use of a type 注释是预期的行为。

只有在您的情况下，注释才会变成 unclear，例如具有两个目标 ElementType.TYPE_USE 和 ElementType.METHOD。注释是指返回类型（因此添加它是有意义的）还是方法是指方法本身（因此不应添加）？

也请不要，与 org.jetbrains.annotations.NotNull 相比，org.eclipse.jdt.annotation.NonNull 没有目标 ElementType.METHOD。方法声明怎么可能是null？ @NotNull 方法的含义是什么？根据Javadoc of org.jetbrains.annotations.NotNull("... null 值被禁止返回(for methods)...")，目标ElementType.METHOD 似乎在这里被错误地添加了，因为它确实不参考method declaration。

Answer 2

虽然问题很笼统，但问题背后的用例是 jOOQ API，它开始在 jOOQ 3.14 中添加 Jetbrains 注释（请参阅#6244）以实现更好的 Kotlin 互操作性，例如

interface ResultQuery<R> {
  @NotNull Result<R> fetch();
  @Nullable R fetchOne();
}

在 jOOQ 的情况下，对注解的依赖可以在 Maven 中设置为可选/提供，或者在 JPMS 中设置为 static，这样普通的 Java 客户端代码默认看不到注解：

<dependency>
    <groupId>org.jetbrains</groupId>
    <artifactId>annotations</artifactId>
    <scope>provided</scope>
    <optional>true</optional>
</dependency>

Kotlin 编译器仍然可以看到它：

val q: ResultQuery<R> = ...
q.fetch() // Result<R!>
q.fetchOne() // R?

如果您无法控制的第三方引入了依赖项，则可以像这样将其排除：

<dependency>
    <groupId>org.testcontainers</groupId>
    <artifactId>testcontainers</artifactId>
    
    <exclusions>
        <exclusion>
            <groupId>org.jetbrains</groupId>
            <artifactId>annotations</artifactId>
        </exclusion>
    </exclusions>
</dependency>