498

@Override使用 Java注释 的最佳实践是什么?为什么?

@Override用注释标记每个被覆盖的方法似乎有点过头了。是否有某些编程情况需要使用,@Override而其他情况不应该使用@Override

4

27 回答 27

515

每次重写方法时使用它有两个好处。这样做是为了您可以利用编译器检查来确保您实际上正在覆盖您认为的方法。这样,如果您犯了拼写错误的方法名称或未正确匹配参数的常见错误,您将被警告您的方法实际上并没有像您认为的那样覆盖。其次,它使您的代码更容易理解,因为当方法被覆盖时它会更加明显。

此外,在 Java 1.6 中,您可以使用它来标记方法何时实现接口以获得相同的好处。我认为最好有一个单独的注释(如@Implements),但总比没有好。

于 2008-09-18T16:53:19.833 回答
110

我认为它作为编译时提醒最有用的是该方法的目的是覆盖父方法。举个例子:

protected boolean displaySensitiveInformation() {
  return false;
}

您经常会看到类似上述方法的内容,它覆盖了基类中的方法。这是该类的一个重要实现细节——我们不希望显示敏感信息。

假设这个方法在父类中改为

protected boolean displaySensitiveInformation(Context context) {
  return true;
}

此更改不会导致任何编译时错误或警告 - 但它完全改变了子类的预期行为。

要回答您的问题:如果在超类中缺少具有相同签名的方法表明存在错误,则应使用 @Override 注释。

于 2008-09-18T16:56:51.887 回答
46

这里有很多很好的答案,所以让我提供另一种方式来看待它......

编码时没有矫枉过正。键入@override 不会花费您任何费用,但是如果您拼错了方法名称或签名稍有错误,则可以节省大量资金。

可以这样想:在你导航到这里并输入这篇文章的时间里,你所用的时间几乎比你在余生中输入@override 所花费的时间还要多;但它防止的一个错误可以为您节省数小时。

Java 尽其所能确保您在编辑/编译时没有犯任何错误,这是一种几乎免费的方法来解决除了全面测试之外的任何其他方式都无法预防的整类错误。

您能否在 Java 中提出一种更好的机制来确保当用户打算覆盖一个方法时,他确实做到了?

另一个巧妙的效果是,如果您不提供注释,它会在编译时警告您不小心覆盖了父方法——如果您不打算这样做,这可能很重要。

于 2008-09-18T18:40:02.200 回答
22

我总是使用标签。这是一个简单的编译时标志,可以捕捉我可能犯的小错误。

它会捕获类似的东西,tostring()而不是toString()

小事情有助于大型项目。

于 2008-09-18T16:50:48.873 回答
18

使用@Override注解可以在编译时防止常见的编程错误。如果您在实际上没有覆盖超类方法的方法上有注释,它将引发编译错误。

这很有用的最常见情况是当您更改基类中的方法以具有不同的参数列表时。由于更改了方法签名,用于覆盖超类方法的子类中的方法将不再这样做。这有时会导致奇怪和意外的行为,尤其是在处理复杂的继承结构时。@Override注释可以防止这种情况。

于 2008-09-18T16:54:08.087 回答
14

要利用编译器检查,您应该始终使用 Override 注释。但不要忘记,Java Compiler 1.5 在覆盖接口方法时不允许使用此注解。您可以使用它来覆盖类方法(抽象或非抽象)。

一些 IDE,如 Eclipse,即使配置了 Java 1.6 运行时或更高版本,它们仍保持与 Java 1.5 的合规性,并且不允许如上所述使用 @override。要避免这种行为,您必须转到:项目属性 -> Java 编译器 -> 选中“启用项目特定设置” -> 选择“编译器合规级别”= 6.0 或更高。

如果基础是接口或类,我每次独立覆盖方法时都喜欢使用此注释。

这可以帮助您避免一些典型的错误,例如当您认为您正在覆盖事件处理程序时,您会发现什么也没有发生。想象一下,你想给某个 UI 组件添加一个事件监听器:

someUIComponent.addMouseListener(new MouseAdapter(){
  public void mouseEntered() {
     ...do something...
  }
});

上面的代码编译并运行,但是如果你在 someUIComponent 中移动鼠标,“做某事”的代码将会运行,因为实际上你并没有覆盖基方法mouseEntered(MouseEvent ev)。您只需创建一个新的无参数方法mouseEntered()。如果您使用了@Override注释而不是该代码,那么您会看到一个编译错误,并且您没有浪费时间思考为什么您的事件处理程序没有运行。

于 2009-09-16T13:47:31.183 回答
8

最好将它用于每个打算作为覆盖的方法,以及 Java 6+,每个方法都打算作为接口的实现。

首先,它会在编译时捕获像“ hashcode()”而不是“ ”这样的拼写错误。hashCode()当真正的原因是您的代码从未被调用时,调试为什么您的方法的结果似乎与您的代码不匹配可能会令人费解。

此外,如果超类更改方法签名,则旧签名的覆盖可能是“孤立的”,留下令人困惑的死代码。注释将@Override帮助您识别这些孤儿,以便可以修改它们以匹配新签名。

于 2008-09-18T18:00:51.140 回答
8

接口实现上的@Override不一致,因为在 java 中没有“覆盖接口”之类的东西。

接口实现上的@Override是无用的,因为实际上它不会捕获编译无论如何都不会捕获的错误。只有一种牵强附会的场景,实现者的覆盖实际上做了一些事情:如果您实现了一个接口,并且接口 REMOVES 方法,您将在编译时收到通知,您应该删除未使用的实现。请注意,如果新版本的接口具有 NEW 或 CHANGED 方法,那么您显然会得到一个编译错误,因为您没有实现新的东西。

在 1.6 中,接口实现者上的 @Override 绝不应该被允许,而且 Eclipse 遗憾地选择自动插入注释作为默认行为,我们得到了很多杂乱的源文件。阅读 1.6 代码时,您无法从 @Override 注解中看到一个方法实际上是覆盖了超类中的方法还是只是实现了一个接口。

在实际覆盖超类中的方法时使用 @Override 很好。

于 2009-09-02T14:44:36.663 回答
7

如果您发现自己经常覆盖(非抽象)方法,您可能想看看您的设计。当编译器不会捕获错误时,它非常有用。例如尝试覆盖 ThreadLocal 中的 initValue(),我已经这样做了。

在实现接口方法(1.6+ 功能)时使用 @Override 对我来说似乎有点矫枉过正。如果你有很多方法,其中一些覆盖而另一些没有覆盖,那可能又是糟糕的设计(如果你不知道,你的编辑器可能会显示哪个是哪个)。

于 2008-09-18T16:54:25.400 回答
7

接口上的@Override 实际上很有帮助,因为如果您更改接口,您会收到警告。

于 2008-09-18T17:37:33.783 回答
7

它所做的另一件事是,它在阅读代码时更明显地表明它正在改变父类的行为。比可以帮助调试。

此外,在 Joshua Block 的《Effective Java》(第 2 版)一书中,第 36 项提供了有关注释好处的更多详细信息。

于 2008-09-18T18:41:25.580 回答
6

每当一个方法覆盖另一个方法,或者一个方法在接口中实现签名时。

注释向@Override您保证您确实覆盖了某些东西。如果没有注释,您可能会出现拼写错误或参数类型和编号的差异。

于 2008-09-18T16:50:56.970 回答
6

在实现接口方法时使用@Override 绝对没有意义。在这种情况下使用它没有任何好处——编译器已经发现了你的错误,所以它只是不必要的混乱。

于 2010-01-27T01:53:26.073 回答
5

我每次都用它。当我在一年内重新访问代码时,我可以使用更多信息来快速弄清楚发生了什么,而我已经忘记了我第一次在想什么。

于 2008-09-18T16:49:48.017 回答
5

最好的做法是始终使用它(或让 IDE 为您填充它们)

@Override 的用处是检测父类中尚未报告到层次结构中的更改。没有它,您可以更改方法签名而忘记更改其覆盖,使用@Override,编译器会为您捕获它。

拥有这种安全网总是很好的。

于 2008-09-18T16:54:45.820 回答
5

我到处都用它。关于标记方法的工作,我让 Eclipse 为我做,所以没有额外的工作。

我热衷于持续重构……所以,我会用每一件小事让它更顺利地进行。

于 2008-09-18T17:49:37.873 回答
5
  • 仅用于方法声明。
  • 指示带注释的方法声明覆盖超类型中的声明。

