inputstream.read() 方法

InputStream.read() 方法详解

InputStream 是 Java 中用于读取字节流数据的抽象类。它提供了多种方法从输入源（如文件、网络连接等）中读取数据，其中 read() 方法是最基本且常用的方法之一。本文将详细介绍 InputStream.read() 方法的几种形式及其使用方式。

一、基础概念

在 Java 的 I/O 流体系中，InputStream 类位于 java.io 包下，是所有字节输入流的超类。它定义了一系列用于读取数据的方法，这些方法可以被其子类实现以提供具体的读取功能。

二、read() 方法的形式

InputStream.read() 方法主要有以下几种形式：

1. int read()

   • 描述：从输入流中读取下一个字节的数据。如果到达流的末尾，则返回 -1。
   • 返回值：返回读取的字节（0 到 255 之间的整数），如果已到达流的末尾，则返回 -1。
   • 抛出异常：可能会抛出 IOException 异常，表示发生 I/O 错误。
   InputStream inputStream = ...; // 获取一个 InputStream 实例 int data; while ((data = inputStream.read()) != -1) { // 处理读取到的字节 }

2. int read(byte[] b)

   • 描述：从输入流中读取最多 b.length 个字节的数据，并将其存储在提供的字节数组 b 中。实际读取的字节数将作为返回值返回；如果因为已经到达流的末尾而不能再读取更多字节，则返回 -1。
   • 参数：byte[] b - 存储读取数据的缓冲区。
   • 返回值：返回读取的字节数（0 到 b.length 之间），如果已经到达流的末尾，则返回 -1。
   • 抛出异常：可能会抛出 NullPointerException（如果 b 为 null）、IndexOutOfBoundsException（如果 b.offset 或 b.count 无效）以及 IOException 异常。
   byte[] buffer = new byte[1024]; int bytesRead; while ((bytesRead = inputStream.read(buffer)) != -1) { // 使用 buffer 中的 bytesRead 个字节的数据 }

3. int read(byte[] b, int off, int len)

   • 描述：尝试从输入流中读取最多 len 个字节的数据，并将这些数据存储到指定的字节数组 b 中，从偏移量 off 开始。实际读取的字节数将作为返回值返回；如果因为已经到达流的末尾而不能再读取更多字节，则返回 -1。
   • 参数：
     • byte[] b - 存储读取数据的缓冲区。
     • int off - 从缓冲区的哪个位置开始存储数据（偏移量）。
     • int len - 最多读取多少个字节。
   • 返回值：返回读取的字节数（0 到 len 之间），如果已经到达流的末尾，则返回 -1。
   • 抛出异常：可能会抛出 NullPointerException（如果 b 为 null）、IndexOutOfBoundsException（如果 off、len 或 b.length - off 无效）以及 IOException 异常。
   byte[] buffer = new byte[1024]; int offset = 0; int lengthToRead = 512; int bytesRead; while ((bytesRead = inputStream.read(buffer, offset, lengthToRead)) != -1) { // 使用 buffer 中的 bytesRead 个字节的数据，从 offset 位置开始 offset += bytesRead; lengthToRead -= bytesRead; if (lengthToRead == 0 && bytesRead != -1) { // 如果还需要继续读取，重置偏移量和长度 offset = 0; lengthToRead = 512; } }

三、注意事项

• 在使用 read() 方法时，务必检查返回值是否为 -1，以确定是否已经到达流的末尾。
• 对于网络流或某些类型的文件流，可能需要多次调用 read() 方法才能读取完整的数据内容，因为单次调用可能无法读取所有数据。
• 使用完 InputStream 后，应调用其 close() 方法来释放与该流关联的系统资源。这通常在一个 try-with-resources 语句块中自动完成，或者在使用完流后显式调用 close() 方法。

四、示例代码

以下是一个简单的示例，演示如何使用 InputStream.read() 方法从一个文件中读取数据并打印到控制台：

import java.io.*; public class ReadFileExample { public static void main(String[] args) { FileInputStream fis = null; try { fis = new FileInputStream("example.txt"); byte[] buffer = new byte[1024]; int bytesRead; while ((bytesRead = fis.read(buffer)) != -1) { System.out.write(buffer, 0, bytesRead); } } catch (IOException e) { e.printStackTrace(); } finally { if (fis != null) { try { fis.close(); } catch (IOException e) { e.printStackTrace(); } } } } }

在这个例子中，我们创建了一个 FileInputStream 对象来读取名为 "example.txt" 的文件。然后，我们使用一个循环和 read(byte[] b) 方法来读取文件的内容，并将其打印到控制台。最后，我们在 finally 块中关闭了输入流以确保系统资源的正确释放。