用 stream_get_meta_data 检查文件流当前读取到哪了，怎么做？

gitbox 2025-09-21

在 PHP 中，stream_get_meta_data() 函数通常用于获取文件流的元数据，它能够提供关于文件流的详细信息，其中包括流的状态、偏移量以及文件指针的位置。使用该函数，开发者可以非常方便地检查当前文件流读取到了哪里，尤其在进行文件处理时，了解文件指针位置有助于我们更加高效地控制文件的读取和写入。

1. stream_get_meta_data() 函数简介

stream_get_meta_data() 函数可以返回文件流的一些元数据。这些信息包含了文件流的状态、打开模式、当前读取位置等。它的语法如下：

<span><span><span class="hljs-title function_ invoke__">stream_get_meta_data</span></span><span>(resource </span><span><span class="hljs-variable">$stream</span></span><span>): </span><span><span class="hljs-keyword">array</span></span><span>
</span></span>

参数：

$stream：必须是有效的文件流资源。

返回值：

返回一个数组，包含文件流的相关元数据，如：
- timed_out：如果流操作超时，返回 true。
- blocked：如果流被阻塞，返回 true。
- eof：如果流已到达文件末尾，返回 true。
- unread_bytes：当前流中未读取的字节数。
- seekable：是否可以跳转（seek）到文件中的特定位置。
- uri：文件的 URI。
- mode：文件流的打开模式（例如 r, w 等）。
- stream_type：流的类型，通常是 stream。
- wrapper_data：包装器的数据（如果有）。
- wrapper_type：流的包装器类型（如果有）。

2. 获取文件流的读取位置

文件流的读取位置可以通过检查返回的元数据中的 unread_bytes 或 seekable 信息来了解。

例子：

<span><span><span class="hljs-meta">&lt;?php</span></span><span>

</span><span><span class="hljs-comment">// 打开文件流</span></span><span>
</span><span><span class="hljs-variable">$file</span></span><span> = </span><span><span class="hljs-title function_ invoke__">fopen</span></span><span>(</span><span><span class="hljs-string">'example.txt'</span></span><span>, </span><span><span class="hljs-string">'r'</span></span><span>);

</span><span><span class="hljs-comment">// 检查文件流的元数据</span></span><span>
</span><span><span class="hljs-variable">$metaData</span></span><span> = </span><span><span class="hljs-title function_ invoke__">stream_get_meta_data</span></span><span>(</span><span><span class="hljs-variable">$file</span></span><span>);

</span><span><span class="hljs-comment">// 获取文件指针位置</span></span><span>
</span><span><span class="hljs-keyword">echo</span></span><span> </span><span><span class="hljs-string">"文件流当前是否可读: "</span></span><span> . (</span><span><span class="hljs-variable">$metaData</span></span><span>[</span><span><span class="hljs-string">'seekable'</span></span><span>] ? </span><span><span class="hljs-string">'是'</span></span><span> : </span><span><span class="hljs-string">'否'</span></span><span>) . PHP_EOL;
</span><span><span class="hljs-keyword">echo</span></span><span> </span><span><span class="hljs-string">"文件流未读取的字节数: "</span></span><span> . </span><span><span class="hljs-variable">$metaData</span></span><span>[</span><span><span class="hljs-string">'unread_bytes'</span></span><span>] . PHP_EOL;

</span><span><span class="hljs-comment">// 关闭文件流</span></span><span>
</span><span><span class="hljs-title function_ invoke__">fclose</span></span><span>(</span><span><span class="hljs-variable">$file</span></span><span>);

</span><span><span class="hljs-meta">?&gt;</span></span><span>
</span></span>

3. 使用 ftell() 获取当前文件指针位置

除了通过 stream_get_meta_data() 获取一些流的状态信息之外，我们还可以通过 PHP 的内置函数 ftell() 来获取当前文件指针的位置。ftell() 函数返回的是当前读取位置的偏移量，单位是字节。

例子：

<span><span><span class="hljs-meta">&lt;?php</span></span><span>

</span><span><span class="hljs-comment">// 打开文件</span></span><span>
</span><span><span class="hljs-variable">$file</span></span><span> = </span><span><span class="hljs-title function_ invoke__">fopen</span></span><span>(</span><span><span class="hljs-string">'example.txt'</span></span><span>, </span><span><span class="hljs-string">'r'</span></span><span>);

</span><span><span class="hljs-comment">// 读取一些内容</span></span><span>
</span><span><span class="hljs-title function_ invoke__">fgets</span></span><span>(</span><span><span class="hljs-variable">$file</span></span><span>);

</span><span><span class="hljs-comment">// 获取当前文件指针位置</span></span><span>
</span><span><span class="hljs-variable">$position</span></span><span> = </span><span><span class="hljs-title function_ invoke__">ftell</span></span><span>(</span><span><span class="hljs-variable">$file</span></span><span>);
</span><span><span class="hljs-keyword">echo</span></span><span> </span><span><span class="hljs-string">"当前文件指针的位置: "</span></span><span> . </span><span><span class="hljs-variable">$position</span></span><span> . </span><span><span class="hljs-string">" 字节"</span></span><span> . PHP_EOL;

</span><span><span class="hljs-comment">// 关闭文件</span></span><span>
</span><span><span class="hljs-title function_ invoke__">fclose</span></span><span>(</span><span><span class="hljs-variable">$file</span></span><span>);

</span><span><span class="hljs-meta">?&gt;</span></span><span>
</span></span>

4. 文件流的实际应用场景

4.1 实时跟踪文件读取进度

