OutputStream

# 03.OutputStream

OutputStream是Java标准库提供的最基本的输出流，它也是一个抽象类，是所有输出流的超类。

类的定义如下

public abstract class OutputStream implements Closeable, Flushable

‍

# write方法

OutputStream的一个最重要的方法就是void write(int b)，签名如下：

public abstract void write(int b) throws IOException;

这个方法会写入一个字节到输出流。要注意的是，虽然传入的是int参数，但只会写入一个字节，即只写入int最低8位表示字节的部分（相当于b & 0xff）。

‍

# `close()`和`flush()`

和InputStream类似，OutputStream也提供了close()方法关闭输出流，以便释放系统资源。要特别注意：OutputStream还提供了一个flush()方法，它的目的是将缓冲区的内容真正输出到目的地。

为什么要有flush()？因为向磁盘、网络写入数据的时候，出于效率的考虑，操作系统并不是输出一个字节就立刻写入到文件或者发送到网络，而是把输出的字节先放到内存的一个缓冲区里（本质上就是一个byte[]数组），等到缓冲区写满了，再一次性写入文件或者网络。对于很多IO设备来说，一次写一个字节和一次写1000个字节，花费的时间几乎是完全一样的，所以OutputStream有个flush()方法，能强制把缓冲区内容输出。

通常情况下，我们不需要调用这个flush()方法，因为缓冲区写满了OutputStream会自动调用它，并且，在调用close()方法关闭OutputStream之前，也会自动调用flush()方法。

但是，在某些情况下，我们必须手动调用flush()方法。举个栗子：

小明正在开发一款在线聊天软件，当用户输入一句话后，就通过OutputStream的write()方法写入网络流。小明测试的时候发现，发送方输入后，接收方根本收不到任何信息，怎么肥四？

原因就在于写入网络流是先写入内存缓冲区，等缓冲区满了才会一次性发送到网络。如果缓冲区大小是4K，则发送方要敲几千个字符后，操作系统才会把缓冲区的内容发送出去，这个时候，接收方会一次性收到大量消息。

解决办法就是每输入一句话后，立刻调用flush()，不管当前缓冲区是否已满，强迫操作系统把缓冲区的内容立刻发送出去。

实际上，InputStream也有缓冲区。例如，从FileInputStream读取一个字节时，操作系统往往会一次性读取若干字节到缓冲区，并维护一个指针指向未读的缓冲区。然后，每次我们调用int read()读取下一个字节时，可以直接返回缓冲区的下一个字节，避免每次读一个字节都导致IO操作。当缓冲区全部读完后继续调用read()，则会触发操作系统的下一次读取并再次填满缓冲区。

# FileOutputStream

我们以FileOutputStream为例，演示如何将若干个字节写入文件流：

    OutputStream output = new FileOutputStream("readme.txt");
    output.write(72); // H
    output.write(101);  // e
    output.write(108);  // l
    output.write(108);  // l
    output.write(111);  // o
    output.close();

1
2
3
4
5
6
7

‍

运行结果：

$ javac IODemo6FileOutputStream1.java
$ java IODemo6FileOutputStream1   
$ cat readme.txt
Hello

1
2
3
4

‍

每次写入一个字节非常麻烦，更常见的方法是一次性写入若干字节。这时，可以用OutputStream提供的重载方法void write(byte[])来实现：

    OutputStream output = new FileOutputStream("readme.txt");
    output.write("HelloWorld".getBytes("UTF-8"));
    output.close();

1
2
3

运行结果：

$ javac IODemo6FileOutputStream2.java  
$ java IODemo6FileOutputStream2  
$ cat readme.txt               
HelloWorld

1
2
3
4

‍

上述代码没有考虑到在发生异常的情况下如何正确地关闭资源。写入过程也会经常发生IO错误，例如，磁盘已满，无权限写入等等。我们需要用try(resource)来保证OutputStream在无论是否发生IO错误的时候都能够正确地关闭。

‍

# 如果文件不存在...

使用new Fileoutputstream(filepath)时，如果filepath指定的文件不存在，文件输出流会帮我们自动创建一个文件。但仅仅是文件而已，如果filepath中包含尚未创建的目录，就会抛出文件找不到异常。所以在使用输出流之前，最好先确定文件是否存在，不存在则使用File的mkdirs方法，先创建文件目录

‍

# 阻塞

和InputStream一样，OutputStream的write()方法也是阻塞的。

‍

# `ByteArrayOutputStream`

ByteArrayOutputStream可以在内存中模拟一个OutputStream：

    byte[] data;
    try (ByteArrayOutputStream output = new ByteArrayOutputStream()) {
      output.write("HelloWrold!".getBytes());
      data = output.toByteArray();
    }
    System.out.println(new String(data, "UTF-8"));

1
2
3
4
5
6

由于OutputStream里没有toByteArray方法，因此这里就为了简单，没有用OutputStream接受变量

‍

运行结果：

$ javac IODemo6ByteOutputStream2.java  
$ java IODemo6ByteOutputStream2  
HelloWrold!

1
2
3

ByteArrayOutputStream实际上是把一个byte[]数组在内存中变成一个OutputStream，虽然实际应用不多，但测试的时候，可以用它来构造一个OutputStream。

‍

同时操作多个AutoCloseable资源时，在try(resource) { ... }语句中可以同时写出多个资源，用;隔开。例如，同时读写两个文件：

// 读取input.txt，写入output.txt:
try (InputStream input = new FileInputStream("input.txt");
     OutputStream output = new FileOutputStream("output.txt"))
{
    input.transferTo(output); // transferTo的作用是复制文件
}

1
2
3
4
5
6

‍

# 小结

Java标准库的java.io.OutputStream定义了所有输出流的超类：

FileOutputStream实现了文件流输出；
ByteArrayOutputStream在内存中模拟一个字节流输出。

某些情况下需要手动调用OutputStream的flush()方法来强制输出缓冲区。

总是使用try(resource)来保证OutputStream正确关闭。

在GitHub上编辑此页

上次更新: 2023/2/5 14:25:24

← InputStream Decorator模式→

OutputStream

# 03.OutputStream

# write方法

# close()​​和flush()​​

# FileOutputStream

# 如果文件不存在...

# 阻塞

# ByteArrayOutputStream​

# 小结

# `close()`和`flush()`

# `ByteArrayOutputStream`