使用 Java8 进行操作-可选

Question

我在一些项目中经常使用 do-while-checkNextForNull-getNext 循环模式（不知道是否有正式名称）。但是在 Java8 中，使用 Optional 被认为是比在客户端代码中检查空引用更干净的代码。但是当在这种循环模式中使用 Optional 时，代码会变得有点冗长和丑陋，但是因为 Optional 有一些方便的方法，我希望一定存在比我下面提出的更简洁的方法。

例子：

给定以下课程。

class Item {
    int nr;

    Item(nr) {
        this.nr = nr;
        // an expensive operation
    }

    Item next() {
        return ...someCondition....
            ? new Item(nr + 1)
            : null;
    }
}

其中第一项始终具有 nr==1 并且每个项决定下一项，并且您不想创建不必要的新项。

我可以在客户端代码中使用以下循环 do-while-checkNextForNull-getNext 模式：

Item item = new Item(1);
do {
    // do something with the item ....
} while ((item = item.next()) != null);

使用 Java8-Optional，给定的类变为：

class Item {
    ....

    Optional<Item> next() {
        return ...someCondition....
            ? Optional.of(new Item(nr + 1))
            : Optional.empty();
    }
}

然后 do-while-checkNextForNull-getNext 循环模式变得有点丑陋和冗长：

Item item = new Item(1);
do {
    // do something with the item ....
} while ((item = item.next().orElse(null)) != null);

orElse(null)) != null 部分感觉不舒服。

我一直在寻找其他类型的循环，但没有找到更好的循环。有更清洁的解决方案吗？

更新：

可以使用 for-each 循环同时避免空引用（使用空引用被认为是一种不好的做法）。该方案由 Xavier Delamotte 提出，不需要 Java8-Optional。

使用通用迭代器实现：

public class Item implements Iterable<Item>, Iterator<Item> {
    int nr;

    Item(int nr) { 
        this.nr = nr;
        // an expensive operation
    }

    public Item next() {
        return new Item(nr + 1);
    }

    public boolean hasNext() {
        return ....someCondition.....;
    }

    @Override
    public Iterator<Item> iterator() {
        return new CustomIterator(this);
    }
}

和

class CustomIterator<T extends Iterator<T>> implements Iterator<T> {
    T currentItem;
    boolean nextCalled;

    public CustomIterator(T firstItem) {
        this.currentItem = firstItem;
    }

    @Override
    public boolean hasNext() {
        return currentItem.hasNext();
    }

    @Override
    public T next() {
        if (! nextCalled) {
            nextCalled = true;
            return currentItem;
        } else {
            currentItem = currentItem.next();
            return currentItem;
        }
    }
}

然后客户端代码变得非常简单/干净：

for (Item item : new Item(1)) {
    // do something with the item ....
}

虽然这可能被视为违反了迭代器协定，因为 new Item(1) 对象包含在循环中，而通常情况下，for 循环会立即调用 next() 并因此跳过第一个对象。换句话说：对于第一个对象，next() 被违反了，因为它返回了第一个对象本身。

Answer 1

你可以这样做：

Optional<Item> item = Optional.of(new Item(1));
do {
    Item value = item.get();
    // do something with the value ....
} while ((item = value.next()).isPresent());

或（避免额外的变量）：

Optional<Item> item = Optional.of(new Item(1));
do {
    // do something with item.get() ....
} while ((item = item.get().next()).isPresent());

Answer 2

在 Java8 中，使用 Optional 被认为是比在客户端代码中检查空引用更简洁的代码

不，反之亦然：Optional 可以用在它帮助编写更简洁的代码的地方。在没有的地方，只要坚持旧的成语。如果您现有的习语看起来不错，请不要感到使用它的任何压力——在我看来确实如此。例如，这将是 Optional 的良好用法：

item.next().map(Object::toString).ifPresent(System.out::println);

由于您需要在第一个不存在的 Optional 上跳出循环，这并没有真正的帮助。

