用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() ），可以更加高效地控製文件讀取操作，處理大型文件時特別有用。