PHPにおけるストリームの概念と使い方

Stream は、PHP 開発において最も見落とされがちな関数シリーズ (SPL シリーズ、Stream シリーズ、パック関数、パッケージ化プロトコル) の 1 つですが、非常に便利で重要な関数です。 Java では、ストリームは「ストリーム」と訳されることがあり、非常に重要な概念です。

ストリームの概念は、UNIX のパイプの概念に由来します。 UNIX では、パイプは中断のないバイト ストリームであり、プログラムまたはプロセス間の通信を実装したり、周辺デバイスや外部ファイルなどの読み書きに使用されます。ストリームの方向に応じて、入力ストリームと出力ストリームに分割することができ、同時にバッファ ストリームなどの他のストリームを周囲に配置して、より多くのストリーム処理方法を取得できます。

PHP のストリームと Java のストリームは実際には同じ概念ですが、少し単純になっています。 PHP は主に Web 開発に使用されるため、「フロー」という概念が言及されることはほとんどありません。 Java の基盤がある場合は、PHP のストリームを理解するのが簡単になります。実際、SPL、例外、フィルターなど、PHP の多くの高度な機能はすべて 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 と同じです。一方、この例は、以下で説明するフィルター フローフィルターにも役立ちます。実際、それはデザインパターンの現れでもあります。

まず、いくつかの例を通してストリーム系列関数の使用法を理解します。

以下は、ソケットを使用してデータをキャプチャする例です:

$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);

もう一度ストリームの例を見てください:

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);

3 番目のパラメーター $context は HTTP ストリーム コンテキストであり、file_get_contents 関数に接続されたパイプとして理解できることに注意してください。同様に、FTP ストリームとソケット ストリームを作成し、対応する関数に設定することもできます。

stream_context_create の詳細については、「PHP 関数の完了: stream_context_create() は POST/GET をシミュレートする」を参照してください。

上記の 2 つのストリーム シリーズ関数は、特定のプロトコルの入力ストリームと出力ストリームに作用するラッパーのようなストリームです。この種の使用法と概念は、実際には Java のストリームとあまり変わりません。たとえば、Java では次のような記述方法がよくあります。

フィルター ストリームの役割を見てみましょう:

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

上の例では、フィルター タイプを STREAM_FILTER_ALL に設定すると、読み取りストリームと書き込みストリームに同時に作用し、すべての読み取りストリームと書き込みストリームが処理されます。データは rot13 になります。 フィルタ処理後、読み取られたデータは書き込まれた元のデータと一致します。

stream_filter_append の変数「string.rot13」がどこからともなく出てきたことに驚かれるかもしれません。これは実際には PHP に組み込まれたフィルターです。

次のメソッドを使用して PHP 組み込みストリームを出力します:

$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

出力:

$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.*
)

注: フィルター名は次のとおりです。自由に選択します。

その後、カスタムフィルター「string.md5」を使用できるようになります。

このフィルターの書き方は少しわかりにくいように思えますが、実際には、php_user_filter クラスの構造と組み込みメソッドを確認するだけで理解できます。

フィルター ストリームに最も適しているのは、圧縮、エンコード、デコードなどのファイル形式の変換です。これらの「逸脱した」使用法に加えて、フィルター ストリームのより便利な側面の 1 つは、次のようなデバッグ機能とログ機能です。ソケットの開発、ログ記録用のフィルター ストリームを登録します。たとえば、次の例:

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");
};

PHP の一連の関数のストリームには、ラッパー クラス ストリーム streamWrapper という非常に重要なストリームもあります。ラッパー ストリームを使用すると、さまざまなタイプのプロトコルが同じインターフェイスを使用してデータを操作できるようになります。