理解 PHP 中的 Streams
Streams 是PHP提供的一個強有力的工具,我們常常在不經(jīng)意會使用到它,如果善加利用將大大提高PHP的生產(chǎn)力。 駕馭Streams的強大力量后,應(yīng)用程序?qū)⑻嵘揭粋€新的高度。
下面是PHP手冊中對Streams的一段描述:
Streams 是在PHP 4.3.0版本被引入的,它被用于統(tǒng)一文件、網(wǎng)絡(luò)、數(shù)據(jù)壓縮等類文件的操作方式,為這些類文件操作提供了一組通用的函數(shù)接口。簡而言之,一個stream就是一個具有流式行為的資源對象。也就是說,我們可以用線性的方式來對stream進行讀取和寫入。并且可以用使用fseek()來跳轉(zhuǎn)到stream內(nèi)的任意位置。 |
每個Streams對象都有一個包裝類,在包裝中可以添加處理特殊協(xié)議和編碼的相關(guān)代碼。PHP中已經(jīng)內(nèi)置了一些常用的包裝類,我們也可以創(chuàng)建和注冊自定義的包裝類。我們甚至能夠使用現(xiàn)有的context和filter對包裝類進行修改和增強。
Stream 基礎(chǔ)知識
Stream 可以通過<scheme>://<target>方式來引用。其中<scheme>是包裝類的名字,<target>中的內(nèi)容是由包裝類的語法指定,不同的包裝類的語法會有所不同。
PHP默認(rèn)的包裝類是file://,也就是說我們在訪問文件系統(tǒng)的時候,其實就是在使用一個stream。我們可以通過下面兩種方式來讀取文件中的內(nèi)容,readfile('/path/to/somefile.txt')或者readfile('file:///path/to/somefile.txt'),這兩種方式是等效的。如果你是使用readfile('http://google.com/'),那么PHP會選取HTTP stream包裝類來進行操作。
正如上文所述,PHP提供了不少內(nèi)建的包轉(zhuǎn)類,protocol以及filter。 按照下文所述的方式,可以查詢到本機所支持的包裝類:
- <?php
- print_r(stream_get_transports());
- print_r(stream_get_wrappers());
- print_r(stream_get_filters());
在我機器上的輸出結(jié)果為:
- 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.*
- )
提供的功能非常多,看上去還不錯吧?
除了上述內(nèi)建的Stream,我們還可以為 Amazon S3, MS Excel, Google Storage, Dropbox 甚至Twitter編寫更多的第三方的Stream。
php:// 包裝類
PHP中內(nèi)建了本語言用于處理I/O stream的包裝類??梢苑譃閹最悾A(chǔ)的有php://stdin,php://stdout, 以及php://stderr,這3個stream分別映射到默認(rèn) 的I/O資源。同時PHP還提供了php://input,通過這個包裝類可以使用只讀的方式訪問POST請求中的raw body。 這是一項非常有用的功能,特別是在處理那些將數(shù)據(jù)負(fù)載嵌入到POST請求中的遠程服務(wù)時。
下面我們使用cURL工具來做一個簡單的測試:
- curl -d "Hello World" -d "foo=bar&name=John" http://localhost/dev/streams/php_input.php
在PHP腳本中使用print_r($_POST)的測試結(jié)果如下所示:
- Array
- (
- [foo] => bar
- [name] => John
- )
我們注意$_POST array中是無法訪問到第一項數(shù)據(jù)的。但是如果我們使用readfile('php://input'),結(jié)果就不同了:
- Hello World&foo=bar&name=John
PHP 5.1又增加了php://memory和php://tempstream這兩個包轉(zhuǎn)類,用于讀寫臨時數(shù)據(jù)。正如包裝類命名中所暗示的,這些數(shù)據(jù)被存儲在底層系統(tǒng)中的內(nèi)存或者臨時文件中。
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來對保存到磁盤中的數(shù)據(jù)進行編碼處理,在二個例子中,使用兩個級聯(lián)的filter來從遠端的URL讀取數(shù)據(jù)。使用filter能為你的應(yīng)用帶來極為強大的功能。
Stream上下文
context是一組stream相關(guān)的參數(shù)或選項,使用context可以修改或增強包裝類的行為。例如使用context來修改HTTP包裝器是一個常用到的使用場景。 這樣我們就可以不使用cURL工具,就能完成一些簡單的網(wǎng)絡(luò)操作。下面是一個例子:
- <?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,這是個二位數(shù)組,可以通過$array['wrapper']['option_name']的形式來訪問其中的參數(shù)。(注意每個包裝類中context的options是不同的)。然后調(diào)用stream_context_get_default()來設(shè)置這些option,stream_context_get_default()同時還會將默認(rèn)的context作為結(jié)果返回回來。設(shè)置完成后,接下來調(diào)用readfile(),就會應(yīng)用剛才設(shè)置好的context來抓取內(nèi)容。
在上面的例子中,內(nèi)容被嵌入到request的body中,這樣遠端的腳本就可以使用php://input來讀取這些內(nèi)容。同時,我們還能使用apache_request_headers()來獲取request的header,如下所示:
- Array
- (
- [Host] => localhost
- [Auth] => SecretAuthToken
- [Content-type] => application/x-www-form-urlencoded
- [Content-length] => 11
- )
在上面的例子中是修改默認(rèn)context的參數(shù),當(dāng)然我們也可以創(chuàng)建一個新的context,進行交替使用。
- <?php
- $alternative = stream_context_create($other_opts);
- readfile('http://localhost/dev/streams/php_input.php', false, $alternative);
結(jié)論
我們怎樣在現(xiàn)實世界中駕馭stream的強大力量呢?使用stream能為我們的程序帶來什么現(xiàn)實的好處? 正如前文介紹的那樣,stream對所有文件系統(tǒng)相關(guān)的功能進行了抽象,所以我第一個想到的應(yīng)用場景是使用虛擬文件系統(tǒng)的包裝類來訪問PaaS供應(yīng)商提供的服務(wù),比如說訪問HeroKu或者AppFog,它們實際上都沒有真正文件系統(tǒng)。 使用stream只要對我們的應(yīng)用程序稍作修改,就可以將其移植到云端。 接下來--在我的下一篇文章中--我將介紹如何編寫自定義的包裝類以實現(xiàn)對特殊文件格式和編碼格式的操作。