但是，我认为您的真正兴趣更广泛：将 Java 8 的特性用于您的代码。您应该选择的抽象是 Stream：

itemStream(() -> new Item(1)).forEach(item -> { ... all you need ... });

当然，您现在可以尽情使用流处理：

itemStream(() -> new Item(1)).filter(item.nr > 3).mapToInt(Item::nr).sum();

这就是构建流的方式：

import java.util.Spliterators;
import java.util.function.Consumer;
import java.util.function.Supplier;
import java.util.stream.Stream;
import java.util.stream.StreamSupport;

public class ItemSpliterator extends Spliterators.AbstractSpliterator<Item>
{
  private Supplier<Item> supplyFirst;
  private Item lastItem;

  public ItemSpliterator(Supplier<Item> supplyFirst) {
    super(Long.MAX_VALUE, ORDERED | NONNULL);
    this.supplyFirst = supplyFirst;
  }

  @Override public boolean tryAdvance(Consumer<? super Item> action) {
    Item item;
    if ((item = lastItem) != null)
      item = lastItem = item.next();
    else if (supplyFirst != null) {
      item = lastItem = supplyFirst.get();
      supplyFirst = null;
    }
    else return false;
    if (item != null) {
      action.accept(item);
      return true;
    }
    return false;
  }

  public static Stream<Item> itemStream(Supplier<Item> supplyFirst) {
    return StreamSupport.stream(new ItemSpliterator(supplyFirst), false);
  }
}

有了这个，您离无缝并行计算的能力只有一步之遥。由于您的项目流基本上是连续的，我建议您查看我的blog post 关于这个主题。

Answer 3

只需将循环支持添加到您的 API：

class Item {
    int nr;

    Item(int nr) {
        this.nr = nr;
        // an expensive operation
    }

    public void forEach(Consumer<Item> action) {
        for(Item i=this; ; i=new Item(i.nr + 1)) {
            action.accept(i);
            if(!someCondition) break;
        }
    }
    public Optional<Item> next() {
        return someCondition? Optional.of(new Item(nr+1)): Optional.empty();
    }
}

然后你可以简单地通过 lambda 表达式进行迭代

    i.forEach(item -> {whatever you want to do with the item});

或方法引用

    i.forEach(System.out::println);

如果您想支持比 forEach 循环更复杂的操作，supporting streams 是正确的选择。相似之处在于您的实现封装了如何迭代 Items。

Answer 4

由于这与某种设计有关，我提出了以下设计。

创建支持提供可选下一步的接口。

public interface NextProvidble<T> {

    Optional<T> next();
}

Item 实现 NextProvidble 接口。

public class Item implements NextProvidble<Item> {
    int nr;

    Item(int nr) {
        this.nr = nr;
        // an expensive operation
    }

    @Override
    public Optional<Item> next() {
        return /*...someCondition....*/ nr < 10 ? Optional.of(new Item(nr + 1)) : Optional.empty();
    }

    @Override
    public String toString() {
        return "NR : " + nr;
    }
}

这里我使用 /...someCondition..../ 作为 nr

Custom Do While 的新类如下所示。

public abstract class CustomDoWhile<T extends NextProvidble<T>> {

    public void operate(T t) {
        doOperation(t);
        Optional<T> next = t.next();
        next.ifPresent( nextT -> operate(nextT));
    }

    protected abstract void doOperation(T t);
}

现在您必须在客户端代码中执行什么操作。

 new CustomDoWhile<Item>() {
            @Override
            protected void doOperation(Item item) {
                System.out.println(item.toString());
            }
        }.operate(new Item(1));

可能很清楚。 请添加您的想法。

Answer 5

在此处删除自 Java 9 以来可用的另一个替代方案。

Stream.iterate(new Item(1), Item::hasNext, Item::next)
      .forEach(this::doSomething)

doSomething(Item item) 是对项目执行某些操作的方法。