Streams 是PHP提供的一個強大的工具,我們常常在不經意會使用到它,如果善加利用將大大提高PHP的生產力。 駕馭Streams的強大力量後,應用程式將提升到一個新的高度。
下面是PHP手冊中對Streams的一段描述:
Streams 是在PHP 4.3.0版本被引入的,它被用於統一文件、網絡、資料壓縮等類文件的操作方式,為這些類文件操作提供了一組通用的函數介面。簡而言之,一個stream就是一個具有串流行為的資源物件。也就是說,我們可以用線性的方式來對stream進行讀取和寫入。並且可以用使用fseek()來跳到stream內的任意位置。
每個Streams物件都有一個包裝類,在包裝中可以加入處理特殊協定和編碼的相關程式碼。 PHP中已經內建了一些常用的包裝類,我們也可以建立和註冊自訂的包裝類。我們甚至能夠使用現有的context和filter對包裝類別進行修改和增強。
Stream 基礎知識
Stream 可以透過
PHP預設的包裝類別是file://,也就是說我們在存取檔案系統的時候,其實就是在使用一個stream。我們可以透過下面兩種方式來讀取檔案中的內容,readfile('/path/to/somefile.txt')或readfile('file:///path/to/somefile.txt'),這兩種方式是等效的。如果你是使用readfile('http://google.com/'),那麼PHP會選取HTTP stream包裝類別來進行操作。
正如上文所述,PHP提供了不少內建的包轉類,protocol以及filter。 依照下文所述的方式,可以查詢到本機所支援的包裝類別:
<?php print_r(stream_get_transports()); print_r(stream_get_wrappers()); print_r(stream_get_filters());
在我機器上的輸出結果為:
Array ( [0] => tcp [1] => udp [2] => unix [3] => udg [4] => ssl [5] => sslv3 [6] => sslv2 [7] => tls ) Array ( [0] => https [1] => ftps [2] => compress.zlib [3] => compress.bzip2 [4] => php [5] => file [6] => glob [7] => data [8] => http [9] => ftp [10] => zip [11] => phar ) Array ( [0] => zlib.* [1] => bzip2.* [2] => convert.iconv.* [3] => string.rot13 [4] => string.toupper [5] => string.tolower [6] => string.strip_tags [7] => convert.* [8] => consumed [9] => dechunk [10] => mcrypt.* [11] => mdecrypt.* )
提供的功能非常多,看上去還不錯吧?
除了上述內建的Stream,我們還可以為 Amazon S3, MS Excel, Google Storage, Dropbox 甚至Twitter編寫更多的第三方的Stream。
php:// 包裝類
PHP中內建了本語言用於處理I/O stream的包裝類別。可以分為幾類,基礎的有php://stdin,php://stdout, 以及php://stderr,這3個stream分別對應到預設 的I/O資源。同時PHP也提供了php://input,透過這個包裝類別可以使用唯讀的方式存取POST請求中的raw body。 這是一項非常有用的功能,特別是在處理那些將資料負載嵌入到POST請求中的遠端服務時。
下面我們使用cURL工具來做一個簡單的測試:
curl -d "Hello World" -d "foo=bar&name=John" <a href="http://localhost/dev/streams/php_input.php">http://localhost/dev/streams/php_input.php</a>
在PHP腳本中使用print_r($_POST)的測試結果如下所示:
Array ( [foo] => bar [name] => John )
我們注意$_POST array數據的。但如果我們使用readfile('php://input'),結果就不同了:
Hello World&foo=bar&name=John
PHP 5.1又增加了php://memory和php://tempstream這兩個包轉類,用於讀寫臨時數據。正如包裝類別命名中所暗示的,這些資料被儲存在底層系統中的記憶體或暫存檔案中。
php://filter是一個元包裝類,用於為stream增加filter功能。使用readfile()或file_get_contents()/stream_get_contents()開啟stream時,filter將會被啟用。以下是一個例子:
<?php // Write encoded data file_put_contents("php://filter/write=string.rot13/resource=file:///path/to/somefile.txt","Hello World"); // Read data and encode/decode readfile("php://filter/read=string.toupper|string.rot13/resource=http://www.google.com");
在第一個例子中使用了一個filter來對保存到磁碟中的資料進行編碼處理,在二個例子中,使用兩個級聯的filter來從遠端的URL讀取數據。使用filter能為你的應用程式帶來極為強大的功能。
Stream上下文
context是一組stream相關的參數或選項,使用context可以修改或增強包裝類別的行為。例如使用context來修改HTTP包裝器是常用來的使用場景。 這樣我們就可以不使用cURL工具,就能完成一些簡單的網路操作。下面是一個例子:
<?php $opts = array( 'http'=>array( 'method'=>"POST", 'header'=> "Auth: SecretAuthTokenrn" . "Content-type: application/x-www-form-urlencodedrn" . "Content-length: " . strlen("Hello World"), 'content' => 'Hello World' ) ); $default = stream_context_get_default($opts); readfile('http://localhost/dev/streams/php_input.php');
首先要定义一个options array,这是个二位数组,可以通过$array['wrapper']['option_name']的形式来访问其中的参数。(注意每个包装类中context的options是不同的)。然后调用stream_context_get_default()来设置这些option,stream_context_get_default()同时还会将默认的context作为结果返回回来。设置完成后,接下来调用readfile(),就会应用刚才设置好的context来抓取内容。
在上面的例子中,内容被嵌入到request的body中,这样远端的脚本就可以使用php://input来读取这些内容。同时,我们还能使用apache_request_headers()来获取request的header,如下所示:
Array ( [Host] => localhost [Auth] => SecretAuthToken [Content-type] => application/x-www-form-urlencoded [Content-length] => 11 )
在上面的例子中是修改默认context的参数,当然我们也可以创建一个新的context,进行交替使用。
<?php $alternative = stream_context_create($other_opts); readfile('http://localhost/dev/streams/php_input.php', false, $alternative);
结论
我们怎样在现实世界中驾驭stream的强大力量呢?使用stream能为我们的程序带来什么现实的好处? 正如前文介绍的那样,stream对所有文件系统相关的功能进行了抽象,所以我第一个想到的应用场景是使用虚拟文件系统的包装类来访问PaaS供应商提供的服务,比如说访问HeroKu或者AppFog,它们实际上都没有真正文件系统。 使用stream只要对我们的应用程序稍作修改,就可以将其移植到云端。 接下来--在我的下一篇文章中--我将介绍如何编写自定义的包装类以实现对特殊文件格式和编码格式的操作。