php缓冲 output_buffering和ob_start



buffer

buffer是一个内存地址空间,Linux系统默认大小一般为4096(4kb),即一个内存页。主要用于存储速度不同步的设备或者优先级不同的设备之间传办理数据的区域。通过buffer,可以使进程这间的相互等待变少。这里说一个通俗一点的例子,你打开文本编辑器编辑一个文件的时候,你每输入一个字符,操作系统并不会立即把这个字符直接写入到磁盘,而是先写入到buffer,当写满了一个buffer的时候,才会把buffer中的数据写入磁盘,当然当调用内核函数flush()的时候,强制要求把buffer中的脏数据写回磁盘。

同样的道理,当执行echo,print的时候,输出并没有立即通过tcp传给客户端浏览器显示, 而是将数据写入PHP buffer。php output_buffering机制,意味在tcp buffer之前,建立了一新的队列,数据必须经过该队列。当一个php buffer写满的时候,脚本进程会将php buffer中的输出数据交给系统内核交由tcp传给浏览器显示。所以,数据会依次写到这几个地方echo/pring -> php buffer -> tcp buffer -> browser

php output_buffering

默认情况下,php buffer是开启的,而且该buffer默认值是4096,即4kb。你可以通过在php.ini配置文件中找到output_buffering配置.当echo,print等输出用户数据的时候,输出数据都会写入到php output_buffering中,直到output_buffering写满,会将这些数据通过tcp传送给浏览器显示。你也可以通过ob_start()手动激活php output_buffering机制,使得即便输出超过了4kb数据,也不真的把数据交给tcp传给浏览器,因为ob_start()将php buffer空间设置到了足够大。只有直到脚本结束,或者调用ob_end_flush函数,才会把数据发送给客户端浏览器。

1.当output_buffering=4096,并且输出较少数据(少于一个buffer)





[php]​view plain​​ ​​copy​

 


  1. <?php  
  2. for ($i = 0; $i < 10; $i++) {  
  3.     echo $i . '<br/>';  
  4.     sleep($i + 1);  //  
  5. }  
  6. ?>  


现象:不是每隔几秒就会有间断性输出,而是直到响应结束,才能看一次性看到输出,在等待服务器脚本处理结束之前,浏览器界面一直保持空白。这是因为,数据量太小,php output_buffering没有写满。写数据的顺序,依次是echo->php buffer->tcp buffer->browser

2.当output_buffering=0,并且输出较少数据(少于一个buffer)






[php]​view plain​​ ​​copy​

 


  1. <?php  
  2. //通过ini_set('output_buffering', 0)并不生效  
  3. //应该编辑/etc/php.ini,设置output_buffering=0禁用output buffering机制  
  4. //ini_set('output_buffering', 0);   //彻底禁用output buffering功能  
  5. for ($i = 0; $i < 10; $i++) {  
  6.     echo $i . '<br/>';  
  7.     flush();  //通知操作系统底层,尽快把数据给客户端浏览器  
  8.     sleep($i + 1);  //  
  9. }  
  10. ?>  


现象:与刚才显示并不一致,禁用了php buffering机制之后,在浏览器可以断断续续看到间断性输出,不必等到脚本执行完毕才看到输出。这是因为,数据没有在php output_buffering中停留。写数据的顺序依次是echo->tcp buffer->browser

3.当output_buffering=4096.,输出数据大于一个buffer,不调用ob_start()



#//创建一个4kb大小的文件
$dd if=/dev/zero of=f4096 bs=4096 count=1




[php]​view plain​​ ​​copy​

 


  1. <?php  
  2. for ($i = 0; $i < 10; $i++) {  
  3.     echo file_get_contents('./f4096') . $i . '<br/>';  
  4.     sleep($i +1);  
  5. }  
  6. ?>  


现象:响应还没结束(http连接没有关闭),断断续续可以看到间断性输出,浏览器界面不会一直保持空白。尽管启用了php output_buffering机制,但依然会间断性输出,而不是一次性输出,是因为output_buffering空间不够用。每写满一个php buffering,数据就会发送到客户端浏览器。

