php中Stream（流）的概念與用法
- 伊谢尔伦原創
- 2016-11-25 11:56:33921瀏覽
Stream是PHP開發裡最容易被忽略的函數係列（SPL係列，Stream系列，pack函數，封裝協定）之一，但其是個很有用且很重要的函數。 Stream可以翻譯為“流”，在Java裡，流是一個很重要的概念。
流(stream)的概念源自於UNIX中管道(pipe)的概念。在UNIX中，管道是一條不間斷的位元組流，用來實現程式或進程間的通信，或讀寫外圍設備、外部文件等。根據流的方向又可以分為輸入流和輸出流，同時可以在其外圍再套上其它流，例如緩衝流，這樣就可以得到更多流處理方法。
PHP裡的流和Java裡的流其實是同一個概念，只是簡單了一點。由於PHP主要用於Web開發，所以「流」這塊的概念被提及的較少。如果有Java基礎，對於PHP裡的流就更容易理解了。其實PHP裡的許多高階特性，像是SPL，異常，濾鏡等都參考了Java的實現，在理念和原理上同出一轍。
例如下面是一段PHP SPL標準庫的用法（遍歷目錄，查找固定條件的文件）：
class RecursiveFileFilterIterator extends FilterIterator
{
// 满足条件的扩展名
protected $ext = array('jpg','gif');
/**
* 提供 $path 并生成对应的目录迭代器
*/
public function __construct($path)
{
parent::__construct(new RecursiveIteratorIterator(new RecursiveDirectoryIterator($path)));
}
/**
* 检查文件扩展名是否满足条件
*/
public function accept()
{
$item = $this->getInnerIterator();
if ($item->isFile() && in_array(pathinfo($item->getFilename(), PATHINFO_EXTENSION), $this->ext))
{
return TRUE;
}
}
}
// 实例化
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());
}
}
}舉這個例子，一方面是說明PHP和Java在很多方面的概念是一樣的，掌握一種語言對理解另一門語言會有很大的幫助；另一方面，這個例子也有助於我們下面要提到的過濾器流-filter。其實也是一種設計模式的體現。
我們可以透過幾個例子先來了解stream系列函數的使用。
下面是一個使用socket來抓取資料的例子：
$post_ =array (
'author' => 'Gonn',
'mail'=>'gonn@nowamagic.net',
'url'=>'http://www.nowamagic.net/',
'text'=>'欢迎访问简明现代魔法');
$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來抓取資料的例子：
$fp = stream_socket_client("tcp://nowamagic.net:80", $errno, $errstr, 3);我們也可以用stream_socket 實現，這很簡單，只需要打開socket的程式碼換成下面的即可：
file_get_contents函数一般常用来读取文件内容，但这个函数也可以用来抓取远程url，起到和curl类似的作用。
$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);再來看一個stream的例子：
new DataOutputStream(new BufferedOutputStream(new FileOutputStream(new File(fileName))));
注意第三個參數，$context，即HTTP流上下文，可以理解為套在file_get_contents函數上的一根管道。同理，我們也可以創造FTP流，socket流，並把其套在對應的函數在。
更多關於 stream_context_create，可以參考：PHP函數補完：stream_context_create()模擬POST/GET。
上面提到的兩個stream系列的函數都是類似包裝器的流，作用在某種協定的輸入輸出流上。這樣的使用方式和概念，其實和Java中的流並沒有大的區別，例如Java中常有這樣的寫法：
$fp = fopen('c:/test.txt', 'w+'); /* 把rot13过滤器作用在写入流上 */ stream_filter_append($fp, "string.rot13", STREAM_FILTER_WRITE); /* 写入的数据经过rot13过滤器的处理*/ fwrite($fp, "This is a test\n"); rewind($fp); /* 读取写入的数据，独到的自然是被处理过的字符了 */ fpassthru($fp); fclose($fp); // output：Guvf vf n grfg
一層流嵌套著另外一層流，和PHP裡有異曲同工之妙。
我們再來看個過濾器流的作用：
$streamlist = stream_get_filters(); print_r($streamlist);
在上面的例子中，如果我們把過濾器的類型設定為STREAM_FILTER_ALL，即同時作用在讀寫流上，那麼讀寫的數據都將被rot13過濾器處理，我們讀出的資料就和寫入的原始資料是一致的。
你可能會奇怪stream_filter_append中的 "string.rot13"這個變數來的莫名其妙，這其實是PHP內建的一個過濾器。
使用下面的方法即可列印出PHP內建的流：
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.*
)輸出：
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);
}
//数据处理成功，可供其它管道读取
return PSFS_PASS_ON;
}
}
stream_filter_register("string.md5", "md5_filter");自然而然，我們會想到定義自己的過濾器，這個也不難：
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");
};注意：過濾器名稱可以隨意取。
之後就可以使用"string.md5"這個我們自訂的濾鏡了。
這個過濾器的寫法看起來很是有點摸不著頭腦，事實上我們只需要看一下php_user_filter這個類別的結構和內建方法即了解了。
過濾器流最適合做的就是文件格式轉換了，包括壓縮，編解碼等，除了這些「偏門」的用法外，filter流更有用的一個地方在於調試和日誌功能，比如說在socket開發中，註冊一個過濾器流進行log記錄。例如下面的例子：
stream_filter_prepend($fp, "string.md5", STREAM_FILTER_WRITE,$callback);
這個過濾器不僅可以對輸入流進行處理，還能回呼一個函數來進行日誌記錄。
可以這麼使用：
rrreee🎜PHP中的stream流系列函數中還有一個很重要的流，就是包裝類別流 streamWrapper。使用包裝流可以使得不同類型的協定使用相同的介面操縱資料。 🎜