用 PHP 讀取檔案的正確方法

了解如何使用 PHP 的各種檔案函數。查看諸如 fopen、fclose 和 feof 之類的基本檔案函數；了解諸如 fgets、fgetss 和 fscanf 之類的讀取函數。並且發現用一兩行程式碼處理整個文件的函數。
讓我們算一算有多少種方法

處理諸如 PHP 之類的現代程式語言的樂趣之一就是有大量的選項可用。 PHP 可以輕鬆贏得 Perl 的座右銘「There's more than one way to do it」（並非只有一種方法可做這件事），尤其是在文件處理上。但是在這麼多可用的選項中，哪一種是完成作業的最佳工具？當然，實際答案取決於解析文件的目標，因此值得花時間探究所有選項。

傳統的 fopen 方法

fopen 方法可能是以前的 C 和 C++ 程式設計師最熟悉的，因為如果您使用過這些語言，那麼它們或多或少都是您已掌握多年的工具。對於這些方法中的任何一種，透過使用 fopen（用於讀取資料的函數）的標準方法開啟文件，然後使用 fclose 關閉文件，如清單 1 所示。

清單1. 用fgets 開啟並讀取檔案

$file_handle = fopen("myfile", "r");
while (!feof($file_handle)) {
$line = fgets($file_handle);
echo $line;
}
fclose($file_handle);

雖然大多數具有多年編程經驗的程式設計師都熟悉這些函數，但是讓我對這些函數進行分解。有效地執行以下步驟：

開啟檔案。 $file_handle 儲存了一個對文件本身的引用。 
檢查您是否已到達文件的末端。 
繼續讀取文件，直到到達文件末尾，邊讀邊列印每行。 
關閉文件。 
記住這些步驟，我將回顧這裡使用的每個檔案函數。

fopen

fopen 函數將建立與檔案的連接。我之所以說“創建連接”，是因為除了打開文件之外，fopen 還可以打開一個URL：

$fh = fopen("http://127.0.0.1/", "r");

這行程式碼將創建一個與以上頁面的連接，並允許您開始像讀取一個本地檔案一樣讀取它。

註： fopen 中使用的 "r" 將指示檔案以唯讀方式開啟。由於將資料寫入文件不在本文的討論範圍內，因此我將不列出所有其他選項。但是，如果是從二進位檔案讀取以獲得跨平台相容性，則應將 "r" 變更為 "rb"。稍後您將看到這樣的範例。

feof

feof 命令將檢測您是否已經讀到文件的末尾並返回 True 或 False。清單 1 中的循環將繼續執行，直到您達到檔案「myfile」的末端。注意：如果讀取的是 URL 且套接字由於不再有任何資料可以讀取而逾時，則 feof 也會傳回 False。

fclose

向前跳至清單 1 的末尾，fclose 將實現與 fopen 相反的功能：它將關閉指向檔案或 URL 的連線。執行此函數後，您將不再能夠從檔案或套接字中讀取任何資訊。

fgets

在清單 1 中回跳幾行，您就到達了文件處理的核心：實際讀取文件。 fgets 函數是處理第一個範例的首選武器。它將從文件中提取一行資料並將其作為字串返回。在那之後，您可以列印或以別的方式處理資料。清單 1 中的範例將精細地列印整個文件。

如果決定限制處理資料區塊的大小，您可以將一個參數加到 fgets 中限制最大行長度。例如，使用以下程式碼將行長度限制為 80 個字元：

$string = fgets($file_handle, 81);

回想 C 中的“

注意：此函數的範例已經使用了略微不同於 fopen 的參數。當處理二進位資料時，始終要記得將 b 選項包含在 fopen 中。如果跳過這一點，Microsoft® Windows® 系統可能無法正確處理文件，因為它們將以不同的方式處理新行。如果處理的是 Linux® 系統（或其他某個 UNIX® 變種），這可能看似沒關係。但即使不是針對 Windows 開發的，這樣做也將獲得良好的跨平台可維護性，並且也是應遵循的一個好習慣。


以上程式碼將讀取 4,096 位元組 (4 KB) 的資料。注意：不管指定多少位元組，fread 都不會讀取超過 8,192 個位元組 (8 KB)。

假定檔案大小不超過 8 KB，則下列程式碼應當能將整個檔案讀入一個字串。

$fh = fopen("myfile", "rb");
$data = fread($fh, filesize("myfile"));
fclose($fh);

如果檔案長度大於此值，則只能使用循環將其餘內容讀入。

