瞭解PHP中Stream（流）的概念與用法(轉)

Stream是PHP開發裏最容易被忽視的函數系列（SPL系列，Stream系列，pack函數，封裝協議）之一，但其是個頗有用也很重要的函數。Stream能夠翻譯爲「流」，在Java裏，流是一個很重要的概念。

流(stream)的概念源於UNIX中管道(pipe)的概念。在UNIX中，管道是一條不間斷的字節流，用來實現程序或進程間的通訊，或讀寫外圍設備、外部文件等。根據流的方向又能夠分爲輸入流和輸出流，同時能夠在其外圍再套上其它流，好比緩衝流，這樣就能夠獲得更多流處理方法。

PHP裏的流和Java裏的流其實是同一個概念，只是簡單了一點。因爲PHP主要用於Web開發，因此「流」這塊的概念被提到的較少。若是有 Java基礎，對於PHP裏的流就更容易理解了。其實PHP裏的許多高級特性，好比SPL，異常，過濾器等都參考了Java的實現，在理念和原理上同出一 轍。

好比下面是一段PHP SPL標準庫的用法（遍歷目錄，查找固定條件的文件）：

 1 class RecursiveFileFilterIterator extends FilterIterator
 2 {
 3     // 知足條件的擴展名
 4     protected $ext = array('jpg','gif');
 5 
 6     /**
 7      * 提供 $path 並生成對應的目錄迭代器
 8      */
 9     public function __construct($path)
10     {
11         parent::__construct(new RecursiveIteratorIterator(new RecursiveDirectoryIterator($path)));
12     }
13 
14     /**
15      * 檢查文件擴展名是否知足條件
16      */
17     public function accept()
18     {
19         $item = $this->getInnerIterator();
20         if ($item->isFile() && in_array(pathinfo($item->getFilename(), PATHINFO_EXTENSION), $this->ext))
21         {
22             return TRUE;
23         }
24     }
25 }
26 
27 // 實例化
28 foreach (new RecursiveFileFilterIterator('D:/history') as $item)
29 {
30     echo $item . PHP_EOL;
31 }

Java裏也有和其同出一轍的代碼：

 1 public class DirectoryContents
 2 {
 3     public static void main(String[] args) throws IOException
 4     {
 5         File f = new File("."); // current directory
 6 
 7         FilenameFilter textFilter = new FilenameFilter()
 8         {
 9             public boolean accept(File dir, String name)
10             {
11                 String lowercaseName = name.toLowerCase();
12                 if (lowercaseName.endsWith(".txt"))
13                 {
14                     return true;
15                 }
16                 else
17                 {
18                     return false;
19                 }
20             }
21         };
22 
23         File[] files = f.listFiles(textFilter);
24 
25         for (File file : files)
26         {
27             if (file.isDirectory())
28             {
29                 System.out.print("directory:");
30             }
31             else
32             {
33                 System.out.print("     file:");
34             }
35 
36             System.out.println(file.getCanonicalPath());
37         }
38     }
39 }

舉這個例子，一方面是說明PHP和Java在不少方面的概念是同樣的，掌握一種語言對理解另一門語言會有很大的幫助；另外一方面，這個例子也有助於咱們下面要提到的過濾器流-filter。其實也是一種設計模式的體現。

咱們能夠經過幾個例子先來了解stream系列函數的使用。

下面是一個使用socket來抓取數據的例子：

 1 $post_ =array (
 2     'author' => 'Gonn',
 3     'mail'=>'gonn@nowamagic.net',
 4     'url'=>'http://www.nowamagic.net/',
 5     'text'=>'歡迎訪問簡明現代魔法');
 6 
 7 $data=http_build_query($post_);
 8 $fp = fsockopen("nowamagic.net", 80, $errno, $errstr, 5);
 9 
10 $out="POST http://nowamagic.net/news/1/comment HTTP/1.1\r\n";
11 $out.="Host: typecho.org\r\n";
12 $out.="User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; zh-CN; rv:1.9.2.13) Gecko/20101203 Firefox/3.6.13"."\r\n";
13 $out.="Content-type: application/x-www-form-urlencoded\r\n";
14 $out.="PHPSESSID=082b0cc33cc7e6df1f87502c456c3eb0\r\n";
15 $out.="Content-Length: " . strlen($data) . "\r\n";
16 $out.="Connection: close\r\n\r\n";
17 $out.=$data."\r\n\r\n";
18 
19 fwrite($fp, $out);
20 while (!feof($fp))
21 {
22     echo fgets($fp, 1280);
23 }
24 
25 fclose($fp);

咱們也能夠用stream_socket 實現，這很簡單，只須要打開socket的代碼換成下面的便可：

1 $fp = stream_socket_client("tcp://nowamagic.net:80", $errno, $errstr, 3);

再來看一個stream的例子：

