Java 迭代器实现 - next() 和 hasNext() 强制执行顺序

Question

我有一个java.util.Iterator 的实现，它要求对next() 的调用应始终由对hasNext() 的调用进行。 （这是因为结果在多线程环境中是异步返回的，并且永远不清楚可能还有多少结果。

在 JavaDoc 中正确记录这一点是否“正确”，然后在违反时抛出 RuntimeException。或者这是否将 Iterator 接口拉伸得太远了？

感谢所有想法？

Answer 1

我可能在这里遗漏了一些东西，但为什么不在您的实现内部调用hasNext()？

Answer 2

要求在next() 之前调用hasNext() 违反了iterator 合同。你真的应该重写它，如果没有要返回的元素，next() 只会抛出 NoSuchElementException。

Answer 3

我想你正在做这样的事情：

class IteratorImpl<T> implements Iterator<T> {
  private Source<T> source = ...
  private T next = null;

  public boolean hasNext() {
    if(next == null) {
      next = source.poll();
    }
    return next != null;
  }

对我来说这听起来不错。我无法想象在没有hasNext 的情况下你想使用next 的情况——这将是例外情况。

---

编辑：

hasNext() 的 doc 表示：

如果迭代有更多元素，则返回 true。 （换句话说，如果 next 将返回一个元素而不是抛出异常，则返回 true。）

对我来说，实施并不违反合同。但是，我会（作为Fabian Steeg implies）仍然将next() 实现为：

  public T next() {
    if(!hasNext()) {
      throw new NoSuchElementException();
    }
    T ret = next;
    next = null;
    return ret;
  }

我的意思是，那张支票到底花了你多少钱？

您必须按照API contract 进行检查并抛出NoSuchElementException。我相信，在 !hasNext() 或 next == null 上进行测试都将满足此标准，但我更倾向于前者。

如果有人抓到NoSuchElementException 而不是调用hasNext()，你可能会遇到更大的问题。

Answer 4

如果您的hasNext() 和next() 调用不在同步块/方法中，则即使您在next() 之前调用hasNext()，也不能保证您将拥有元素。

Iterator 接口的约定是如果没有更多元素，则应该抛出NoSuchElementException。所以继续使用next() 方法，直到出现此类异常。

也就是说，看看 java.util.concurrent 包 - 它有并发集合，其迭代器可以帮助你 - 即你可以使用这些集合和迭代器而不是实现自己的。

Answer 5

当没有更多元素时，我宁愿从next() 抛出异常。在多线程环境中hasNext() 无论如何也没什么用。

Answer 6

您可以自己实现Iterator 接口（如果您需要与其他API 接口）并要求您的客户实现您自己的更严格的接口。

我在我的函数式编程库中创建了这样一个类，以便在工作项目中轻松实现 Iterator 周围的 ResultSet。

我的类EasierIterator实现了Iterator接口，同时要求客户端实现一个基于moveNext()/getCurrent()的更简单的接口。它实际上会为您缓存当前项目。

Answer 7

您可以执行与以下类似的操作，将底层数据获取委托给私有方法，并实现 hasNext() 和 next() 以对数据缺失做出不同的反应。这样做的好处是您可以重复调用next() 而无需先调用hasNext()，因此不会违反Iterator 的约定。

public class IteratorImpl<T> implements Iterator<T> {
  private final Source<T> source;
  private T next;

  public synchronized boolean hasNext() {
    tryGetNext();
    return next != null;
  }

  public synchronized T next() {
    tryGetNext();

    if (next == null) {
      throw new NoSuchElementException();
    } 

    return next;
  }

  private void tryGetNext() {
    if (next != null) {
      next = source.poll();
    }
  }
}

Answer 8

编辑：在这个答案中，我试图争辩说问题所问的内容是允许的。但是我忽略了Iterator.hasNext 文档中的一句话，这使我的整个推理无效：

换句话说，如果next() 将返回一个元素而不是抛出异常，则返回true。

这似乎意味着重复调用 next 直到 hasNext 返回 true 并调用 next 直到你得到 NoSuchElementException 应该返回相同的元素序列。

因此，问题所问的似乎是不允许允许的。

原答案

这是对规范律师类型答案的尝试。为了清楚起见，我将以简洁的形式重申这个问题：

Iterable 规范是否允许在调用 Iterator.next 而不事先调用 Iterator.hasNext 时抛出 NoSuchElementException，即使在先调用 Iterator.hasNext 时会返回一个元素？

讨论

Iterator.hasNext 的文档指出：

如果迭代有更多元素，则返回 true。

对于Iterator.next：

抛出：NoSuchElementException - 如果迭代没有更多元素

显然，当“迭代没有更多元素”时允许抛出NoSuchElementException，但在此之前不允许。这应该与 hasNext 返回 false 的时间一致。

这就引出了一个问题：文档中的“迭代”和“元素”到底是什么意思？ Iterator 文档没有给出答案，这为实施者提供了一些摆动空间。

在我看来有两种可能的解释：

1. 从迭代器接口本身的角度来看，唯一存在的“迭代”概念是“只要hasNext 返回true”。这意味着如果客户端在hasNext 之前调用next，他们不知道是否还有更多元素，这是未定义的。

   因此，规范允许迭代器实现者决定迭代已经完成。所以这个问题的答案是肯定的。

2. 但是Iterable.iterator 上的文档也提到了“元素”：

   返回T 类型元素的迭代器。

   那么这里的“元素”是什么意思？这是否意味着“集合中的所有元素都实现了Iterable？不，它没有这么说，而且不是所有的可迭代对象甚至都有一组固定的元素。

   对于某些特定的可迭代对象来说，“元素”的含义由实现者决定。迭代器的“元素”的有效定义可以是“集合中的所有元素，或者，在客户端决定在 hasNext 之前调用 next 之前的所有元素”。

   所以这个案例也导致了这个问题的答案是肯定的结论。 （但请看最后的注释！）

结论

文档不是很清楚，但问题的答案似乎是：是的，这是允许的。

注意

如果迭代器做了问题所要求的关于该行为的事情，当然应该记录下来。但其他可迭代对象也应该记录它们的迭代器在哪些元素上。

例如，ArrayList.iterator 文档清楚地说明了迭代器结束的哪些元素：

以正确的顺序返回此列表中元素的迭代器。

---

^{最后说明：是的，我花了这么多时间在这上面太疯狂了。}