PHP中的輸出緩衝控制

在 PHP 中,我們直接進行 echo 、 或者 print_r 的時候,輸出的內容就會直接打印出來。但是,在某些情況下,我們並不想直接打印,這個時候就可以使用輸出緩衝控制來進行輸出打印的控制。當然,這一套功能並不僅限出針對打印的內容,我們還可以做其它一些操作,這個我們放到最後再說。

清除輸出

首先,我們先來看看不讓 echo 之類的內容打印輸出。

ob_start();
echo 111, PHP_EOL;
echo "aaaa", PHP_EOL;
ob_end_clean();

相信有不少小夥伴應該見過 ob_start() 這個函數,它的作用就是開始一段輸出緩衝控制。在 ob_start() 之後的代碼中的輸出語句都會進入輸出緩衝區,這個時候,如果我們調用了 ob_end_clean() 、 ob_clean() 或者 ob_get_clean() ,則不會有任何輸出了。它們三個的作用都是清除輸出緩衝區的內容。具體的區別大家可以參考文章最後給出的函數說明或者官方文檔。

獲得輸出緩衝區的內容

ob_start();
echo 111, PHP_EOL;
echo "aaaa", PHP_EOL;
$v = ob_get_contents();
ob_end_clean();

echo $v;

上面說過,使用了 ob_end_clean() 就會清除輸出緩衝區裏面的內容,但是在這段代碼中,我們使用 ob_get_contents() 函數直接將緩衝區的內容賦值給了變量 \v 。這時候,v 中就有了前面兩段 echo 中的內容,也就是說,這個一套操作我們就拿到了本身應該輸出的內容,並將它保存在了變量中。這樣做有什麼用呢?我們可以獲得類似於 phpinfo() 、 var_dump() 這些直接輸出函數的內容了,並且不會打印在客戶端屏幕上。比如:

ob_start();
php_info();
$v = ob_get_contents();
ob_end_clean();

echo $v;

在 $v 中的內容就是 php_info() 的內容了。這就是輸出緩衝控制的第二個能力。

刷新(輸出)緩衝區內容

ob_start();
echo 111, PHP_EOL;
echo "aaaa", PHP_EOL;
flush();
ob_flush();

類似的,我們在緩衝區中想要再次直接輸出內容,使用 flush() 、ob_flush() 、 ob_end_flush() 及 ob_get_flush() 就可以了,其實就是相當於讓 ob_start() 之後的 echo 這類輸出語句重新生效並正常輸出。

另外,我們還可以使用一個函數進行自動的刷新。

ob_implicit_flush();

ob_start();
echo 111, PHP_EOL;
echo "aaaa", PHP_EOL;

使用 ob_implicit_flush() 之後,我們就不需要手動地調用 ob_flush() 之類的函數來刷新緩衝區內容了。

一些檢測函數

ob_start();
ob_start();

echo 123, PHP_EOL;

echo ob_get_length(), PHP_EOL;
// 3

echo ob_get_level(), PHP_EOL;
// 2

print_r(ob_get_status(true));

// Array
// (
//     [0] => Array
//         (
//             [name] => default output handler
//             [type] => 0
//             [flags] => 112
//             [level] => 0
//             [chunk_size] => 0
//             [buffer_size] => 16384
//             [buffer_used] => 0
//         )

//     [1] => Array
//         (
//             [name] => default output handler
//             [type] => 0
//             [flags] => 112
//             [level] => 1
//             [chunk_size] => 0
//             [buffer_size] => 16384
//             [buffer_used] => 17
//         )

// )

ob_get_flush();

ob_get_length() 會返回當前緩衝區裏面內容的長度,這裏我們只打印了一個 123 ,在緩衝區中保存了3個字符,所以輸出的正是 3 。ob_get_level() 返回的是當前緩衝區的層級,請注意,我們在上面調用了兩次 ob_start() ,也就是有兩層的緩衝區,這個緩衝區是可以嵌套的。ob_get_status() 函數是緩衝區的狀態信息,字段的說明可以查看官方文檔,這裏不再贅述。

使用 ob_start() 的回調函數來進行輸出緩衝區的內容替換

這是一個例子,但是可以推廣到其他很功能,比如我們可以用來進行全局的輸出過濾、可以做 CSS 或 JS 文件的壓縮優化等等。

ob_start(function($text){
    return (str_replace("apples", "oranges", $text));
});

echo "It's like comparing apples to oranges", PHP_EOL;
ob_get_flush();

// It's like comparing oranges to oranges

最後的輸出結果就是將 apples 內容替換成了 oranges 內容。

添加 URL 重寫器

output_add_rewrite_var('var', 'value');
// some links
echo '<a href="file.php">link</a>
<a href="http://example.com">link2</a>';

