PHP的ob_start()函数用法

经典参考片段：

1<?php

2ob_start();

3echo '123';

4echo '456';

5echo '789';

6$content = ob_get_contents();

7ob_end_clean();

8echo $content;

9?>

PHP手册上说：

输出缓冲区是可堆叠的，这即意谓着，当有一个ob_start() 是活跃的时， 你可以调用另一个 ob_start() 。 只要确保又正确调用了 ob_end_flush() 恰当的次数即可。 如果有多重输出回调函数是活跃的，输出内容会一直按嵌套的顺序依次通过它们而被过滤。

测试用例：

01<?php

02include 'public/write.php';

03 

04ob_start();

05ob_implicit_flush(0);

06echo '123';

07$content = ob_get_contents();

08write($content);

09//ob_end_clean();

10 

11ob_start();

12echo '456';

13$content = ob_get_contents();

14write($content);

15ob_end_clean();

16?>

 

 

---

 

 

PHP的ob_start()用法

用PHP的ob_start()控制您的浏览器cache。

Output Control 函数可以让你自由控制脚本中数据的输出。它非常地有用，特别是对于：当你想在数据已经输出后，再输出文件头的情况。输出控制函数不对使用 header() 或 setcookie()，发送的文件头信息产生影响，只对那些类似于 echo() 和 PHP 代码的数据块有作用。

我们先举一个简单的例子，让大家对Output Control有一个大致的印象：

Example 1.

1<?php

2ob_start(); // 打开缓冲区

3echo "Hellon"; // 输出

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

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

6?>

所有对header()函数有了解的人都知道，这个函数会发送一段文件头给浏览器，但是如果在使用这个函数之前已经有了任何输出（包括空输出，比如空格，回车和换行）就会提示出错。如果我们去掉第一行的ob_start()，再执行此程序，我们会发现得到了一条错误提示："Header had all ready send by"！但是加上ob_start，就不会提示出错，原因是当打开了缓冲区，echo后面的字符不会输出到浏览器，而是保留在服务器，直到你使用flush或者ob_end_flush才会输出，所以并不会有任何文件头输出的错误！

 

一、 相关函数简介：

1、flush：刷新缓冲区的内容，输出。

函数格式：flush()

说明：这个函数经常使用，效率很高。

2、ob_start ：打开输出缓冲区

函数格式：void ob_start(void)

说明：当缓冲区激活时，所有来自PHP程序的非文件头信息均不会发送，而是保存在内部缓冲区。为了输出缓冲区的内容，可以使用ob_end_flush()或flush()输出缓冲区的内容。

3 、ob_get_contents ：返回内部缓冲区的内容。

使用方法：string ob_get_contents(void)

说明：这个函数会返回当前缓冲区中的内容，如果输出缓冲区没有激活，则返回 FALSE 。

4、ob_get_length：返回内部缓冲区的长度。

使用方法：int ob_get_length(void)

说明：这个函数会返回当前缓冲区中的长度；和ob_get_contents一样，如果输出缓冲区没有激活。则返回 FALSE。

5、ob_end_flush ：发送内部缓冲区的内容到浏览器，并且关闭输出缓冲区。

使用方法：void ob_end_flush(void)

说明：这个函数发送输出缓冲区的内容（如果有的话）。

6、ob_end_clean：删除内部缓冲区的内容，并且关闭内部缓冲区

使用方法：void ob_end_clean(void)

说明：这个函数不会输出内部缓冲区的内容而是把它删除！

7、ob_implicit_flush：打开或关闭绝对刷新（隐式地刷新）

使用方法：void ob_implicit_flush ([int flag])

说明：使用过Perl的人都知道 $|=x 的意义，这个字符串可以打开/关闭缓冲区，而ob_implicit_flush函数也和那个一样，默认为关闭缓冲区，打开绝对输出后，每个脚本输出都直接发送到浏览器，不再需要调用 flush()

8、ob_get_clean：得到当前缓冲区的内容并删除当前输出缓。

实质上是一起执行了 ob_get_contents() 和 ob_end_clean()。 

 

二、深入了解：

1. 关于flush函数：

