理解 PHP 中的 Streams

Streams 是PHP提供的一個強有力的工具，我們常常在不經意會使用到它，如果善加利用將大大提高PHP的生產力。 駕馭Streams的強大力量後，應用程式將提升到一個新的高度。

下面是PHP手冊中對Streams的一段描述：

Streams 是在PHP 4.3.0版本被引入的，它被用於統一檔案、網路、資料壓縮等類檔案的操作方式，為這些類檔案操作提供了一組通用的函式介面。簡而言之，一個stream就是一個具有流式行為的資源物件。也就是說，我們可以用線性的方式來對stream進行讀取和寫入。並且可以用使用fseek()來跳轉到stream內的任意位置。

每個Streams物件都有一個包裝類，在包裝中可以新增處理特殊協議和編碼的相關程式碼。PHP中已經內建了一些常用的包裝類，我們也可以建立和註冊自定義的包裝類。我們甚至能夠使用現有的context和filter對包裝類進行修改和增強。

Stream 基礎知識

Stream 可以通過<scheme>://<target>方式來引用。其中<scheme>是包裝類的名字，<target>中的內容是由包裝類的語法指定，不同的包裝類的語法會有所不同。

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" http://localhost/dev/streams/php_input.php

在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只要對我們的應用程式稍作修改，就可以將其移植到雲端。 接下來–在我的下一篇文章中–我將介紹如何編寫自定義的包裝類以實現對特殊檔案格式和編碼格式的操作。