用 PHP 读取文件的正确方法

了解使用 fopen、fclose、feof、fgets、fgetss 和 fscanf 的正确时机

了解如何使用 PHP 的各种文件函数。查看诸如 fopenfclosefeof 之类的基本文件函数;了解诸如 fgetsfgetssfscanf 之类的读取函数。并且发现用一两行代码处理整个文件的函数。

Roger McCoy (rogermccoy@gmail.com), IT Specialist, 自由撰稿人

Roger McCoy 是使用过包括 C、Java、JavaScript、Perl、PHP 和 Microsoft Visual Basic 在内的多种编程语言的开发人员。他有五年的 PHP 应用程序开发经验,但是他作为呼叫中心行业内的技师可能更著名。



2007 年 3 月 06 日

让我们算一算有多少种方法

处理诸如 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);

虽然大多数具有多年编程经验的程序员都熟悉这些函数,但是让我对这些函数进行分解。有效地执行以下步骤:

  1. 打开文件。$file_handle 存储了一个对文件本身的引用。
  2. 检查您是否已到达文件的末尾。
  3. 继续读取文件,直至到达文件末尾,边读取边打印每行。
  4. 关闭文件。

记住这些步骤,我将回顾在这里使用的每个文件函数。

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 函数是多个文件读取函数中惟一一个可用的。它是一个更常用的函数,因为逐行解析通常会有意义。事实上,几个其他函数也可以提供类似功能。但是,您并非总是需要逐行解析。

这时就需要使用 freadfread 函数与 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);

在到达新位置后,可以使用 fgetsfscanf 或任何其他方法读取数据。

注:不能将 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_filexml_parse 之类的更复杂的函数可以分别帮助您处理 HTML 和 XML 文档。有关这些特殊函数的使用细节,请参阅 参考资料。如果您要处理那些类型的文件,则那些参考资料值得一看,但不必过度考虑本文中谈到的每种可能遇到的文件类型,下面是一些用于处理到目前为止介绍的函数的很好的通用规则。


最佳实践

绝不要假定程序中的一切都将按计划运行。例如,如果您要查找的文件已被移动该当如何?如果权限已被改变而无法读取其内容又当如何?您可以通过使用 file_existsis_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_contentsfilereadfile 函数都在打开失败或处理文件失败时返回 False。fgetsfgetssfreadfscanffclose 函数在出错时也返回 False。当然,除 fclose 以外,您可能已经对这些函数的返回值都进行了处理。使用 fclose 时,即使文件处理未正常关闭,也不会执行什么操作,因此通常不必检查 fclose 的返回值。


由您来选择

PHP 不缺读取和解析文件的有效方法。诸如 fread 之类的典型函数可能在大多数时候都是最佳的选择,或者当 readfile 刚好能满足任务需要时,您可能会发现自己更为 readfile 的简单所吸引。它实际上取决于所要完成的操作。

如果要处理大量数据,fscanf 将能证明自己的价值并比使用 file 附带 splitsprintf 命令更有效率。相反,如果要回显只做了少许修改的大量文本,则使用 filefile_get_contentsreadfile 可能更合适。使用 PHP 进行缓存或者创建权宜的代理服务器时可能就属于这种情况。

PHP 给您提供了大量处理文件的工具。深入了解这些工具并了解哪些工具最适合于要处理的项目。您已拥有很多的选择,因此好好地利用它们享受使用 PHP 处理文件的乐趣。

参考资料

学习

  • 您可以参阅本文在 developerWorks 全球站点上的 英文原文
  • PHP.net 是所有 PHP 的完全命令参考。
  • 查阅“PHP 推荐读物列表”。
  • 查阅 IBM developerWorks 的 PHP 项目资源中心 扩展 PHP 技巧。
  • 阅读“PHP by example, Part 1”发现 PHP 用于构建复杂且功能强大的 Web 相关程序的简单方法。
  • 了解本文未涉及到的 xml_parse 函数的信息。
  • 了解本文未涉及到的 tidy_parse_file 函数的信息。
  • PHP.net 是 PHP 开发人员的资源。
  • 浏览 developerWorks 上的所有 PHP 内容
  • 收听针对软件开发人员的有趣访谈和讨论,一定要访问 developerWorks 的 podcast
  • 随时关注 developerWorks 的 技术事件和网络广播
  • 查阅最近将在全球举办的面向 IBM 开放源码开发人员的研讨会、交易展览、网络广播和其他 活动
  • 访问 developerWorks 开放源码专区,获得丰富的 how-to 信息、工具和项目更新,帮助您用开放源码技术进行开发,并与 IBM 产品结合使用。
  • 访问 Safari 在线书店 浏览开放源码技术的各种参考资料。

获得产品和技术

  • 使用 IBM 试用软件 构建您的下一个开发项目,这些软件可以通过下载或从 DVD 中获得。

讨论

条评论

developerWorks: 登录

标有星(*)号的字段是必填字段。


需要一个 IBM ID?
忘记 IBM ID?


忘记密码?
更改您的密码

单击提交则表示您同意developerWorks 的条款和条件。 查看条款和条件

 


在您首次登录 developerWorks 时,会为您创建一份个人概要。您的个人概要中的信息(您的姓名、国家/地区,以及公司名称)是公开显示的,而且会随着您发布的任何内容一起显示,除非您选择隐藏您的公司名称。您可以随时更新您的 IBM 帐户。

所有提交的信息确保安全。

选择您的昵称



当您初次登录到 developerWorks 时,将会为您创建一份概要信息,您需要指定一个昵称。您的昵称将和您在 developerWorks 发布的内容显示在一起。

昵称长度在 3 至 31 个字符之间。 您的昵称在 developerWorks 社区中必须是唯一的,并且出于隐私保护的原因,不能是您的电子邮件地址。

标有星(*)号的字段是必填字段。

(昵称长度在 3 至 31 个字符之间)

单击提交则表示您同意developerWorks 的条款和条件。 查看条款和条件.

 


所有提交的信息确保安全。


static.content.url=http://www.ibm.com/developerworks/js/artrating/
SITE_ID=10
Zone=Open source, Web development
ArticleID=199663
ArticleTitle=用 PHP 读取文件的正确方法
publish-date=03062007