在处理大文件时，可能需要实时跟踪文件读取的进度。例如，在导入一个大文件时，我们可以利用 stream_get_meta_data() 来获取文件指针的位置，动态显示进度条。

<span><span><span class="hljs-meta">&lt;?php</span></span><span>

</span><span><span class="hljs-comment">// 打开大文件</span></span><span>
</span><span><span class="hljs-variable">$file</span></span><span> = </span><span><span class="hljs-title function_ invoke__">fopen</span></span><span>(</span><span><span class="hljs-string">'largefile.txt'</span></span><span>, </span><span><span class="hljs-string">'r'</span></span><span>);

</span><span><span class="hljs-comment">// 获取文件的总字节数</span></span><span>
</span><span><span class="hljs-variable">$fileSize</span></span><span> = </span><span><span class="hljs-title function_ invoke__">filesize</span></span><span>(</span><span><span class="hljs-string">'largefile.txt'</span></span><span>);

</span><span><span class="hljs-comment">// 初始化读取的字节数</span></span><span>
</span><span><span class="hljs-variable">$readBytes</span></span><span> = </span><span><span class="hljs-number">0</span></span><span>;

</span><span><span class="hljs-comment">// 逐行读取文件</span></span><span>
</span><span><span class="hljs-keyword">while</span></span><span> (</span><span><span class="hljs-variable">$line</span></span><span> = </span><span><span class="hljs-title function_ invoke__">fgets</span></span><span>(</span><span><span class="hljs-variable">$file</span></span><span>)) {
    </span><span><span class="hljs-comment">// 更新已读取的字节数</span></span><span>
    </span><span><span class="hljs-variable">$readBytes</span></span><span> += </span><span><span class="hljs-title function_ invoke__">strlen</span></span><span>(</span><span><span class="hljs-variable">$line</span></span><span>);

    </span><span><span class="hljs-comment">// 计算进度</span></span><span>
    </span><span><span class="hljs-variable">$progress</span></span><span> = (</span><span><span class="hljs-variable">$readBytes</span></span><span> / </span><span><span class="hljs-variable">$fileSize</span></span><span>) * </span><span><span class="hljs-number">100</span></span><span>;

    </span><span><span class="hljs-comment">// 显示进度</span></span><span>
    </span><span><span class="hljs-keyword">echo</span></span><span> </span><span><span class="hljs-string">"读取进度: "</span></span><span> . </span><span><span class="hljs-title function_ invoke__">round</span></span><span>(</span><span><span class="hljs-variable">$progress</span></span><span>, </span><span><span class="hljs-number">2</span></span><span>) . </span><span><span class="hljs-string">"%\r"</span></span><span>;
}

</span><span><span class="hljs-comment">// 关闭文件</span></span><span>
</span><span><span class="hljs-title function_ invoke__">fclose</span></span><span>(</span><span><span class="hljs-variable">$file</span></span><span>);

</span><span><span class="hljs-meta">?&gt;</span></span><span>
</span></span>

4.2 错误处理与文件末尾判断

有时，我们需要在读取文件时判断文件是否已读到末尾。使用 stream_get_meta_data() 返回的 eof 信息，可以方便地判断文件是否已被完全读取。

<span><span><span class="hljs-meta">&lt;?php</span></span><span>

</span><span><span class="hljs-comment">// 打开文件流</span></span><span>
</span><span><span class="hljs-variable">$file</span></span><span> = </span><span><span class="hljs-title function_ invoke__">fopen</span></span><span>(</span><span><span class="hljs-string">'example.txt'</span></span><span>, </span><span><span class="hljs-string">'r'</span></span><span>);

</span><span><span class="hljs-comment">// 逐行读取文件直到文件末尾</span></span><span>
</span><span><span class="hljs-keyword">while</span></span><span> (!</span><span><span class="hljs-title function_ invoke__">feof</span></span><span>(</span><span><span class="hljs-variable">$file</span></span><span>)) {
    </span><span><span class="hljs-variable">$line</span></span><span> = </span><span><span class="hljs-title function_ invoke__">fgets</span></span><span>(</span><span><span class="hljs-variable">$file</span></span><span>);
    </span><span><span class="hljs-keyword">echo</span></span><span> </span><span><span class="hljs-variable">$line</span></span><span>;
}

</span><span><span class="hljs-comment">// 获取文件流元数据</span></span><span>
</span><span><span class="hljs-variable">$metaData</span></span><span> = </span><span><span class="hljs-title function_ invoke__">stream_get_meta_data</span></span><span>(</span><span><span class="hljs-variable">$file</span></span><span>);

</span><span><span class="hljs-comment">// 判断是否已到达文件末尾</span></span><span>
</span><span><span class="hljs-keyword">if</span></span><span> (</span><span><span class="hljs-variable">$metaData</span></span><span>[</span><span><span class="hljs-string">'eof'</span></span><span>]) {
    </span><span><span class="hljs-keyword">echo</span></span><span> </span><span><span class="hljs-string">"文件已读到末尾"</span></span><span> . PHP_EOL;
}

</span><span><span class="hljs-comment">// 关闭文件</span></span><span>
</span><span><span class="hljs-title function_ invoke__">fclose</span></span><span>(</span><span><span class="hljs-variable">$file</span></span><span>);

</span><span><span class="hljs-meta">?&gt;</span></span><span>
</span></span>

5. 总结

stream_get_meta_data() 是一个非常有用的工具，尤其是在处理文件流时。通过它，开发者不仅可以检查文件流的状态，还能进一步监控文件指针的位置和文件流是否可读。结合其他文件操作函数（如 ftell() 和 fseek()），可以更加高效地控制文件读取操作，处理大型文件时特别有用。