为什么 PrintStream::printf 返回一个 PrintStream？答案

【问题标题】：Why does PrintStream::printf return a PrintStream?为什么 PrintStream::printf 返回一个 PrintStream？
【发布时间】：2018-06-22 15:59:12
【问题描述】：

PrintStream 的 printf 方法的返回类型为 PrintStream，每次调用它都会返回这个对象（其他打印方法都是 void）。那么为什么会这样设计呢？就此而言，如果您有一个具有返回对象本身的方法的任何类型的对象，那又有什么意义呢？你已经有了这个对象（特别是这个对象）。那么为什么要返回这个对象呢？

【问题讨论】：

标签： java return printstream

【解决方案1】：

它被称为fluent interface。它的设计使您可以像这样将调用链接在一起：

stream.printf("aaaa")
      .printf("bbbb")
      .printf("cccc");

而不是做：

stream.printf("aaaa");
stream.printf("bbbb");
stream.printf("cccc");

通过在方法末尾返回this实现：

class PrintStream extends FilterOutputStream implements Appendable, Closeable {
    //...

    public PrintStream printf(String var1, Object... var2) {
        return this.format(var1, var2);
    }

    public PrintStream format(String var1, Object... var2) {
        //...
        return this; // <-- here
    }
    //...
}

至于在这种情况下它是否是一个好的设计模式，我不会特别说。这也不是很糟糕。

【讨论】：

【解决方案2】：

返回当前对象的主要目的是启用所谓的fluent API，这使得调用链成为可能：

object.method(arg).otherMethod(arg2).yetOtherMethod(arg3)

这种样式更常用于构建器/工厂类，但在其他类型的类中也很常见。

【讨论】：

【解决方案3】：

返回void 的print() 方法是在PrintStream 的第一个发布版本中定义的遗留/原始方法。

虽然PrintStream printf(String format, Object ... args) 和PrintStream printf(Locale l, String format, Object ... args) 稍后在PrintStream 中引入（更具体地说，在 Java 5 中）。
开发人员可能决定引入流畅的方法来简化其使用，例如：

ps.print("Hello %s", oneString)
  .print("Hello %s", otherString);

由于开发人员不会通过重构现有方法（将void 替换为 fluent 方法）来破坏类的 API，因此我们现在将它们混合在一起。
这些新方法很好，但不幸的是导致 API 不一致：大多数打印方法返回void，只有两个（可能是不太常用的一部分）是流畅的。

【讨论】：