这个函数在PHP3中就出现了，是一个效率很高的函数，他有一个非常有用的功能就是刷新browser的cache。我们举一个运行效果非常明显的例子来说明flush。

Example 2.

01<?php

02for ($i = 1; $i <= 300; $i++ ) {

03    print(" ");

04}

05 

06// 这一句话非常关键，cache的结构使得它的内容只有达到一定的大小才能从浏览器里输出

07// 换言之，如果cache的内容不达到一定的大小，它是不会在程序执行完毕前输出的。经

08// 过测试，我发现这个大小的底限是256个字符长。这意味着cache以后接收的内容都会

09// 源源不断的被发送出去。

10 

11for ($j = 1; $j <= 20; $j++) {

12    echo $j . " <br/>";

13    flush(); // 这一步会使cache新增的内容被挤出去，显示到浏览器上

14    sleep(1); // 让程序"睡"一秒钟，会让你把效果看得更清楚

15}

16?>

注：如果在程序的首部加入ob_implicit_flush()打开绝对刷新，就可以在程序中不再使用flush()，这样做的好处是：提高效率！

也就是说，即使不加ob_start()函数，页面输出也会缓存，当缓存达到一定的大小时再输出，而加了ob_start()函数后，所有的输出都会缓存，只有自己主动输出（flush）（或程序执行完毕）时才输出。

2. 关于ob系列函数：

我想先引用我的好朋友y10k的一个例子：

Example 3.

比如你用得到服务器和客户端的设置信息，但是这个信息会因为客户端的不同而不同，如果想要保存phpinfo()函数的输出怎么办呢？在没有缓冲区控制之前，可以说一点办法也没有，但是有了缓冲区的控制，我们可以轻松的解决：

1<?php

2ob_start(); // 打开缓冲区

3phpinfo(); // 使用phpinfo函数

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

5$file = fopen('D:/cache.txt', 'w'); // 打开文件

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

7fclose($file); //关闭文件

8?>

用以上的方法，就可以把不同用户的phpinfo信息保存下来，这在以前恐怕没有办法办到！其实上面就是将一些"过程"转化为"函数"的方法！或许有人会问："难道就这个样子吗？还有没有其他用途？"当然有了，比如笔者论坛的PHP 语法加亮显示就和这个有关（PHP默认的语法加亮显示函数会直接输出，不能保存结果，如果在每次调用都显示恐怕会很浪费CPU，笔者的论坛就把语法加亮函数显示的结果用控制缓冲区的方法保留了），大家如果感兴趣的话可以来看看。

 

可能现在大家对ob_start()的功能有了一定的了解，上面的一个例子看似简单，但实际上已经掌握了使用ob_start()的要点。

<1>.使用ob_start打开browser的cache，这样可以保证cache的内容在你调用flush()，ob_end_flush()（或程序执行完毕）之前不会被输出。

<2>.现在的你应该知道你所拥有的优势：可以在任何输出内容后面使用header，setcookie以及session，这是ob_start一个很大的特点；也可以使用ob_start的参数，在cache被写入后，然后自动运行命令，比如ob_start("ob_gzhandler")；而我们最常用的做法是用ob_get_contents()得到cache中的内容，然后再进行处理。

<3>.当处理完毕后，我们可以使用各种方法输出，flush()，ob_end_flush()，以及等到程序执行完毕后的自动输出。当然，如果你用的是ob_get_contents()，那么就要你自己控制输出方式了。

 

来，让我们看看能用ob系列函数做些什么：

一、 静态模版技术

简介：所谓静态模版技术就是通过某种方式，使得用户在client端得到的是由PHP产生的html页面。如果这个html页面不会再被更新，那么当另外的用户再次浏览此页面时，程序将不会再调用PHP以及相关的数据库，对于某些信息量比较大的网站，例如sina，163，sohu。类似这种的技术带来的好处是非常巨大的。

我所知道的实现静态输出的有两种办法：

<1>.通过y10k修改的phplib的一个叫类实现。

<2>.使用ob系列函数实现。

对于第一种方法，因为不是这篇文章所要研究的问题，所以不再赘述。

