是否应该对称抛出异常？

Question

考虑一个哈希表，如果 get 和 put 操作的 key 为 null，它将引发 NullPointerException (NPE)。这让我想象异常应该是对称的，即 NPE 对于所有涉及空节点输入参数的哈希表操作应该是一致的。

我的理解正确吗？

如果是，那么考虑一个示例类 Graph 的情况，它在下面使用了一个 HashMap。它旨在为空输入抛出 NPE。无需了解其内部结构，它有两个功能：

graph.addNode (node);  // throws NPE if node is null.
graph.getEdges (node); // Should empty collections be returned 
                       // or NPE for null node ? 

根据Effective Java，我们应该更喜欢返回空集合而不是null。现在，如果节点参数为空并且我们想要获取它的边，map.get(null node) 将返回一个空集合。是否仍然首选返回 NPE 以保持对称性？

Answer 1

这不是对称的问题。这是一个合同问题，以及对这份合同的尊重。一个方法应该定义一个关于它接受什么作为参数、它做什么以及它返回和抛出什么的协定。如果调用者不遵守合同，那么这是一个开发错误，应该由运行时异常发出信号。

在调用方不遵守合约时返回有效结果是一个坏主意：它隐藏了错误而不是发出信号，这通常会使问题变得更糟，更难找到。

在您的示例中，将空节点添加到图表是没有意义的。所以应该在adddNode()javadoc中写到该方法不接受null，该方法应该抛出NullPointerException。

同样，请求空节点的边也没有任何意义。这样做的开发人员可能忘记了初始化变量或类似的东西。没有正当理由询问 null 的边缘。所以应该记录getEdges()不接受null，如果null作为参数传递，该方法应该抛出NullPointerException。

当我教这个时，我经常使用下面的例子。假设您创建了一个名为boolean hasCancer(ExaminationResults results) 的方法。这种方法必须分析结果并判断患者是否患有癌症。如果传递的结果为空，它应该返回 true 吗？即使你不知道他是否真的患有癌症，这也会使患者接受癌症治疗。那么它应该返回false吗？好吧，患者可能患有癌症，并且可能会死亡，因为该方法告诉他没有癌症，而实际上并不知道。所以该方法不应该返回任何东西。它应该通过抛出 NullPointerException 来发出错误信号。

从getEdges() 返回一个空集合是否与我的癌症示例相当？你不知道。也许您的图表的最终用户使用它来诊断癌症，并且也许使用空边集合来确定患者患有癌症。所以快速失败，并抛出 NullPointerException。

Answer 2

当客户端调用一个方法时，该方法应该fail-fast，因为比检测错误更容易。它们出现在它们第一次出现的地方。

在您的情况下，您有一个名为 addNode(node) 的方法。因此，当客户端调用它来添加节点时，行为取决于该方法的合同。我猜你不希望客户端调用它并想要添加一个null 节点。因此，您应该 fail-fast 并抛出 NullPointerException 或者 IllegalArgumentException。

在第二种情况下node.getEdges(node) 它也取决于合同，合同取决于在您的问题领域中什么是有意义的。我认为node.getEdges(null) 应该抛出一个IllegalArgumentException，因为没有边的节点与null 节点不同，我想对此进行区分。

关于返回值的更多考虑

如果客户端从某个方法获得结果，该结果应该使客户端代码更容易编写和容错。

在第二种情况getEdges(node) 中，如果节点没有边，您应该返回一个空集合，因为这使客户端代码更容易。客户端可以避免不必要的null 检查。返回值时，您应该考虑客户端代码以及它将如何处理返回值。那么你应该选择一个让客户端代码更容易的返回值。

例如：我希望getEdges(node) 的客户端代码看起来像这样

 Collection<Node> nodes = grap.getEdges(node);
 for(Node node: nodes){
     ...
 }

因此，如果您返回 null 而不是空集合，则客户端代码必须如下所示

 Collection<Node> nodes = grap.getEdges(node);
 if(nodes != null){
     for(Node node: nodes){
         ...
     }
 }

客户端的最坏情况是如果getEdges(node) 方法在代码没有边时抛出NullPointerException。我认为在图中某些节点不存在边是正常情况。因此我不会抛出异常。

这就是为什么在这种情况下我会返回一个空集合。