file_get_contents函數通常經常使用來讀取文件內容，但這個函數也能夠用來抓取遠程url，起到和curl相似的做用。

 1 $opts = array (
 2     'http'=>array(
 3        'method' => 'POST',
 4        'header'=> "Content-type: application/x-www-form-urlencoded\r\n" .
 5                   "Content-Length: " . strlen($data) . "\r\n",
 6        'content' => $data)
 7 );
 8 
 9 $context = stream_context_create($opts);
10 file_get_contents('http://nowamagic.net/news/1/comment', false, $context);

注意第三個參數，$context，即HTTP流上下文，能夠理解爲套在file_get_contents函數上的一根管道。同理，咱們還能夠建立FTP流，socket流，並把其套在對應的函數在。

更多關於 stream_context_create，能夠參考：PHP函數補完：stream_context_create()模擬POST/GET。

上面提到的兩個stream系列的函數都是相似包裝器的流，做用在某種協議的輸入輸出流上。這樣的使用方式和概念，其實和Java中的流並無大的區別，好比Java中常常有這樣的寫法：

1 new DataOutputStream(new BufferedOutputStream(new FileOutputStream(new File(fileName))));

一層流嵌套着另一層流，和PHP裏有殊途同歸之妙。

咱們再來看個過濾器流的做用：

 1 $fp = fopen('c:/test.txt', 'w+');
 2 
 3 /* 把rot13過濾器做用在寫入流上 */
 4 stream_filter_append($fp, "string.rot13", STREAM_FILTER_WRITE);
 5 
 6 /* 寫入的數據通過rot13過濾器的處理*/
 7 fwrite($fp, "This is a test\n");
 8 rewind($fp);
 9 
10 /* 讀取寫入的數據，獨到的天然是被處理過的字符了 */
11 fpassthru($fp);
12 fclose($fp);
13 
14 // output：Guvf vf n grfg

在上面的例子中，若是咱們把過濾器的類型設置爲STREAM_FILTER_ALL，即同時做用在讀寫流上，那麼讀寫的數據都將被rot13過濾器處理，咱們讀出的數據就和寫入的原始數據是一致的。

你可能會奇怪stream_filter_append中的 "string.rot13"這個變量來的莫名其妙，這其實是PHP內置的一個過濾器。

使用下面的方法便可打印出PHP內置的流：

1 $streamlist = stream_get_filters();
2 print_r($streamlist);

輸出：

 1 Array
 2 (
 3     [0] => convert.iconv.*
 4     [1] => mcrypt.*
 5     [2] => mdecrypt.*
 6     [3] => string.rot13
 7     [4] => string.toupper
 8     [5] => string.tolower
 9     [6] => string.strip_tags
10     [7] => convert.*
11     [8] => consumed
12     [9] => dechunk
13     [10] => zlib.*
14     [11] => bzip2.*
15 )

天然而然，咱們會想到定義本身的過濾器，這個也不難：

 1 class md5_filter extends php_user_filter
 2 {
 3     function filter($in, $out, &$consumed, $closing)
 4     {
 5         while ($bucket = stream_bucket_make_writeable($in))
 6         {
 7             $bucket->data = md5($bucket->data);
 8             $consumed += $bucket->datalen;
 9             stream_bucket_append($out, $bucket);
10         }
11 
12         //數據處理成功，可供其它管道讀取
13         return PSFS_PASS_ON;
14     }
15 }
16 
17 stream_filter_register("string.md5", "md5_filter");

注意：過濾器名能夠隨意取。

以後就可使用"string.md5"這個咱們自定義的過濾器了。

這個過濾器的寫法看起來非常有點摸不着頭腦，事實上咱們只須要看一下php_user_filter這個類的結構和內置方法即瞭解了。

過濾器流最適合作的就是文件格式轉換了，包括壓縮，編解碼等，除了這些「偏門」的用法外，filter流更有用的一個地方在於調試和日誌功能，好比說在socket開發中，註冊一個過濾器流進行log記錄。好比下面的例子：

 1 class md5_filter extends php_user_filter
 2 {
 3     public function filter($in, $out, &$consumed, $closing)
 4     {
 5         $data="";
 6         while ($bucket = stream_bucket_make_writeable($in))
 7         {
 8             $bucket->data = md5($bucket->data);
 9             $consumed += $bucket->datalen;
10             stream_bucket_append($out, $bucket);
11         }
12 
13         call_user_func($this->params, $data);
14         return PSFS_PASS_ON;
15     }
16 }
17 
18 $callback = function($data)
19 {
20     file_put_contents("c:\log.txt",date("Y-m-d H:i")."\r\n");
21 };

這個過濾器不只能夠對輸入流進行處理，還能回調一個函數來進行日誌記錄。

能夠這麼使用：

1 stream_filter_prepend($fp, "string.md5", STREAM_FILTER_WRITE,$callback);

PHP中的stream流系列函數中還有一個很重要的流，就是包裝類流 streamWrapper。使用包裝流可使得不一樣類型的協議使用相同的接口操縱數據。這個之後再說。