淺談PHP中Stream（流）

更新時(shí)間：2015年06月08日 16:08:46 投稿：hebedich

Stream是PHP開(kāi)發(fā)里最容易被忽視的函數(shù)系列（SPL系列，Stream系列，pack函數(shù)，封裝協(xié)議）之一，但其是個(gè)很有用也很重要的函數(shù)。Stream可以翻譯為“流”，在Java里，流是一個(gè)很重要的概念。

流(stream)的概念源于UNIX中管道(pipe)的概念。在UNIX中，管道是一條不間斷的字節(jié)流，用來(lái)實(shí)現(xiàn)程序或進(jìn)程間的通信，或讀寫(xiě)外圍設(shè)備、外部文件等。根據(jù)流的方向又可以分為輸入流和輸出流，同時(shí)可以在其外圍再套上其它流，比如緩沖流，這樣就可以得到更多流處理方法。

PHP里的流和Java里的流實(shí)際上是同一個(gè)概念，只是簡(jiǎn)單了一點(diǎn)。由于PHP主要用于Web開(kāi)發(fā)，所以“流”這塊的概念被提到的較少。如果有Java基礎(chǔ)，對(duì)于PHP里的流就更容易理解了。其實(shí)PHP里的許多高級(jí)特性，比如SPL，異常，過(guò)濾器等都參考了Java的實(shí)現(xiàn)，在理念和原理上同出一轍。

比如下面是一段PHP SPL標(biāo)準(zhǔn)庫(kù)的用法（遍歷目錄，查找固定條件的文件）：

class RecursiveFileFilterIterator extends FilterIterator
{
 // 滿足條件的擴(kuò)展名
 protected $ext = array('jpg','gif');
 /**
  * 提供 $path 并生成對(duì)應(yīng)的目錄迭代器
  */
 public function __construct($path)
 {
   parent::__construct(new RecursiveIteratorIterator(new RecursiveDirectoryIterator($path)));
 }
 /**
  * 檢查文件擴(kuò)展名是否滿足條件
  */
 public function accept()
 {
   $item = $this->getInnerIterator();
   if ($item->isFile() && in_array(pathinfo($item->getFilename(), PATHINFO_EXTENSION), $this->ext))
   {
     return TRUE;
   }
 }
}
// 實(shí)例化
foreach (new RecursiveFileFilterIterator('D:/history') as $item)
{
 echo $item . PHP_EOL;
}

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

public class DirectoryContents
{
 public static void main(String[] args) throws IOException
 {
   File f = new File("."); // current directory
   FilenameFilter textFilter = new FilenameFilter()
   {
     public boolean accept(File dir, String name)
     {
       String lowercaseName = name.toLowerCase();
       if (lowercaseName.endsWith(".txt"))
       {
         return true;
       }
       else
       {
         return false;
       }
     }
   };
   File[] files = f.listFiles(textFilter);
   for (File file : files)
   {
     if (file.isDirectory())
     {
       System.out.print("directory:");
     }
     else
     {
       System.out.print("   file:");
     }
     System.out.println(file.getCanonicalPath());
   }
 }
}

舉這個(gè)例子，一方面是說(shuō)明PHP和Java在很多方面的概念是一樣的，掌握一種語(yǔ)言對(duì)理解另外一門(mén)語(yǔ)言會(huì)有很大的幫助；另一方面，這個(gè)例子也有助于我們下面要提到的過(guò)濾器流-filter。其實(shí)也是一種設(shè)計(jì)模式的體現(xiàn)。

我們可以通過(guò)幾個(gè)例子先來(lái)了解stream系列函數(shù)的使用。

下面是一個(gè)使用socket來(lái)抓取數(shù)據(jù)的例子：

$post_ =array (
 'author' => 'Gonn',
 'mail'=>'gonn@nowamagic.net',
 'url'=>'http://www.nowamagic.net/',
 'text'=>'歡迎訪問(wèn)簡(jiǎn)明現(xiàn)代魔法');
$data=http_build_query($post_);
$fp = fsockopen("nowamagic.net", 80, $errno, $errstr, 5);
$out="POST http://nowamagic.net/news/1/comment HTTP/1.1\r\n";
$out.="Host: typecho.org\r\n";
$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";
$out.="Content-type: application/x-www-form-urlencoded\r\n";
$out.="PHPSESSID=082b0cc33cc7e6df1f87502c456c3eb0\r\n";
$out.="Content-Length: " . strlen($data) . "\r\n";
$out.="Connection: close\r\n\r\n";
$out.=$data."\r\n\r\n";
fwrite($fp, $out);
while (!feof($fp))
{
 echo fgets($fp, 1280);
}
fclose($fp);

我們也可以用stream_socket 實(shí)現(xiàn)，這很簡(jiǎn)單，只需要打開(kāi)socket的代碼換成下面的即可：

復(fù)制代碼代碼如下:

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

再來(lái)看一個(gè)stream的例子：

