目录

php输出缓冲

输出缓冲相当于一个输出内容队列，用于对接存储速度、优先级不同步的设备，让这些设备的输入输出不阻塞，更加流畅。

默认情况下，php buffer是开启的，而且该buffer默认值是4096byte。可以通过php.ini配置文件中找到output_buffering配置。

当echo、print等输出用户数据的时候，输出数据都会写入到php output_buffering中，直到output_buffering写满，会将这些数据通过tcp传送给浏览器显示。

也可以通过 ob_start()手动激活php output_buffering机制，使得即便输出超过了4096byte数据，也不真的把数据交给tcp传给浏览器，因为ob_start()将php buffer空间设置到了足够大 。只有直到脚本结束，或者调用ob_end_flush函数，才会把数据发送给客户端浏览器。

注意：在CLI模式下是关闭的，因为可能造成性能问题。

常用ob函数

  • ob_start

    此函数将打开输出缓冲。当输出缓冲激活后，脚本将不会输出内容（除http标头外），相反需要输出的内容被存储在内部缓冲区中。

    ob_start接受一个callalbe的output_callback函数名。

    function callback($buffer){    
    return (str_replace("apples", "bananas", $buffer));
}

ob_start('callback');

echo "It's like comparing apples to oranges.\n<br />";

$contents = ob_get_contents();

print_r("最终输出内容：".$contents);

ob_end_flush();

  • ob_end_flush

    冲刷出（送出）输出缓冲区内容并关闭缓冲。

    区别于ob_flush，多了关闭缓冲区。

  • ob_end_clean

    清空（擦除）缓冲区并关闭输出缓冲。

    区别于ob_clean，多了关闭缓冲区。

  • ob_get_contents

    返回输出缓冲区的内容。

  • flush与ob_flush

    在没有开启output_buffering时，脚本输出的内容都在服务器端处于等待输出的状态 ，等待脚本结束或调用flush()将等待输出的内容立即发送到客户端。

    开启缓存后，脚本输出的内容存入了输出缓冲中，这时没有处于等待输出状态的内容，直接使用flush()不会向客户端发出任何内容。

    而ob_flush()的作用就是将本来存在输出缓冲中的内容取出来（也就是官方文档写的：冲刷出（送出）输出缓冲区中的内容），设置为等待输出状态，但不会直接发送到客户端 ，这时你就需要先使用 ob_flush()再使用flush()，客户端才能立即获得脚本的输出。

    所以在默认开启output_buffering下，先ob_flush将冲刷出输出缓冲区中的内容，输出内容进入等待输出状态，再flush将输出内容刷新给tcp推送给客户端。

  • ob_implicit_flush()

    将打开或关闭绝对（隐式）刷送。绝对（隐式）刷送将导致在每次输出调用后有一次刷送操作，以便不再需要对 flush() 的显式调用。

    通俗点说就是不用再显示的调用flush来输出。

  • 更多ob函数

    只要我们理解了输出缓冲机制，充分理解ob_start、ob_flush、ob_end_flush、flush、ob_get_contents函数，其他比如ob_get_clean、ob_get_flush从字面也大概知道是什么含义了。

使用场景与小结

ob函数用于web场景，比如：

  • 脚本未结束前（可能脚本执行时间较长），先输出部分内容
  • 脚本输出前通过ob_start回调调整或检查等处理输出内容
  • 脚本输出前，记录最后输出内容

对于没有深入理解php输出机制的小伙伴，不建议随便使用php的ob函数，一方面怕误用，另一方面由于apache、nginx等web服务对于php输出有或没有或不同程度的缓冲，导致ob函数可能会有不一样的效果，也就是官方在flush函数里介绍的，在个别web服务器里怎么样，有些apache模块怎么样，一些浏览器怎么样，也就是说效果很难一致的统一，所以我们不建议使用输出缓冲控制ob函数，除非不得已。

比如nginx有开启proxy_buffering，php即使刷出缓冲区内容，也会再被缓存在nginx层，另外还由于gzip压缩，未满输出内容区上限，也不会提前输出到客户端。

所以如果在nginx环境下想使用ob_flush\flush在脚本未结束前输出部分内容，就需要调整nginx配置：

proxy_buffering off;
gzip off;
fastcgi_keep_conn on;

当然ob_start(callable)、ob_end_flush()在服务端的效果还是一致，不论web服务器是哪个，还是能做到将输出先写入PHP的output buffer中，再传递给callable回调函数，最后通过ob_flush\flush\ob_end_flush冲出。

参考

PHP: Output Control 函数 - Manual

【解决方法】nginx中php ob_flush和flush不起作用 - longzhankunlun - 博客园