用 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 中的“/0”字符串末尾終止符,將長度設爲比實際所需值大一的數字。因而,如果需要 80 個字符,則以上示例使用 81。應養成以下習慣:只要對此函數使用行限制,就添加該額外字符。

fread

fgets 函數是多個文件讀取函數中惟一一個可用的。它是一個更常用的函數,因爲逐行解析通常會有意義。事實上,幾個其他函數也可以提供類似功能。但是,您並非總是需要逐行解析。

這時就需要使用 fread。fread 函數與 fgets 的處理目標略有不同:它趨於從二進制文件(即,並非主要包含人類可閱讀的文本的文件)中讀取信息。由於“行”的概念與二進制文件無關(邏輯數據結構通常都不是由新行終止),因此您必須指定需要讀入的字節數。$fh = fopen("myfile", "rb");
$data = fread($file_handle, 4096);

        使用二進制數據

注意:此函數的示例已經使用了略微不同於 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 文件               
<html>
    <head><title>My title</title></head>
    <body>
        <p>If you understand what "Cause there ain't no one for to give you no pain"
            means then you listen to too much of the band America</p>
    </body>
</html>



然後通過 fgetss 函數過濾它。

清單 3. 使用 fgetss               
$file_handle = fopen("myfile", "r");
while (!feof($file_handle)) {
   echo = fgetss($file_handle);
}
fclose($file_handle);



以下是輸出:    My title

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



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;



雖然它不是最好的做法,但是可以將此命令更簡明地寫爲:echo file_get_contents("myfilename");



本文主要介紹的是如何處理本地文件,但是值得注意的是您還可以用這些函數提取、回顯和解析其他 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");
print_r $file_array;



以下輸出的是結果:

Listing 5. 輸出               
Array
(
    [name] => King Arthur
    [quest] => To seek the Holy Grail
    [favorite color] => Blue
    [Samuel Clemens] => 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;



並且您將獲得以下輸出:

清單 6. 輸出               
Array
(
    [personal information] => 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 = fopen($filename, "r");
    # 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 處理文件的樂趣。

 

轉載自:http://www.ibm.com/developerworks/cn/opensource/os-php-readfiles/index.html

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章