fscanf

回到字串處理，fscanf 同樣遵循傳統的 C 檔案庫函數。如果您不熟悉它，則 fscanf 將把欄位資料從檔案讀入變數中。

list ($field1, $field2, $field3) = fscanf($fh, "%s %s %s");

此函數所使用的格式字串在許多地方都有描述（如PHP. net 中），故在此不再贅述。可以這樣說，字串格式化極為靈活。值得注意的是所有欄位都放在函數的傳回值中。 （在 C 中，它們都被作為參數傳遞。）

fgetss

fgetss 函數不同於傳統文件函數並使您能更好地了解 PHP 的力量。該函數的功能類似於 fgets 函數，但將去除發現的任何 HTML 或 PHP 標記，只留下純文字。查看如下所示的 HTML 文件。

清單2. 範例HTML 檔案

If you understand what "CaCa there ain'tuse there ain'tuse no one for to give you no pain"
means then you listen to too much of the band America

然後透過fgetss 函數過濾它。

清單3. 使用fgetss

$file_handle = fopen("myfile", "r");
while (!feof($file_handle)) {
echo = fgetss($file_handle); file_handle);

以下是輸出：

My title

If you understand what "Cause there ain't no one for to give you no pain"

means ton bandwhatlist

fpassthru 函數

無論怎樣讀取文件，您都可以使用fpassthru 將其餘資料轉儲到標準輸出通道。

fpassthru($fh);

此外，此函數將列印數據，因此無需使用變數來取得數據。

非線性檔案處理：跳躍存取

當然，以上函數只允許順序讀取檔案。更複雜的文件可能會要求您來回跳到文件的不同部分。這時就用得著 fseek 了。

fseek($fh, 0);

以上範例將跳轉回檔案的開頭。如果不需要完全回傳 —— 我們可設定回傳千字節 —— 然後就可以這樣寫：

fseek($fh, 1024);

從 PHP V4.0 開始，您有一些其他選項。例如，如果需要從目前位置向前跳轉100 個字節，則可以嘗試使用：

fseek($fh, 100, SEEK_CUR);

類似地，可以使用以下程式碼向後跳轉100 個位元組：

fseek($fh, -100, SEEK_CUR);

如果需要向後​​跳轉至文件末尾前100 個位元組處，則應使用SEEK_END。

fseek($fh, -100, SEEK_END);

在到達新位置後，可以使用 fgets、fscanf 或任何其他方法讀取資料。

註：不能將 fseek 用於引用 URL 的文件處理。

提取整個檔案

現在，我們將接觸到一些 PHP 的更獨特的檔案處理功能：用一兩行處理大塊資料。例如，如何提取文件並在 Web 頁面上顯示其全部內容？好的，您看到了 fgets 使用循環的範例。但是如何能夠讓這個過程變得更簡單？用 fgetcontents 會使過程超級簡單，該方法將把整個檔案放入一個字串中。

$my_file = file_get_contents("myfilename");

echo $my_file;

雖然它不是最好的做法，但是可以將此命令更簡潔地寫為：

雖然它不是最好的做法，但是可以將此命令更簡明地寫為：

echoname");

本文主要介紹的是如何處理本地文件，但是值得注意的是您還可以用這些函數提取、回顯和解析其他Web 頁面。

echo file_get_contents("http://127.0.0.1/");

此指令等效於：

$fh = fopen("http://127.0.0.1/", "r");

fpassthru($fh);

您一定會查看此命令並認為：「那還是太費力」。 PHP 開發人員同意您的看法。因此可以將上述指令縮短為：

readfile("http://127.0.0.1/");

readfile 函數將把檔案或 Web 頁面的全部內容轉儲到預設的輸出緩衝區。預設情況下，如果失敗，此命令將列印錯誤訊息。要避免此行為（如果需要），請嘗試：

@readfile("http://127.0.0.1/");

當然，如果確實需要解析文件，則file_get_contents 返回的單一字串可能有些讓人吃不消。您的第一個反應可能是用 split() 函數將它分解。

$array = split("n", file_get_contents("myfile"));

但是既然已經有一個很好的函數為您執行此操作為什麼還要這樣大費周章？ PHP 的 file() 函數一步即可完成此操作：它將傳回分為若干行的字串陣列。

$array = file("myfile");

應當注意的是，以上兩個範例有一點細微差別。雖然 split 命令將刪除新行，但是當使用 file 命令（與 fgets 命令一樣）時，新行仍將被附加到數組中的字串上。

