Android Studio错误的含义：未注释的参数会覆盖@NonNull参数

Question

我正在尝试使用Android Studio。在创建一个新项目并向创建MyActivity类添加一个默认的onSaveInstanceState方法时，当我尝试将代码提交给Git时，我得到一个我不明白的奇怪错误。代码是这样的：

我得到的错误是：

如果我尝试将方法签名更改为protected void onSaveInstanceState(@NotNull Bundle outState)，则IDE会告诉我无法解析符号NotNull。

我需要做些什么才能摆脱警告？

Answer 1

它是一个注释，但正确的名称是NonNull：

protected void onSaveInstanceState(@NonNull Bundle outState)

（还有）

import android.support.annotation.NonNull;

目的是允许编译器在违反某些假设时发出警告（例如应始终具有值的方法的参数，如在此特定情况下，尽管还有其他假设）。来自Support Annotations文档：

  

@NonNull注释可用于指示给定参数   不能为空。

     

如果已知局部变量为null（例如因为某些变量）   早期的代码检查它是否为null），并将其作为一个传递   参数指向该参数标记为@NonNull的方法   IDE会警告您可能会发生崩溃。

它们是静态分析的工具。运行时行为根本不会改变。

---

在这种情况下，特定警告是您覆盖的原始方法（在Activity中）@NonNull参数上有outState注释，但您没有将其包含在最重要的方法中。只需添加它就可以解决问题，即

@Override
protected void onSaveInstanceState(@NonNull Bundle outState) {
    super.onSaveInstanceState(outState);
}

Answer 2

最近在Android支持库中添加了许多有用的support annotations。它们的主要作用是注释各种方法和参数的属性，以帮助捕获错误。例如，如果您将null值传递给标有NotNull注释的参数，则会收到警告。

通过添加以下依赖项，可以使用Gradle将注释添加到项目中：

dependencies {
    compile 'com.android.support:support-annotations:20.0.0'
}

您收到警告，因为Bundle参数标有@NotNull注释，并且通过覆盖注释被隐藏的方法。正确的做法是将注释添加到overriden方法的参数中。

@Override
protected void onSaveInstanceState(@NonNull Bundle outState) {
    super.onSaveInstanceState(outState);
}

Answer 3

除了其他答案之外，@NonNull（以及它的对手，@Nullable）注释会注释字段，参数或方法返回类型。 IntelliJ和Android Studio可以在编译时警告您可能NullPointerException。

最好的例子是：

@NonNull private String myString = "Hello";

@Nullable private String myOtherString = null;

@NonNull 
public Object doStuff() {
    System.out.println(myString.length); // No warning
    System.out.println(doSomething(myString).length); // Warning, the result might be null.

    doSomething(myOtherString); // Warning, myOtherString might be null.

    return myOtherString; // Warning, myOtherString might be null.
}

@Nullable
private String doSomething(@NonNull String a) {
    return a.length > 1 ? null : a; // No warning
}

---

这些注释不会改变运行时行为（尽管我有experimented），但它可以作为防止错误的工具。

请注意，您收到的消息不是错误，而是一个警告，如果您选择，可以安全地忽略。另一种方法是自己注释参数，如Android Studio所示：

@Override
protected void onSaveInstanceState(@NonNull Bundle outState) {
    super.onSaveInstanceState(outState);
}