4.当output_buffering=4096, 输出数据大于一个tcp buffer, 调用ob_start()





[php]​view plain​​ ​​copy​

 


  1. <?php  
  2. ob_start(); //开启php buffer  
  3. for ($i = 0; $i < 10; $i++) {  
  4.     echo file_get_contents('./f4096') . $i . '<br/>';  
  5.     sleep($i + 1);  
  6. }  
  7. ob_end_flush();  
  8. ?>  


现象:直到服务端脚本处理完成,响应结束,才看到完整输,输出间隔时间很短,以至你感受不到停顿。在输出之前,浏览器一直保持着空白界面,等待服务端数据。这是因为,php一旦调用了ob_start()函数,它会将php buffer扩展到足够大,直到ob_end_flush函数调用或者脚本运行结速才发送php buffer中的数据到客户端浏览器。

tcpdump观察

在这里,我们通过tcpdump监控一下tcp报文,来观察一下使用ob_start()和没有使用它的一个区别。

1.没有使用ob_start()




[plain]​view plain​​ ​​copy​

 


  1. 12:30:21.499528 IP 192.168.0.8.webcache > 192.168.0.28.cymtec-port: . ack 485 win 6432  
  2. 12:30:21.500127 IP 192.168.0.8.webcache > 192.168.0.28.cymtec-port: . 1:2921(2920) ack 485 win 6432  
  3. 12:30:21.501000 IP 192.168.0.8.webcache > 192.168.0.28.cymtec-port: . 2921:7301(4380) ack 485 win 6432  
  4. 12:30:21.501868 IP 192.168.0.8.webcache > 192.168.0.28.cymtec-port: P 7301:8412(1111) ack 485 win 643  
  5. 12:30:24.502340 IP 192.168.0.8.webcache > 192.168.0.28.cymtec-port: . 8412:14252(5840) ack 485 win 6432  
  6. 12:30:24.503214 IP 192.168.0.8.webcache > 192.168.0.28.cymtec-port: . 14252:15712(1460) ack 485 win 6432  
  7. 12:30:24.503217 IP 192.168.0.8.webcache > 192.168.0.28.cymtec-port: P 15712:16624(912) ack 485 win 6432  
  8.   
  9. 12:30:31.505934 IP 192.168.0.8.webcache > 192.168.0.28.cymtec-port: . 16624:23924(7300) ack 485 win 6432  
  10. 12:30:31.506839 IP 192.168.0.8.webcache > 192.168.0.28.cymtec-port: P 23924:24836(912) ack 485 win 6432  
  11. 12:30:42.508871 IP 192.168.0.8.webcache > 192.168.0.28.cymtec-port: . 24836:32136(7300) ack 485 win 6432  
  12. 12:30:42.509744 IP 192.168.0.8.webcache > 192.168.0.28.cymtec-port: P 32136:33048(912) ack 485 win 6432  
  13. 12:30:57.512137 IP 192.168.0.8.webcache > 192.168.0.28.cymtec-port: . 33048:40348(7300) ack 485 win 6432  
  14. 12:30:57.513016 IP 192.168.0.8.webcache > 192.168.0.28.cymtec-port: P 40348:41260(912) ack 485 win 6432  
  15. 12:31:06.513912 IP 192.168.0.8.webcache > 192.168.0.28.cymtec-port: P 41260:41265(5) ack 485 win 6432  
  16. 12:31:06.514012 IP 192.168.0.8.webcache > 192.168.0.28.cymtec-port: F 41265:41265(0) ack 485 win 6432  
  17. 12:31:06.514361 IP 192.168.0.8.webcache > 192.168.0.28.cymtec-port: . ack 486 win 6432  


2.使用了ob_start()