但是，PHP 的力量還遠遠不止於此。您可以在一條命令中使用 parse_ini_file 解析整個 PHP 樣式的 .ini 檔案。 parse_ini_file 指令接受類似清單 4 所示的檔案。

清單4. 樣例.ini 文件

; Comment
[personal information]
name = "King Arthur"
quest = To seek the holy grail
favorite color = Blue

[more stuff]
Samuel Clemens = Mark Twain
Caryn Johnson = Whoopi Goldberg

以下命令將把此檔案轉儲為數組，然後列印該數組：

$file_array = parse_ini_file("holy_grail.ini"
$file_array = parse_ini_file("holy_grail.ini");
以下輸出的是結果：

Listing 5. 輸出

Array
(
[name] => King Arthur
[quest] => To seek the Holy Grail
[favorite color. ] => Mark Twain
[Caryn Johnson] => Whoopi Goldberg
)



當然，您可能注意到此命令合併了各個部分。這是預設行為，但是您可以透過將第二個參數傳遞給 parse_ini_file 輕鬆修正它：process_sections，這是一個布林型變數。將 process_sections 設為 True。

$file_array = parse_ini_file("holy_grail.ini", true);

print_r $file_array;

並且您將獲得以下輸出：

並且您將獲得以下輸出：

. > Array
(
[name] => King Arthur
[quest] => To seek the Holy Grail
[favorite color] => Blue
)

[more stuff] => Array
(
[Samuel Clemens] = > Mark Twain
[Caryn Johnson] => Whoopi Goldberg

)

)

PHP 將把資料放入可以輕鬆解析的多維數組中。

對於 PHP 檔案處理來說，這只是冰山一角。諸如 tidy_parse_file 和 xml_parse 之類的更複雜的函數可以分別幫助您處理 HTML 和 XML 文件。有關這些特殊函數的使用細節，請參閱 參考資料。如果您要處理那些類型的文件，則那些參考資料值得一看，但不必過度考慮本文中談到的每種可能遇到的文件類型，以下是一些用於處理到目前為止介紹的函數的很好的通用規則。

最佳實務

絕不假定程式中的一切都將按計畫運作。例如，如果您要尋找的檔案已被移動該如何？如果權限已被改變而無法讀取其內容又如何？您可以透過使用 file_exists 和 is_readable 預先檢查這些問題。

清單7. 使用file_exists 和is_readable

$filename = "myfile";

if (file_exists($filename) && is_readable ($filename)) {

$fh = fopenp($fh = fopenr($filename, "popenr($)); # Processing
fclose($fh);
}



但是，在實踐中，用這樣的程式碼可能太繁瑣了。處理 fopen 的回傳值更簡單且更準確。

if ($fh = fopen($filename, "r")) {
# Processing

fclose($fh);

}

由於失敗時fopen 將返回False，這將確保僅當檔案成功開啟後才執行檔處理。當然，如果文件不存在或不可讀，您可以期望一個負返回值。這將使這個檢查可以檢查所有可能遇到的問題。此外，如果開啟失敗，可以退出程式或讓程式顯示錯誤訊息。

如 fopen 函數一樣，file_get_contents、file 和 readfile 函數都在開啟失敗或處理檔案失敗時傳回 False。 fgets、fgetss、fread、fscanf 和 fclose 函數在出錯時也會傳回 False。當然，除 fclose 以外，您可能已經對這些函數的傳回值都進行了處理。使用 fclose 時，即使檔案處理未正常關閉，也不會執行任何操作，因此通常不必檢查 fclose 的回傳值。

由您來選擇

PHP 不缺讀取和解析檔案的有效方法。諸如 fread 之類的典型函數可能在大多數時候都是最佳的選擇，或者當 readfile 剛好能滿足任務需求時，您可能會發現自己更為 readfile 的簡單所吸引。它實際上取決於所要完成的操作。

如果要處理大量數據，fscanf 將能證明自己的值並比使用 file 附帶 split 和 sprintf 指令更有效率。相反，如果要回顯只做了少許修改的大量文本，則使用 file、file_get_contents 或 readfile 可能更合適。使用 PHP 進行快取或建立權宜的代理伺服器時可能就屬於這種情況。

PHP 給您提供了大量處理文件的工具。深入了解這些工具並了解哪些工具最適合要處理的項目。您已經擁有許多的選擇，因此好好利用它們來享受使用 PHP 處理文件的樂趣。