你不知道的System.out.println()

这篇博客是为了解释System.out.println是什么以及它的工作原理。

什么是System.out.println（）

System.out.println是一个Java语句，一般情况下是将传递的参数，打印到控制台。

System - 是 java.lang包中的一个final类。根据javadoc，“ java.lang.System该类提供的设施包括标准输入，标准输出和错误输出流; 访问外部定义的属性和环境变量; 一种加载文件和库的方法; 以及用于快速复制数组等一部分的实用方法... “
out - 是System类的静态成员字段，类型为PrintStream。
```
public static final PrintStream out
```
他在启动时就会被实例化，并与主机的标准输出控制台进行映射。该流在实例化之后立即打开，并准备接受数据。
println - 是PrintStream类的一个方法。println打印（参数内容+换行符）到控制台。PrintStream类中有多个重载的println方法。每个println是通过调用print方法并添加一个换行符实现的。print方法是通过调用write方法实现的

System.out.println() 结构图

以下是JDK源中System.out.println的骨架结构，和代码片段。

UML图

部分代码段：

public final class System {
    static PrintStream out;
    static PrintStream err;
    static InputStream in;
    ...
}

public class PrintStream extends FilterOutputStream {
    //out object is inherited from FilterOutputStream class
    public void println() {
    ...
}

输出重定向——改变输出路径

’out'对象可以自定义的。在启动时由java运行时环境初始化，并且可以在执行期间由开发人员更改。代替在默认情况下的标准输出。当您通过命令行运行程序时，输出将打印在同一个命令窗口中。我们可以使用setOut方法来改变这种行为。在以下示例中，我将输出重定向到同一目录中的文本文件。

public class ChangeOut {
	public static void main(String args[]) {
		try {
			System.setOut(new PrintStream(new FileOutputStream("log.txt")));
			System.out.println("Now the output is redirected!");
		} catch(Exception e) {}
	}
}

System.out.println性能分析

有一个普遍的观念需要大家知道——System.out.println性能并不好。当我们深入分析时，其调用顺序如下println - > print - > write（）+ newLine（）。这个顺序流是Sun / Oracle JDK的实现。write（）和newLine（）都包含一个synchronized块。同步有一点开销，但更多的是添加字符到缓冲区和打印的开销更大。

当我们运行性能分析时，运行多个System.out.println并记录时间，执行时间会按比例增加。当打印超过50个字符并打印超过50,000行时，性能下降。

当然这一切都取决于我们使用的场景。不过无论如何请勿使用System.out.println打印日志（ logging）到stdout。

System.out.println VS 日志记录组件（Log4j等）

System.out.println vs loggers like Log4j

Log4J具有多种记录级别。如果我们正在编写一个小程序，只是为了实验/学习目的那么使用 System.out.println 就很不错。但当我们开发生产质量软件时，我们应该注意到应该使用记录组件（log4j等），并且应该避免使用System.out.println。为什么？

灵活性：log4j的记录器提供了多种记录级别。我们可以相应地分隔日志信息。例如，X消息只能在PRODUCTION上打印，Y消息应打印在ERROR等上。
可重构性：log4j只需一个参数更改即可关闭所有日志记录。
可维护性：想象一下，如果我们有数百个System.out.println全部通过应用程序散落，那么在一段时间内将难以维护程序。
粒度：在应用程序中，每个类都可以有不同的记录器并相应地进行控制。
实用性：在System.out中限制重定向消息的选项，但是如果是记录器(like log4j)，则可以提供多种选项。我们甚至可以创建自定义输出选项并将其重定向。

所以我们不应该使用System.out.println进行日志记录和调试（logging and debugging）

静态导入来缩短System.out.println

Static Import to Shorten System.out.println()

有时我们觉得System.out.println是一个很长的语句要打印。静态导入可能会缩短一点，但不推荐使用，因为它导致可读性差。我只是使用这种情况来解释静态导入，并避免在下面的情况下使用它。

import static java.lang.System.out;

public class ShortSOP {
public static void main(String[] args) {
out.println("Hello, world");
}
}

不静态导入的话直接写out.println会提示编译错误的。

System.err和System.in

作为相关部分，接下来介绍一下“err”和“in”。'in'与InputStream相关联。与“out”相对，“in”用于从标准控制台通用键盘获取输入。

'err'与PrintStream相关联，并将参数打印到标准错误输出流。当您使用eclipse等的IDE时，可以看到“out”和“err”之间的输出差异。

import java.io.*;

/**
 * Created by zjl on 2017/9/16.
 */
public class InOutErr {
    public static void main(String args[]) {
        try {
        	System.out.println("请输入一段话");
            BufferedReader reader = new BufferedReader(new InputStreamReader(System.in ));
            String filename = reader.readLine();

            InputStream input = new FileInputStream(filename);
            System.out.println("File opened...");

        } catch (IOException e){
            System.err.println("Where is that file?");
        }
    }
}

打印结果：

翻译自：http://javapapers.com/core-java/system-out-println/

来源：oschina

链接：https://my.oschina.net/u/2885163/blog/1538380

标签

Shorten

java

eclipse

log4j

JDK