[plain]​view plain​​ ​​copy​

 


  1. 12:36:06.542244 IP 192.168.0.8.webcache > 192.168.0.28.noagent: . ack 485 win 6432  
  2. 12:36:51.559128 IP 192.168.0.8.webcache > 192.168.0.28.noagent: . 1:2921(2920) ack 485 win 6432  
  3. 12:36:51.559996 IP 192.168.0.8.webcache > 192.168.0.28.noagent: . 2921:7301(4380) ack 485 win 6432  
  4. 12:36:51.560866 IP 192.168.0.8.webcache > 192.168.0.28.noagent: . 7301:11681(4380) ack 485 win 6432  
  5. 12:36:51.561612 IP 192.168.0.8.webcache > 192.168.0.28.noagent: . 11681:16061(4380) ack 485 win 6432  
  6. 12:36:51.561852 IP 192.168.0.8.webcache > 192.168.0.28.noagent: . 16061:20441(4380) ack 485 win 6432  
  7. 12:36:51.562479 IP 192.168.0.8.webcache > 192.168.0.28.noagent: . 20441:24821(4380) ack 485 win 6432  
  8. 12:36:51.562743 IP 192.168.0.8.webcache > 192.168.0.28.noagent: . 24821:29201(4380) ack 485 win 6432  
  9. 12:36:51.562996 IP 192.168.0.8.webcache > 192.168.0.28.noagent: . 29201:33581(4380) ack 485 win 6432  
  10. 12:36:51.563344 IP 192.168.0.8.webcache > 192.168.0.28.noagent: P 33581:35041(1460) ack 485 win 6432  
  11. 12:36:51.563514 IP 192.168.0.8.webcache > 192.168.0.28.noagent: . 35041:36501(1460) ack 485 win 6432  
  12. 12:36:51.563518 IP 192.168.0.8.webcache > 192.168.0.28.noagent: . 36501:37961(1460) ack 485 win 6432  
  13. 12:36:51.563523 IP 192.168.0.8.webcache > 192.168.0.28.noagent: . 37961:39421(1460) ack 485 win 6432  
  14. 12:36:51.563526 IP 192.168.0.8.webcache > 192.168.0.28.noagent: . 39421:40881(1460) ack 485 win 6432  
  15. 12:36:51.563529 IP 192.168.0.8.webcache > 192.168.0.28.noagent: FP 40881:41233(352) ack 485 win 6432  
  16. 12:36:51.570364 IP 192.168.0.8.webcache > 192.168.0.28.noagent: . ack 486 win 6432  


通过上面的对比,我们可以看到,数据报文的时间间隔明显不一样。没有使用ob_start(),时间间隔比较大,等待4秒左右就把tcp buffer中的数据发送出去了。数据没有在php buffer中逗留过长时间,就将输出数据发送给了客户端浏览器。这是因为,很快php buffer就被写满了,不得不把数据发送出去。而启用了ob_start(),则不同,发送数据包给客户端,几乎是同一时间发出去的。这就可以推断,数据一直在php buffer中逗留,直到调用了ob_end_flush()才把php buffer中的数据发送给客户端浏览器。

output buffering函数

1.ob_start

激活output_buffering机制。一旦激活,脚本输出不再直接出给浏览器,而是先暂时写入php buffer内存区域。

php默认开启output_buffering机制,只不过,通过调用ob_start()函数据output_buffering值扩展到足够大。也可以指定$chunk_size来指定output_buffering的值。$chunk_size默认值是0,表示直到脚本运行结束,php buffer中的数据才会发送到浏览器。如果你设置了$chunk_size的大小,则表示只要buffer中数据长度达到了该值,就会将buffer中的数据发送给浏览器。

当然,你可以通过指定$ouput_callback,来处理buffer中的数据。比如函数ob_gzhandler,将buffer中的数据压缩后再传送给浏览器。

2.ob_get_contents

获取一份php buffer中的数据拷贝。值得注意的是,你应该在ob_end_clean()函数调用这调用该函数,否则ob_get_contents()返回一个空字符中。

3.ob_end_flush与ob_end_clean

这二个函数有点相似,都会关闭ouptu_buffering机制。但不同的是,ob_end_flush只是把php buffer中的数据冲(flush/send)到客户端浏览器,而ob_clean_clean将php bufeer中的数据清空(erase),但不发送给客户端浏览器。ob_end_flush调用之后,php buffer中的数据依然存在,ob_get_contents()依然可以获取php buffer中的数据拷贝。而ob_end_clean()调用之后ob_get_contents()取到的是空字符串,同时浏览器也接收不到输出,即没有任何输出。

