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

Question

PrintStream的printf方法有一个返回类型的PrintStream，每次调用它时，它都返回这个对象(其他的打印方法是无效的)。为什么它是这样设计的呢？对于这个问题，如果您有一个类型的对象，它有一个返回对象本身的方法，那么有什么意义呢？您已经有了对象(特别是这个对象)。那么为什么要返回这个对象呢？

Answer 1

这叫fluent接口。它的设计使您可以将调用链接在一起，如下所示：

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
    }
    //...
}

至于在这种情况下它是否是一个好的设计模式，我要说的不是特别的。这也没什么坏处。

Answer 2

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

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

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

Answer 3

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

而PrintStream printf(String format, Object ... args)和PrintStream printf(Locale l, String format, Object ... args)是后来在PrintStream中引入的(更具体地说是在Java5中)。

开发人员可能决定引入fluent方法来简化它的使用，例如：

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

由于开发人员不会通过重构现有方法(用fluent方法代替void)来破坏类的API，所以我们现在将它们混合在一起。

这些新方法很好，但不幸的是，它导致了一个不一致的API :大多数打印方法返回void，只有两个(这可能是较不常见的使用的一部分)是流利的。