file_get_contents函數(shù)一般常用來(lái)讀取文件內(nèi)容，但這個(gè)函數(shù)也可以用來(lái)抓取遠(yuǎn)程url，起到和curl類(lèi)似的作用。

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

注意第三個(gè)參數(shù)，$context，即HTTP流上下文，可以理解為套在file_get_contents函數(shù)上的一根管道。同理，我們還可以創(chuàng)建FTP流，socket流，并把其套在對(duì)應(yīng)的函數(shù)在。

更多關(guān)于 stream_context_create，可以參考：PHP函數(shù)補(bǔ)完：stream_context_create()模擬POST/GET。

上面提到的兩個(gè)stream系列的函數(shù)都是類(lèi)似包裝器的流，作用在某種協(xié)議的輸入輸出流上。這樣的使用方式和概念，其實(shí)和Java中的流并沒(méi)有大的區(qū)別，比如Java中經(jīng)常有這樣的寫(xiě)法：

復(fù)制代碼代碼如下:

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

一層流嵌套著另外一層流，和PHP里有異曲同工之妙。

我們?cè)賮?lái)看個(gè)過(guò)濾器流的作用：

$fp = fopen('c:/test.txt', 'w+');
/* 把rot13過(guò)濾器作用在寫(xiě)入流上 */
stream_filter_append($fp, "string.rot13", STREAM_FILTER_WRITE);
/* 寫(xiě)入的數(shù)據(jù)經(jīng)過(guò)rot13過(guò)濾器的處理*/
fwrite($fp, "This is a test\n");
rewind($fp);
/* 讀取寫(xiě)入的數(shù)據(jù)，獨(dú)到的自然是被處理過(guò)的字符了 */
fpassthru($fp);
fclose($fp);
// output：Guvf vf n grfg

在上面的例子中，如果我們把過(guò)濾器的類(lèi)型設(shè)置為STREAM_FILTER_ALL，即同時(shí)作用在讀寫(xiě)流上，那么讀寫(xiě)的數(shù)據(jù)都將被rot13過(guò)濾器處理，我們讀出的數(shù)據(jù)就和寫(xiě)入的原始數(shù)據(jù)是一致的。

你可能會(huì)奇怪stream_filter_append中的 "string.rot13"這個(gè)變量來(lái)的莫名其妙，這實(shí)際上是PHP內(nèi)置的一個(gè)過(guò)濾器。

使用下面的方法即可打印出PHP內(nèi)置的流：

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

輸出：

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

自然而然，我們會(huì)想到定義自己的過(guò)濾器，這個(gè)也不難：

class md5_filter extends php_user_filter
{
 function filter($in, $out, &$consumed, $closing)
 {
   while ($bucket = stream_bucket_make_writeable($in))
   {
     $bucket->data = md5($bucket->data);
     $consumed += $bucket->datalen;
     stream_bucket_append($out, $bucket);
   }
   //數(shù)據(jù)處理成功，可供其它管道讀取
   return PSFS_PASS_ON;
 }
}
stream_filter_register("string.md5", "md5_filter");

注意：過(guò)濾器名可以隨意取。

之后就可以使用"string.md5"這個(gè)我們自定義的過(guò)濾器了。

這個(gè)過(guò)濾器的寫(xiě)法看起來(lái)很是有點(diǎn)摸不著頭腦，事實(shí)上我們只需要看一下php_user_filter這個(gè)類(lèi)的結(jié)構(gòu)和內(nèi)置方法即了解了。

過(guò)濾器流最適合做的就是文件格式轉(zhuǎn)換了，包括壓縮，編解碼等，除了這些“偏門(mén)”的用法外，filter流更有用的一個(gè)地方在于調(diào)試和日志功能，比如說(shuō)在socket開(kāi)發(fā)中，注冊(cè)一個(gè)過(guò)濾器流進(jìn)行l(wèi)og記錄。比如下面的例子：

class md5_filter extends php_user_filter
{
 public function filter($in, $out, &$consumed, $closing)
 {
   $data="";
   while ($bucket = stream_bucket_make_writeable($in))
   {
     $bucket->data = md5($bucket->data);
     $consumed += $bucket->datalen;
     stream_bucket_append($out, $bucket);
   }
   call_user_func($this->params, $data);
   return PSFS_PASS_ON;
 }
}
$callback = function($data)
{
 file_put_contents("c:\log.txt",date("Y-m-d H:i")."\r\n");
};

這個(gè)過(guò)濾器不僅可以對(duì)輸入流進(jìn)行處理，還能回調(diào)一個(gè)函數(shù)來(lái)進(jìn)行日志記錄。

可以這么使用：

復(fù)制代碼代碼如下:

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

PHP中的stream流系列函數(shù)中還有一個(gè)很重要的流，就是包裝類(lèi)流 streamWrapper。使用包裝流可以使得不同類(lèi)型的協(xié)議使用相同的接口操縱數(shù)據(jù)。這個(gè)以后再說(shuō)。

以上所述就是本文的全部?jī)?nèi)容了，希望大家能夠喜歡。

您可能感興趣的文章: