了解PHP中Stream(流)的概念與用法
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 directoryFilenameFilter 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.1rn';$out.='Host: typecho.orgrn';$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'.'rn';$out.='Content-type: application/x-www-form-urlencodedrn';$out.='PHPSESSID=082b0cc33cc7e6df1f87502c456c3eb0rn';$out.='Content-Length: ' . strlen($data) . 'rn';$out.='Connection: closernrn';$out.=$data.'rnrn';fwrite($fp, $out);while (!feof($fp)){ echo fgets($fp, 1280);}fclose($fp);
我們也可以用stream_socket 實現,這很簡單,只需要打開socket的代碼換成下面的即可:
$fp = stream_socket_client('tcp://nowamagic.net:80', $errno, $errstr, 3);
再來看一個stream的例子:
file_get_contents函數一般常用來讀取文件內容,但這個函數也可以用來抓取遠程url,起到和curl類似的作用。
$opts = array (’http’=>array( ’method’ => ’POST’, ’header’=> 'Content-type: application/x-www-form-urlencodedrn' . 'Content-Length: ' . strlen($data) . 'rn', ’content’ => $data));$context = stream_context_create($opts);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中經常有這樣的寫法:
new DataOutputStream(new BufferedOutputStream(new FileOutputStream(new File(fileName))));
一層流嵌套著另外一層流,和PHP里有異曲同工之妙。
我們再來看個過濾器流的作用:
$fp = fopen(’c:/test.txt’, ’w+’);/* 把rot13過濾器作用在寫入流上 */stream_filter_append($fp, 'string.rot13', STREAM_FILTER_WRITE);/* 寫入的數據經過rot13過濾器的處理*/fwrite($fp, 'This is a testn');rewind($fp);/* 讀取寫入的數據,獨到的自然是被處理過的字符了 */fpassthru($fp);fclose($fp);// output:Guvf vf n grfg
在上面的例子中,如果我們把過濾器的類型設置為STREAM_FILTER_ALL,即同時作用在讀寫流上,那么讀寫的數據都將被rot13過濾器處理,我們讀出的數據就和寫入的原始數據是一致的。
你可能會奇怪stream_filter_append中的 'string.rot13'這個變量來的莫名其妙,這實際上是PHP內置的一個過濾器。
使用下面的方法即可打印出PHP內置的流:
$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.*)
自然而然,我們會想到定義自己的過濾器,這個也不難:
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');
注意:過濾器名可以隨意取。
之后就可以使用'string.md5'這個我們自定義的過濾器了。
這個過濾器的寫法看起來很是有點摸不著頭腦,事實上我們只需要看一下php_user_filter這個類的結構和內置方法即了解了。
過濾器流最適合做的就是文件格式轉換了,包括壓縮,編解碼等,除了這些“偏門”的用法外,filter流更有用的一個地方在于調試和日志功能,比如說在socket開發中,注冊一個過濾器流進行log記錄。比如下面的例子:
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').'rn');};
這個過濾器不僅可以對輸入流進行處理,還能回調一個函數來進行日志記錄。
可以這么使用:
stream_filter_prepend($fp, 'string.md5', STREAM_FILTER_WRITE,$callback);
PHP中的stream流系列函數中還有一個很重要的流,就是包裝類流 streamWrapper。使用包裝流可以使得不同類型的協議使用相同的接口操縱數據。這個以后再說。
相關文章: