04-17.eri-test Java周二生效！ 继承或禁止继承的设计和文档类。

在上一章的回顾中，我们谈到了实现继承的危险。承认这一点是有时实现继承是正确的做法。今天我们要讨论的就是这些情况。如何帮助实现继承成功。

首先要知道的是，您应该记录覆盖每个可覆盖方法（即非最终的，公共的或受保护的方法）的影响。这意味着您必须记录何时类在内部使用其自己的方法，以及在什么地方重写方法可能导致意外的结果。在上一章的回顾中，我们看到了一个例子。其他应该记录的内容是是否可以从静态上下文，后台线程等调用此方法。任何可能影响实现者实现方法的方式。

从Java8开始，JavaDoc已添加了一项新功能来简化此操作。此功能在文档中增加了一个新部分，专门用于简化此文档，@implspec。让我们看一下在java。util。AbstractCollection的去掉方法的JavaDoc。

{@inheritDoc}此实现遍历集合以查找指定的对象元件。如果找到该元素，则将其从集合中删除使用迭代器的去掉方法。请注意，如果执行此操作，则抛出UnsupportedOperationException此集合的迭代器方法返回的迭代器未实现remove方法，并且此集合包含指定的对象。

这清楚地表明，改变迭代器作品会影响这个remove函数的行为。想象一下，当我们覆盖了加和全部添加在功能哈希集在我们之前的评论中，我们可能已经知道全部添加函数称为加功能。

“但是，凯尔，”您说，“我们的文档不应谈论函数的功能，而不是函数的功能。”您是正确的，这就是良好的API文档做法所建议的。不幸的是，由于实现继承破坏了封装，因此为了便于子类的实现，我们需要编写此“如何”文档，以便子类的实现者知道如何做到这一点，并且不会因意外行为而失明。

您可能还需要创建受保护的方法，以便实现者可以有效地实现其子类。这导致实现中的额外工作，并可能需要更多代码来简化此行为。这些方法应该存在于受保护的访问级别，而不是上市访问级别，以避免污染公共API。

那你做什么私人的你做什么受保护的？这将需要一些思考和尝试。不幸的是，没有公式。确保可以访问所需的内容而不访问不需要的内容的最佳方法是编写一些子类并查看其感觉。音高有效的Java使您为扩展编写的每个类都创建三个子类，并让这些子类之一由超类的作者以外的其他人编写，然后再发布。发布后，您几乎不得不保留刚开始的实现。

您也不能从构造函数中调用可重写的方法。这可能会导致奇怪的故障，而这种故障最好避免。这是因为该方法将在子类的构造函数运行之前被调用。让我们来看一个例子。

上市class超{上市超（）{OverrideMe（）;}上市 虚空 OverrideMe（） {} } 上市 class 子 延伸 超 {私人的 最后 瞬间 瞬间;上市 子（） {这个。瞬间 = 瞬间。现在（）;}@Override上市 虚空 OverrideMe（） {系统。出。打印（瞬间）;}上市 静态的 虚空 主要（） {子 子 = 新 子（）;系统。出。打印（子。OverrideMe（））；} }

Running 这个 code you will see two 出puts to your standard 出。 One is 空值一个是瞬间。 This is because OverrideMe从调用超 class's constructor。 The craziest part of this is that we get two different values output for the same 最后 variable。

要记住的其他一些事情是实施可克隆的和可序列化 can be dangerous when implemented on one of these classes created for inheritance。 There are some techniques that can be found in the chapter talking about 可克隆的减轻这种风险。 基本上可以归结为不调用可重写方法以完成可克隆的工作。

So as you can see this is a lot of work. Indeed it is. This is why our default action should be not to create our classes for inheritance unless we really need to. So how do we prevent this? There are two 主要 ways of doing it.

1. 上课最后
2. Make the constructors 私人的 or package-private.

我还将承认书中没有的另一点。 这种安全性在很大程度上取决于代码的受众。 如果您是将由与您没有直接联系的各种项目使用的类的库作者，则说明您是在一家大公司中，而您的代码已被您无法控制的其他各种组使用，或者 您正在编写将在世界范围内使用的开源库，本章中的建议非常相关。 但是，如果您是微服务开发人员，而您的代码将仅以较小且集中的方式在您自己的团队中使用，我认为您可以放宽其中的一些要求。 是的，我们仍然应该使用可靠的工程实践来编写良好，安全的代码，但是如果需要的话，您也可以更改使用方代码。

因此，存在一些有关如何创建为继承而构建的类的提示和技巧。 这是很多工作，但是如果我们花时间做正确的事，我们可以为其他人以更安全的方式建立坚实的基础而告终。

from: https://dev.to//kylec32/effective-java-tuesday-design-and-document-classes-for-inheritance-or-else-prohibit-it-1751