在PHP中,读取文件内容是一个常见的操作,它可以通过多种函数和方法来实现。每种方法都有其特定的用途和性能考量。
1、file()
file() 函数将整个文件读入一个数组中,每行作为一个元素。这使得处理按行分隔的文件(如CSV文件或日志文件)变得非常简单。
用法示例:
<?php $filename = 'example.txt'; $lines = file($filename); foreach ($lines as $line) { echo $line . "<br>"; } ?>
array file ( string $filename [, int $use_include_path [, resource $context ]] )
将文件内容读入一个数组中,数组的每一项对应文件中的一行,包括换行符在内。不需要行结束符时可以使用 rtrim() 函数过滤换行符。
<?php $a = file('./file.txt'); foreach($a as $line => $content){ echo 'line '.($line + 1).':'.$content; } ?>
2、readfile()
读入一个文件并写入到输出缓冲。readfile函数会将文件直接输出到输出缓冲区,而不需要将文件内容读入到内存中。这使得readfile函数更适合用于处理大文件,因为它不会占用大量内存。而file_get_contents函数会将文件内容读入到内存中,因此对于比较大的文件可能会导致内存占用过高。
readfile函数通常用于直接输出文件内容到浏览器或其他输出流,而file_get_contents函数将文件内容作为字符串返回,可以进一步对文件内容进行处理或操作。
readfile函数返回的是读取文件的字节数,而file_get_contents函数返回的是文件内容的字符串。
readfile函数适合用于处理大文件、直接输出文件内容,而file_get_contents函数适合用于对文件内容进行处理和操作。
<?php $size = readfile('./file.txt'); echo $size; ?>
<?php readfile('file.txt'); ?>
3、file_get_contents()
file_get_contents() 函数是最简单、最直接的方式来读取整个文件的内容到一个字符串中。这个函数对于读取较小的文件非常有效,但对于大文件可能会导致内存使用过多。将整个文件读入一个字符串。
用法示例:
<?php $filename = 'example.txt'; $content = file_get_contents($filename); echo $content; ?>
string file_get_contents ( string $filename [, bool $use_include_path [, resource $context [, int $offset [, int $maxlen ]]]] )
将文件读入一个字符串。第三个参数$context可以用来设置一些参数,比如访问远程文件时,设置超时等等。
另外,file_get_contents相对于以上几个函数,性能要好得多,所以应该优先考虑使用file_get_contents。但是readfile貌似比file_get_contents性能好一点,因为它不需要调用fopen。
<?php $ctx = stream_context_create(array( 'http' => array( 'timeout' => 1 //设置超时 ) ) ); echo file_get_contents("http://www.baidu.com/", 0, $ctx); ?>
明日科技的一页代码很好的说明了以上三个函数的区别。
<!DOCTYPE html> <html lang="zh-cn"> <head> <meta charset="utf-8"> <title>PHP零基础</title> <link href="css/bootstrap.css" rel="stylesheet"> </head> <body class="col-sm-6"> <h3 class="col-sm-offset-3">使用三种方法读取文件</h3> <table class="table table-bordered"> <thead> <tr class="success"> <th>方法名</th> <th>内容</th> </tr> </thead> <tbody> <tr class="info"> <td>readfile()函数</td> //<!-- 使用readfile()函数读取tm.txt文件的内容 --> <td><?php readfile('tm.txt'); ?></td> </tr> <tr class="success"> <td>file()函数</td> //<!-- 使用file()函数读取tm.txt文件的内容 --> <td> <?php $f_arr = file('tm.txt'); foreach($f_arr as $cont){ echo $cont."<br>"; } ?> </td> </tr> <tr class="info"> <td>file_get_contents()函数</td> //<!-- 使用file_get_contents()函数读取tm.txt文件的内容 --> <td> <?php $f_chr = file_get_contents('tm.txt'); echo $f_chr; ?> </td> </tr> </tbody> </table> </body> </html>
tm.text里面的文本内容为2行:
但是html代码运行后显示有所不同,截图如下:
4、fopen() 和 fread()
fopen() 函数用于打开文件或 URL,而 fread() 函数则用于从文件指针中读取指定长度的数据。这种方法更灵活,允许你控制读取的字节数,适合读取大文件或需要逐块处理文件内容的场景。
用法示例:
<?php $filename = 'example.txt'; $handle = fopen($filename, "r"); $content = ''; if ($handle) { while (!feof($handle)) { $content .= fread($handle, 8192); // 读取8192字节 } fclose($handle); } echo $content; ?>
5、fgets() 和 fgetss()
fgets() 函数从文件指针中读取一行并返回。它对于逐行读取文件内容非常有用。fgetss() 是 fgets() 的一个变体,它会从读取的字符串中去除任何 HTML 或 PHP 标签。
fgets() 用法示例:
<?php $filename = 'example.txt'; $handle = fopen($filename, "r"); if ($handle) { while (($line = fgets($handle)) !== false) { echo $line; } fclose($handle); } ?>
fgets
string fgets ( int $handle [, int $length ] )
fgets()从 handle 指向的文件中读取一行并返回长度最多为 length - 1 字节的字符串。碰到换行符(包括在返回值中)、EOF 或者已经读取了 length - 1 字节后停止(看先碰到那一种情况)。如果没有指定 length,则默认为 1K,或者说 1024 字节。
<?php $handle = fopen('./file.txt', 'r'); while(!feof($handle)){ echo fgets($handle, 1024); } fclose($handle); ?>
Note: length 参数从 PHP 4.2.0 起成为可选项,如果忽略,则行的长度被假定为 1024。从 PHP 4.3 开始,忽略掉 length 将继续从流中读取数据直到行结束。如果文件中的大多数行都大于 8KB,则在脚本中指定最大行的长度在利用资源上更为有效。从 PHP 4.3 开始本函数可以安全用于二进制文件。早期的版本则不行。
fgetss(fgetss函数是PHP中的一个函数,用于从文件中读取一行文本,并过滤掉其中的HTML和PHP标记。该函数在PHP 7.3.0版本中被弃用,并在PHP 8.0.0版本中被完全移除。因此,建议不要依赖该函数,而是使用其他方法来过滤HTML和PHP标记。)
string fgetss ( resource $handle [, int $length [, string $allowable_tags ]] )
跟fgets功能一样,但是fgetss会尝试从读取的文本中去掉任何 HTML 和 PHP 标记,可以用可选的第三个参数指定哪些标记不被去掉。
<?php $handle = fopen('./file.txt', 'r'); while(!feof($handle)){ echo fgetss($handle, 1024, '<br>'); } fclose($handle); ?>
6、splFileObject 类
splFileObject 是 PHP 标准库(SPL)提供的一个面向对象的文件操作类。它提供了许多方法来读取、写入和遍历文件,使得文件操作更加灵活和面向对象。
用法示例:
<?php $file = new SplFileObject('example.txt'); foreach ($file as $line) { echo $line; } ?>
splFileObject 还支持直接访问文件的特定行(通过 seek() 方法),以及读取文件的整个内容到一个字符串(通过 fread() 方法的变体或 fgets() 的循环)。
7、 使用流(Streams)
PHP 支持流包装器(Stream Wrappers),它允许你像操作文件一样操作其他资源,如远程文件、数据压缩文件等。使用流,你可以通过统一的接口读取和写入不同来源的数据。
用法示例(读取远程文件):
<?php $url = 'http://example.com/file.txt'; $content = file_get_contents($url); echo $content; ?>
这里,file_get_contents() 实际上是在使用流包装器来读取远程文件的内容。
8、fread
string fread ( int $handle , int $length )
fread() 从 handle 指向的文件中读取最多 length 个字节。该函数在读取完最多 length 个字节数,或到达 EOF 的时候,或(对于网络流)当一个包可用时,或(在打开用户空间流之后)已读取了 8192 个字节时就会停止读取文件,视乎先碰到哪种情况。
fread() 返回所读取的字符串,如果出错返回 FALSE。
<?php $filename = "/usr/local/something.txt"; $handle = fopen($filename, "r");//读取二进制文件时,需要将第二个参数设置成'rb' //通过filesize获得文件大小,将整个文件一下子读到一个字符串中 $contents = fread($handle, filesize ($filename)); fclose($handle); ?>
如果所要读取的文件不是本地普通文件,而是远程文件或者流文件,就不能用这种方法,因为,filesize不能获得这些文件的大小。此时,你需要通过feof()或者fread()的返回值判断是否已经读取到了文件的末尾。
例如:
<?php $handle = fopen('http://www.baidu.com', 'r'); $content = ''; while(!feof($handle)){ $content .= fread($handle, 8080); } echo $content; fclose($handle); ?>
或者:
<?php $handle = fopen('http://www.baidu.com', 'r'); $content = ''; while(false != ($a = fread($handle, 8080))){//返回false表示已经读取到文件末尾 $content .= $a; } echo $content; fclose($handle); ?
9、fpassthru
int fpassthru ( resource $handle )
将给定的文件指针从当前的位置读取到 EOF 并把结果写到输出缓冲区。
<?php header("Content-Type:text/html;charset=utf-8"); $handle = fopen('./test2.php', 'r'); fseek($handle, 1024);//将指针定位到1024字节处 fpassthru($handle); ?>
注意事项和性能考量
1、内存使用:file_get_contents() 和 file() 会将整个文件内容加载到内存中,对于大文件可能会导致内存耗尽。
2、逐行处理:如果你只需要逐行处理文件,使用 fgets() 或 splFileObject 可能更高效。
3、文件大小:在处理大文件时,考虑使用分块读取(如 fread())来避免内存问题。
4、错误处理:在读取文件时,始终检查文件是否成功打开,并妥善处理可能出现的错误。
5、鼓励在处理二进制文件时使用 b 标志,即使系统并不需要,这样可以使脚本的移植性更好。
6、allow_url_fopen选项激活了 URL 形式的 fopen 封装协议使得可以访问 URL 对象例如文件。默认的封装协议提供用 ftp 和 http 协议来访问远程文件,一些扩展库例如 zlib 可能会注册更多的封装协议。出于安全性考虑,此选项只能在 php.ini 中设置。
7、如果要打开有特殊字符的 URL (比如说有空格),就需要使用 urlencode() 进行 URL 编码。
每种方法都有其适用的场景和优缺点,选择哪种方法取决于你的具体需求,如文件的大小、你需要如何处理文件内容等。