如果始终使用它,它可以保护您免受一大类恶意错误的侵害。

使用@Override 注解来避免这些错误:(在以下代码中找出错误:)

public class Bigram {
    private final char first;
    private final char second;
    public Bigram(char first, char second) {
        this.first  = first;
        this.second = second;
    }
    public boolean equals(Bigram b) {
        return b.first == first && b.second == second;
    }
    public int hashCode() {
        return 31 * first + second;
    }

    public static void main(String[] args) {
        Set<Bigram> s = new HashSet<Bigram>();
        for (int i = 0; i < 10; i++)
            for (char ch = 'a'; ch <= 'z'; ch++)
                s.add(new Bigram(ch, ch));
        System.out.println(s.size());
    }
}

来源:有效的Java

于 2009-10-02T16:45:54.960 回答
3

使用Override的时候要小心,因为以后不能在starUML中做逆向工程;首先制作uml。

于 2010-05-10T16:30:42.700 回答
2

看来这里的智慧正在发生变化。今天我安装了IntelliJ IDEA 9 并注意到它的“缺少 @Override 检查”现在不仅捕获了已实现的抽象方法,还捕获了已实现的接口方法。在我雇主的代码库和我自己的项目中,我很早就习惯于只对前者使用 @Override —— 实现了抽象方法。然而,重新思考这个习惯,在这两种情况下使用注释的优点变得清晰起来。尽管更加冗长,但它确实可以防止接口方法名称发生变化的脆弱基类问题(不像 C++ 相关示例那么严重),从而在派生类中孤立可能实现的方法。

当然,这种情况大多是夸张的;派生类将不再编译,现在缺少重命名接口方法的实现,今天可能会使用重命名方法重构操作来处理整个代码库。

鉴于 IDEA 的检查不可配置为忽略已实现的接口方法,今天我将改变我的习惯和团队的代码审查标准。

于 2009-11-07T00:35:47.160 回答
2

注解@Override 用于帮助检查开发人员是否在父类或接口中重写了正确的方法。当 super 的方法名称发生变化时,编译器会通知这种情况,这只是为了保持与 super 和子类的一致性。

顺便说一句,如果我们没有在子类中声明注解@Override,但我们确实覆盖了super 的某些方法,那么该函数可以与@Override 一样工作。但是当super的方法改变时,这个方法不能通知开发者。因为它不知道开发者的目的——重写super的方法还是定义一个新的方法?

所以当我们想要重写该方法以利用多态性时,我们最好在方法上方添加@Override。

于 2011-11-25T08:31:28.493 回答
1

我尽可能多地使用它来识别方法何时被覆盖。如果您查看 Scala 编程语言,它们也有一个 override 关键字。我觉得它很有用。

于 2011-03-29T15:34:51.660 回答
0

它确实允许您(好吧,编译器)在您对要覆盖的方法名称使用错误拼写时进行捕捉。

于 2008-09-18T16:51:12.087 回答
0

很简单——当你想要覆盖超类中的方法时,使用@Override注解来进行正确的覆盖。如果您没有正确覆盖它,编译器会警告您。

于 2009-12-03T21:43:35.157 回答
0

覆盖注解用于利用编译器,检查您是否真的覆盖了父类中的方法。它用于通知您是否犯了任何错误,例如拼写错误的方法名,错误匹配参数的错误

于 2010-05-18T06:06:28.673 回答
0

我认为最好在允许的情况下对@override 进行编码。它有助于编码。但是,需要注意的是,对于 ecipse Helios,无论是 sdk 5 还是 6,都允许实现接口方法的 @override 注释。至于 Galileo,无论是 5 还是 6,都不允许使用 @override 注解。

于 2010-12-03T05:55:05.410 回答
0

注释确实为编译器提供了有关代码的元数据,并且当我们覆盖基类的任何方法时,注释@Override 用于继承的情况。它只是告诉编译器您正在覆盖方法。它可以避免我们可以做的一些常见错误,例如不遵循方法的正确签名或方法名称拼写错误等。因此使用@Override注解是一个好习惯。

于 2011-11-22T06:40:52.653 回答
0

对我来说,@Override 确保我拥有正确的方法签名。如果我输入注释并且方法拼写不正确,那么编译器会抱怨让我知道有问题。

于 2012-01-16T03:16:54.773 回答