我们现在来看一看第二种方法的具体实现：

Example 4.

1<?php

2ob_start(); // 打开缓冲区

3?>

php页面的全部输出

1<?

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

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

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

5fclose($fp);

6?>

这样，所谓的静态模版就很容易的被实现了……

二、 捕捉输出

以上的Example 4.是一种最简单的情况，你还可以在写入前对$content进行操作。

你可以设法捕捉一些关键字，然后去对它进行再处理，比如Example 3.所述的PHP语法高亮显示。个人认为，这个功能是此函数最大的精华所在，它可以解决各种各样的问题，但需要你有足够的想象力。

Example 5.

01<?php

02function run_code($code) {

03    if ($code) {

04        ob_start();

05        eval($code);

06        $contents = ob_get_contents();

07        ob_end_clean();

08    } else {

09        echo "错误！没有输出";

10        exit();

11    }

12    return $contents;

13}

14?>

以上这个例子的用途不是很大，不过很典型$code的本身就是一个含有变量的输出页面，而这个例子用eval把$code中的变量替换，然后对输出结果再进行输出捕捉，再一次的进行处理。

Example 6. 加快传输

01<?

02/**

03 ** Title.........: PHP4 HTTP Compression Speeds up the Web

04 ** Version.......:

05 ** Author........: catoc <catoc@>

06 ** Filename......:

07 ** Last changed..: 18/10/2000

08 ** Requirments...: PHP4 >= 4.0.1

09 ** PHP was configured with --with-zlib[=DIR]

10 ** Notes.........: Dynamic Content Acceleration compresses

11 ** the data transmission data on the fly

12 ** code by sun jin hu (catoc) <catoc@>

13 ** Most newer browsers since 1998/1999 have

14 ** been equipped to support the HTTP 1.1

15 ** standard known as "content-encoding."

16 ** Essentially the browser indicates to the

17 ** server that it can accept "content encoding"

18 ** and if the server is capable it will then

19 ** compress the data and transmit it. The

20 ** browser decompresses it and then renders

21 ** the page.

22 **

23 ** Modified by John Lim (jlim@)

24 ** based on ideas by Sandy McArthur, Jr

25 ** Usage........:

26 ** No space before the beginning of the first '<?' tag.

27 ** ------------Start of file----------

28 ** |<?

29 ** | include('');

30 ** |? >

31 ** |<HTML>

32 ** |... the page ...

33 ** |</HTML>

34 ** |<?

35 ** | gzdocout();

36 ** |? >

37 ** -------------End of file-----------

38 */

39 

40ob_start();

41ob_implicit_flush(0);

42function CheckCanGzip() {

43    global $HTTP_ACCEPT_ENCODING;

44    if (headers_sent() || connection_timeout() || connection_aborted()){

45        return 0;

46    }

47    if (strpos($HTTP_ACCEPT_ENCODING, 'x-gzip') !== false) return "x-gzip";

48    if (strpos($HTTP_ACCEPT_ENCODING,'gzip') !== false) return "gzip";

49     

50    return 0;

51}

52 

53/* $level = compression level 0-9, 0=none, 9=max */

54function GzDocOut($level = 1, $debug = 0) {

55    $ENCODING = CheckCanGzip();

56    if ($ENCODING){

57        print "n<!-- Use compress $ENCODING -->n";

58        $Contents = ob_get_contents();

59        ob_end_clean();

60        if ($debug) {

61            $s = "<p>Not compress length: " . strlen($Contents);

62            $s .= "Compressed length: " . strlen(gzcompress($Contents, $level));

63            $Contents .= $s;

64        }

65        header("Content-Encoding: $ENCODING");

66        print "x1fx8bx08x00x00x00x00x00";

67        $Size = strlen($Contents);

68        $Crc = crc32($Contents);

69        $Contents = gzcompress($Contents, $level);

70        $Contents = substr($Contents, 0, strlen($Contents) - 4);

71        print $Contents;

72        print pack('V', $Crc);

73        print pack('V', $Size);

74        exit;

75    } else {

76        ob_end_flush();

77        exit;

78    }

79}

80?>