惯用案例

常常在一些模板引擎和页面文件缓存中看到ob_start()使用。在知名开源项目wordpress,drupal,smarty等地方,都能够发现他们的踪影子。这里抽出drupal的应用。

#模板文件



//@file:user-profile.tpl.php
<div>
<ul>
<li>username: <?php echo $user->name; ?></li>
<li>picture:<?php echo $user->picture; ?></li>
</ul>
</div>

//@file:template-render.php




[php]​view plain​​ ​​copy​

 


  1. <?php  
  2. function theme_render_template($template_file, $variables) {  
  3.   if (!is_file($template_file) { return ""; }  
  4.   extract($variables, EXTR_SKIP);  
  5.   ob_start();  
  6.   $contents = ob_get_contents();  
  7.   ob_end_clean();  
  8.   return $contents;  
  9. }  
  10. ?>  
//@file:profile.php




[php]​view plain​​ ​​copy​

 


  1. <?php  
  2. $variables = array('user' => $user);  
  3. print theme_render_template('user-profile.tpl.php', $variables);  
  4. ?>  
----------------------------


<?php

ob_start();

setcookie("username","aaa",time()+3600);

echo "the username is:".$HTTP_COOKIE_VARS["username"]."\n";

echo "the username is:".$_COOKIE["username"]."\n";

print_r($_COOKIE);

?>

Warning: Cannot modify header information - headers already sent by出错的原因

我在php程序的头部加了,

header("cache-control:no-cache,must-ridate");

之后页面就出现上面的错误,看了N个资料也没有结果。

今天偶尔发现原来是我的php.ini里面的配置出了问题,找到php.ini文件

output_buffering默认为off的。我现在把它设为4096就OK了。

用于解决显示提示错误,不能按(日期+导出文件数)为文件名的错误信息.

setcookie函数必須在任何資料輸出至浏览器前,就先送出

基於上面這些限制,所以執行setcookie()函數時,

常會碰到"Undefined index"、

"Cannot modify header information - headers already sent by"…等問題,

解決"Cannot modify header information - headers already sent by"這個錯誤的方法是在產生cookie前,先延緩資料輸出至瀏覽器,

因此,您可以在程式的最前方加上ob_start();這個函數。

ob_start()函数用于打开缓冲区,比如header()函数之前如果就有输出,包括回车\空格\换行\都会有"Header had all ready send by"的错误,这时可以先用ob_start()打开缓冲区PHP代码的数据块和echo()输出都会进入缓冲区而不会立刻输出.当然打开缓冲区的作用很 多,只要发挥你的想象.可以总结以下四点:

1.用于header()之前

ob_start(); //打开缓冲区

echo \"Hellon\"; //输出

header("location:index.php"); //把浏览器重定向到index.php

ob_end_flush();//输出全部内容到浏览器

?>

2.phpinfo()函数可获取客户端和服务器端的信息,但要保存客户端信息用缓冲区的方法是最好的选择.

ob_start(); //打开缓冲区

phpinfo(); //使用phpinfo函数

$info=ob_get_contents(); //得到缓冲区的内容并且赋值给$info

$file=fopen(\'info.txt\',\'w\'); //打开文件info.txt

fwrite($file,$info); //写入信息到info.txt

fclose($file); //关闭文件info.txt

?>

3.静态页面技术

ob_start();//打开缓冲区

?>

php页面的全部输出

$content = ob_get_contents();//取得php页面输出的全部内容

$fp = fopen("output00001.html", "w"); //创建一个文件,并打开,准备写入

fwrite($fp, $content); //把php页面的内容全部写入output00001.html,然后……

fclose($fp);

?>

4.输出代码

Function run_code($code) {

If($code) {

ob_start();

($code);

$contents = ob_get_contents();

ob_end_clean();

}else {

echo "错误!没有输出";

exit();

}

return $contents;

}