// <a href="file.php?var=value">link</a>
// <a href="http://example.com">link2</a>

// a form
echo '<form action="script.php" method="post">
<input type="text" name="var2" />
</form>';

// <form action="script.php" method="post">
// <input type="hidden" name="var" value="value" />
// <input type="text" name="var2" />
// </form>

上面的代碼看出什麼端倪了嘛?沒錯,使用 output_add_rewrite_var() 函數,我們可以在 PHP 輸出的時候爲 HTML 的鏈接或者表單代碼增加一個參數。有沒有想到什麼使用場景?POST 表單的 CSRF 攻擊的防範。

這個函數會根據 php.ini 文件中的 url_rewriter.tags 配置項來進行添加,在默認情況下這個配置項只支持 from 表單,同時,它還可以支持 a 標籤的href 、 area標籤的href 、 frame標籤的src 、 input標籤的src 等等。也就是說,會在這些標籤相對應的屬性中自動添加字段。當然,它也有一個反函數 output_reset_rewrite_vars() 用於取消之前增加的這個參數。

總結

關於輸出緩衝控制這塊還有很多好玩的東西,不過限於篇幅我們先介紹到這裏,將來踫到什麼好的功能的應用我們再單獨講解。現在基於 Swoole 的應用越來越多,當我們需要將 TP 、 Laravel 這類傳統框架轉換成支持 Swoole 的時候,往往就需要在入口文件使用輸出緩衝控制來進行修改。因爲傳統框架基本都是直接進行 echo 之類的輸出的,而在 Swoole 中,echo 這類的內容是直接打印在控制檯的,這就需要我們通過 ob_get_contents() 能力獲得全部的輸出再通過 response->end() 來進行實際的響應。另外,還有一些其他的場景也會用到輸出緩衝控制:

  • 1.在PHP中,像header(), session_start(), setcookie() 等這樣的發送頭文件的函數前,不能有任何的輸出,而利用輸出緩衝控制函數可以在這些函數前進行輸出而不報錯
  • 2.對輸出的內容進行處理,例如生成靜態緩存文件、進行gzip壓縮輸出,這算是較常用的功能了
  • 3.捕獲一些不可獲取的函數輸出,例如phpinfo(), var_dump() 等等,這些函數都會將運算結果顯示在瀏覽器中,而如果我們想對這些結果進行處理,則用輸出緩衝控制函數是個不錯的方法。說的通俗點,就是這類函數都不會有返回值,而要獲取這些函數的輸出數據,就要用到輸出緩衝控制函數
  • 4.對一些數據進行實時的輸出

最後,再給出輸出緩衝控制相關的函數說明,具體內容大家還是要多看官方文檔的介紹。

  • flush — 刷新輸出緩衝
  • ob_clean — 清空(擦掉)輸出緩衝區
  • ob_end_clean — 清空(擦除)緩衝區並關閉輸出緩衝
  • ob_end_flush — 沖刷出(送出)輸出緩衝區內容並關閉緩衝
  • ob_flush — 沖刷出(送出)輸出緩衝區中的內容
  • ob_get_clean — 得到當前緩衝區的內容並刪除當前輸出緩。
  • ob_get_contents — 返回輸出緩衝區的內容
  • ob_get_flush — 刷出(送出)緩衝區內容,以字符串形式返回內容,並關閉輸出緩衝區。
  • ob_get_length — 返回輸出緩衝區內容的長度
  • ob_get_level — 返回輸出緩衝機制的嵌套級別
  • ob_get_status — 得到所有輸出緩衝區的狀態
  • ob_gzhandler — 在ob_start中使用的用來壓縮輸出緩衝區中內容的回調函數。ob_start callback function to gzip output buffer
  • ob_implicit_flush — 打開/關閉絕對刷送
  • ob_list_handlers — 列出所有使用中的輸出處理程序。
  • ob_start — 打開輸出控制緩衝
  • output_add_rewrite_var — 添加URL重寫器的值(Add URL rewriter values)
  • output_reset_rewrite_vars — 重設URL重寫器的值(Reset URL rewriter values)

測試代碼:

https://github.com/zhangyue0503/dev-blog/blob/master/php/202005/source/%E8%BF%98%E6%90%9E%E4%B8%8D%E6%87%82PHP%E4%B8%AD%E7%9A%84%E8%BE%93%E5%87%BA%E7%BC%93%E5%86%B2%E6%8E%A7%E5%88%B6%EF%BC%9F.php

參考文檔:

https://www.php.net/manual/zh/ref.outcontrol.php

https://www.php.net/manual/zh/session.configuration.php#ini.url-rewriter.tags

https://blog.csdn.net/xiaofan1988/article/details/43124359

===========

各自媒體平臺均可搜索【硬核項目經理】

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章