深入理解PHP中的流(stream)

Streams
是PHP提供的一个强有力的工具,我们常常在不经意会使用到它,如果善加利用将大大提高PHP的生产力。
驾驭Streams的强大力量后,应用程序将提升到一个新的高度。

之前我和同事业余时间做过单位内部使用的订餐App,我给ios端提供数据接口,当时无法直接使用PHP的$_POST获取ios发送的数据,必须使用php中的流php://input才能获取到(当然Java调整传输类型也能做到),当时只是把问题解决了,没有深入了解流,今天我们梳理一下。PHP官方的介绍比较难理解,我从网上找了好多关于流的介绍和使用,也结合java中的流的概念帮助理解(php好多思想是借鉴java的)。

PHP
Streams是内置核心操作,可能一般的开发者很少用,它用于统一文件、网络、数据压缩等类文件操作方式,并为这些类文件操作提供一组通用的函数接口。

奥门新浦京官方网站 1

流是什么:

一个stream就是一个具有流式行为的资源对象,每个stream对象都有一个包装类。Stream
可以通过://方式来引用。其中是包装类的名字,中的内容是由包装类的语法指定,不同的包装类的语法会有所不同。
来看看PHP 默认有哪些内置的包装类:

下面是PHP手册中对Streams的一段描述:

流是个抽象的概念,是对输入输出设备的抽象,Java程序中,对于数据的输入/输出操作都是以“流”的方式进行,设备可以是文件,网络,内存等。

print_r(stream_get_wrappers());
/*
Array
(
  [0] => php
  [1] => file
  [2] => glob
  [3] => data
  [4] => http
  [5] => ftp
  [6] => zip
  [7] => compress.zlib
  [8] => https
  [9] => ftps
  [10] => phar
)
*/

Streams 是在PHP
4.3.0版本被引入的,它被用于统一文件、网络、数据压缩等类文件的操作方式,为这些类文件操作提供了一组通用的函数接口。简而言之,一个stream就是一个具有流式行为的资源对象。也就是说,我们可以用线性的方式来对stream进行读取和写入。并且可以用使用fseek()来跳转到stream内的任意位置。

 

看看PHP手册中关于PHP支持的协议和包装类。
看下面一段使用file_get_contents()获取数据的代码:

每个Streams对象都有一个包装类,在包装中可以添加处理特殊协议和编码的相关代码。PHP中已经内置了一些常用的包装类,我们也可以创建和注册自定义的包装类。我们甚至能够使用现有的context和filter对包装类进行修改和增强。

奥门新浦京官方网站 2

/* Read local file from /home/bar */
 $localfile = file_get_contents ( "/home/bar/foo.txt" );

 /* Identical to above, explicitly naming FILE scheme */
 $localfile = file_get_contents ( "file:///home/bar/foo.txt" );

 /* Read remote file from www.example.com using HTTP */
 $httpfile  = file_get_contents ( "http://www.example.com/foo.txt" );

 /* Read remote file from www.example.com using HTTPS */
 $httpsfile = file_get_contents ( "https://www.example.com/foo.txt" );

 /* Read remote file from ftp.example.com using FTP */
 $ftpfile  = file_get_contents ( "ftp://user:pass@ftp.example.com/foo.txt" );

 /* Read remote file from ftp.example.com using FTPS */
 $ftpsfile  = file_get_contents ( "ftps://user:pass@ftp.example.com/foo.txt" );

Stream 基础知识

Stream
可以通过<scheme>://<target>方式来引用。其中<scheme>是包装类的名字,<target>中的内容是由包装类的语法指定,不同的包装类的语法会有所不同。

PHP默认的包装类是file://,也就是说我们在访问文件系统的时候,其实就是在使用一个stream。我们可以通过下面两种方式来读取文件中的内容,readfile(‘/path/to/somefile.txt’)或者readfile(‘file:///path/to/somefile.txt’),这两种方式是等效的。如果你是使用readfile(‘
stream包装类来进行操作。

正如上文所述,PHP提供了不少内建的包转类,protocol以及filter。
按照下文所述的方式,可以查询到本机所支持的包装类:

<?php
print_r(stream_get_transports());
print_r(stream_get_wrappers());
print_r(stream_get_filters());

在我机器上的输出结果为:

Array
(
    [0] => tcp
    [1] => udp
    [2] => unix
    [3] => udg
    [4] => ssl
    [5] => sslv3
    [6] => sslv2
    [7] => tls
)
Array
(
    [0] => https
    [1] => ftps
    [2] => compress.zlib
    [3] => compress.bzip2
    [4] => php
    [5] => file
    [6] => glob
    [7] => data
    [8] => http
    [9] => ftp
    [10] => zip
    [11] => phar
)
Array
(
    [0] => zlib.*
    [1] => bzip2.*
    [2] => convert.iconv.*
    [3] => string.rot13
    [4] => string.toupper
    [5] => string.tolower
    [6] => string.strip_tags
    [7] => convert.*
    [8] => consumed
    [9] => dechunk
    [10] => mcrypt.*
    [11] => mdecrypt.*
)

提供的功能非常多,看上去还不错吧?

除了上述内建的Stream,我们还可以为 Amazon
S3, MS
Excel, Google
Storage, Dropbox 甚至Twitter编写更多的第三方的Stream。

 

实际上readfile(‘/path/to/somefile.txt’)或者readfile(‘file:///path/to/somefile.txt’),这两种方式是等效的。因为PHP的默认包装类就是file://。

php:// 包装类

PHP中内建了本语言用于处理I/O
stream的包装类。可以分为几类,基础的有php://stdin,php://stdout,
以及php://stderr,这3个stream分别映射到默认
的I/O资源。同时PHP还提供了php://input,通过这个包装类可以使用只读的方式访问POST请求中的raw
body。
这是一项非常有用的功能,特别是在处理那些将数据负载嵌入到POST请求中的远程服务时。

下面我们使用cURL工具来做一个简单的测试:

curl -d "Hello World" -d "foo=bar&#038;name=John" http://localhost/dev/streams/php_input.php

在PHP脚本中使用print_r($_POST)的测试结果如下所示:

Array
(
    [foo] => bar
    [name] => John
)

我们注意$_POST
array中是无法访问到第一项数据的。但是如果我们使用readfile(‘php://input’),结果就不同了:

Hello World&#038;foo=bar&#038;name=John

PHP
5.1又增加了php://memory和php://tempstream这两个包转类,用于读写临时数据。正如包装类命名中所暗示的,这些数据被存储在底层系统中的内存或者临时文件中。

php://filter是一个元包装类,用于为stream增加filter功能。在使用readfile()或者file_get_contents()/stream_get_contents()打开stream时,filter将被使能。下面是一个例子:

<?php
// Write encoded data
file_put_contents("php://filter/write=string.rot13/resource=file:///path/to/somefile.txt","Hello World");

// Read data and encode/decode
readfile("php://filter/read=string.toupper|string.rot13/resource=http://www.google.com");

在第一个例子中使用了一个filter来对保存到磁盘中的数据进行编码处理,在二个例子中,使用两个级联的filter来从远端的URL读取数据。使用filter能为你的应用带来极为强大的功能。

流具有方向性,至于是输入流还是输出流则是一个相对的概念,一般以程序为参考,如果数据的流向是程序至设备,我们成为输出流,反之我们称为输入流。

 手册上明确指出,可以通过stream_register_wrapper()注册自己的包装器
,可以去看看手册中的例子。
 OK,这里简单介绍一个PHP://,它是PHP用来处理IO流的包装类(点击这里看个例子)。通过PHP://可以访问更强大的输入输出流:

Stream上下文

context是一组stream相关的参数或选项,使用context可以修改或增强包装类的行为。例如使用context来修改HTTP包装器是一个常用到的使用场景。
这样我们就可以不使用cURL工具,就能完成一些简单的网络操作。下面是一个例子:

<?php
$opts = array(
  'http'=>array(
    'method'=>"POST",
    'header'=> "Auth: SecretAuthTokenrn" .
        "Content-type: application/x-www-form-urlencodedrn" .
              "Content-length: " . strlen("Hello World"),
    'content' => 'Hello World'
  )
);
$default = stream_context_get_default($opts);
readfile('http://localhost/dev/streams/php_input.php');

首先要定义一个options
array,这是个二位数组,可以通过$array[‘wrapper’][‘option_name’]的形式来访问其中的参数。(注意每个包装类中context的options是不同的)。然后调用stream_context_get_default()来设置这些option,stream_context_get_default()同时还会将默认的context作为结果返回回来。设置完成后,接下来调用readfile(),就会应用刚才设置好的context来抓取内容。

在上面的例子中,内容被嵌入到request的body中,这样远端的脚本就可以使用php://input来读取这些内容。同时,我们还能使用apache_request_headers()来获取request的header,如下所示:

Array
(
    [Host] => localhost
    [Auth] => SecretAuthToken
    [Content-type] => application/x-www-form-urlencoded
    [Content-length] => 11
)

在上面的例子中是修改默认context的参数,当然我们也可以创建一个新的context,进行交替使用。

<?php
$alternative = stream_context_create($other_opts);
readfile('http://localhost/dev/streams/php_input.php', false, $alternative);

当程序需要从某个数据源读入数据的时候,就会开启一个输入流,数据源可以是文件、内存或网络等等。相反地,需要写出数据到某个数据源目的地的时候,也会开启一个输出流,这个数据源目的地也可以是文件、内存或网络等等。

php://stdin:访问PHP进程相应的输入流,比如用在获取cli执行脚本时的键盘输入。
php://stdout:访问PHP进程相应的输出流。
php://stderr:访问PHP进程相应的错误输出。
php://input:访问请求的原始数据的只读流。
php://output:只写的数据流,以 print 和 echo 一样的方式写入到输出区。
php://fd:允许直接访问指定的文件描述符。例 php://fd/3 引用了文件描述符
3。
php://memory:允许读写临时数据。 把数据储存在内存中。
php://temp:同上,会在内存量达到预定义的限制后(默认是
2MB)存入临时文件中。
php://filter:过滤器。

结论

我们怎样在现实世界中驾驭stream的强大力量呢?使用stream能为我们的程序带来什么现实的好处?
正如前文介绍的那样,stream对所有文件系统相关的功能进行了抽象,所以我第一个想到的应用场景是使用虚拟文件系统的包装类来访问PaaS供应商提供的服务,比如说访问HeroKu或者AppFog,它们实际上都没有真正文件系统。
使用stream只要对我们的应用程序稍作修改,就可以将其移植到云端。
接下来–在我的下一篇文章中–我将介绍如何编写自定义的包装类以实现对特殊文件格式和编码格式的操作。

奥门新浦京官方网站 3

PHP还可以通过context和filter对包装类进行修饰和增强。
(1)关于context,如PHP通过stream_context_create()来设置获取文件超时时间,这段代码大家肯定用过:

 

$opts = array(
  'http'=>array(
    'method'=>"GET",
    'timeout'=>60,
  )
);
$context = stream_context_create($opts);
$html =file_get_contents('http://www.jb51.net', false, $context);

 

 (2)关于filter过滤器,首先来看看PHP有哪些内置的过滤器:

PHP中对流的描述如下:
每一种流都实现了一个包装器(wrapper),包装器包含一些额外的代码用来处理特殊的协议和编码。PHP提供了一些内置的包装器,我们也可以很轻松的创建和注册自定义的包装器。我们甚至可以使用上下文(contexts)和过滤器来改变和增强包装器。

print_r(stream_get_filters());
/*
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.*
)
*/

奥门新浦京官方网站,PHP中流的形式:<scheme>://<target>。其中<scheme>是包装器的名字,<target>中的内容是由包装器的语法指定,不同的包装器的语法会有所不同。

 通过stream_filter_register()和内置的php_user_filter可创建自定义的过滤器,如下:

默认的包装器是file://,也就是说每次我们访问文件系统的时候都使用了流。例如,我们可以使用如下两种方式来读取文件:readfile(‘/path/to/somefile.txt’)和readfile(‘file:///path/to/somefile.txt’),使用这两种方式读取文件,可以得到相同的结果。

/* Define our filter class */
class strtoupper_filter extends php_user_filter {
  function filter ( $in , $out , & $consumed , $closing )
  {
    while ( $bucket = stream_bucket_make_writeable ( $in )) {
      $bucket -> data = strtoupper ( $bucket -> data );
      $consumed += $bucket -> datalen ;
      stream_bucket_append ( $out , $bucket );
    }
    return PSFS_PASS_ON ;
  }
}

/* Register our filter with PHP */
stream_filter_register ( "strtoupper" , "strtoupper_filter" )
or die( "Failed to register filter" );

$fp = fopen ( "foo-bar.txt" , "w" );

/* Attach the registered filter to the stream just opened */
stream_filter_append ( $fp , "strtoupper" );

fwrite ( $fp , "Line1n" );
fwrite ( $fp , "Word - 2n" );
fwrite ( $fp , "Easy As 123n" );

fclose ( $fp );


readfile ( "foo-bar.txt" );
/*
结果如下:
LINE1
WORD - 2
EASY AS 123
*/

正如前面所说,PHP提供了一些内置的包装器、协议和过滤器。查看我们的机器上安装了哪些包装器,可以使用如下几个函数:
<?php
var_dump(stream_get_transports()); 

提供PHP中streams函数列表如下:

// 获取已注册的套接字传输协议列表 
array(7) {
  [0]=>
  string(3) “tcp”
  [1]=>
  string(3) “udp”
  [2]=>
  string(4) “unix”
  [3]=>
  string(3) “udg”
  [4]=>
  string(3) “ssl”
  [5]=>
  string(5) “sslv3”
  [6]=>
  string(3) “tls”
}

stream_bucket_append函数:为队列添加数据 
stream_bucket_make_writeable函数:从操作的队列中返回一个数据对象
stream_bucket_new函数:为当前队列创建一个新的数据
stream_bucket_prepend函数:预备数据到队列 
stream_context_create函数:创建数据流上下文
stream_context_get_default函数:获取默认的数据流上下文
stream_context_get_options函数:获取数据流的设置
stream_context_set_option函数:对数据流、数据包或者上下文进行设置
stream_context_set_params函数:为数据流、数据包或者上下文设置参数
stream_copy_to_stream函数:在数据流之间进行复制操作
stream_filter_append函数:为数据流添加过滤器
stream_filter_prepend函数:为数据流预备添加过滤器
stream_filter_register函数:注册一个数据流的过滤器并作为PHP类执行
stream_filter_remove函数:从一个数据流中移除过滤器
stream_get_contents函数:读取数据流中的剩余数据到字符串
stream_get_filters函数:返回已经注册的数据流过滤器列表
stream_get_line函数:按照给定的定界符从数据流资源中获取行
stream_get_meta_data函数:从封装协议文件指针中获取报头/元数据
stream_get_transports函数:返回注册的Socket传输列表
stream_get_wrappers函数:返回注册的数据流列表
stream_register_wrapper函数:注册一个用PHP类实现的URL封装协议
stream_select函数:接收数据流数组并等待它们状态的改变
stream_set_blocking函数:将一个数据流设置为堵塞或者非堵塞状态
stream_set_timeout函数:对数据流进行超时设置
stream_set_write_buffer函数:为数据流设置缓冲区
stream_socket_accept函数:接受由函数stream_ socket_server()创建的Socket连接
stream_socket_client函数:打开网络或者UNIX主机的Socket连接
stream_socket_enable_crypto函数:为一个已经连接的Socket打开或者关闭数据加密
stream_socket_get_name函数:获取本地或者网络Socket的名称
stream_socket_pair函数:创建两个无区别的Socket数据流连接
stream_socket_recvfrom函数:从Socket获取数据,不管其连接与否
stream_socket_sendto函数:向Socket发送数据,不管其连接与否
stream_socket_server函数:创建一个网络或者UNIX Socket服务端
stream_wrapper_restore函数:恢复一个事先注销的数据包
stream_wrapper_unregister函数:注销一个URL地址包

var_dump(stream_get_wrappers());
// 获取已注册的流类型
array(12) {
  [0]=>
  string(5) “https”
  [1]=>
  string(4) “ftps”
  [2]=>
  string(13) “compress.zlib”
  [3]=>
  string(14) “compress.bzip2”
  [4]=>
  string(3) “php”
  [5]=>
  string(4) “file”
  [6]=>
  string(4) “glob”
  [7]=>
  string(4) “data”
  [8]=>
  string(4) “http”
  [9]=>
  string(3) “ftp”
  [10]=>
  string(4) “phar”
  [11]=>
  string(3) “zip”
}

var_dump(stream_get_filters()); 
// 获取已注册的数据流过滤器列表
array(12) {
  [0]=>
  string(6) “zlib.*”
  [1]=>
  string(7) “bzip2.*”
  [2]=>
  string(15) “convert.iconv.*”
  [3]=>
  string(12) “string.rot13”
  [4]=>
  string(14) “string.toupper”
  [5]=>
  string(14) “string.tolower”
  [6]=>
  string(17) “string.strip_tags”
  [7]=>
  string(9) “convert.*”
  [8]=>
  string(8) “consumed”
  [9]=>
  string(7) “dechunk”
  [10]=>
  string(8) “mcrypt.*”
  [11]=>
  string(10) “mdecrypt.*”
}

另外,我们可以自定义或者使用第三方的流。

php://包装器
PHP有它自己的访问输入/输出(I/O)流的包装器。PHP有基本的php://stdin,php://stdout,php://stderr包装器对应默认的I/O资源。还有一个php://input流,它是一个只读的流,流内容是post请求的数据。当我们将数据放在一个post请求的body体内用来请求一个远程服务的时候,这个流特别好用。

因为php://input是最常用到的流,所以这里列出一些知识点:
1.php://input可以读取没有处理过的POST数据。相较于$HTTP_RAW_POST_DATA而言,它给内存带来的压力较小,并且不需要特殊的php.ini设置。php://input不能用于enctype=multipart/form-data

2.仅当Content-Type为application/x-www-form-urlencoded且提交方法是POST方法时,$_POST数据与php://input数据才是”一致”(打上引号,表示它们格式不一致,内容一致)的。其它情况,它们都不一致

3.php://input读取不到GET数据。是因为_GET数据作为query_path写在http请求头部(header)的PATH字段,而不是写在http请求的body部分。

流上下文(Stream Contexts)
PHP还可以通过context和filter对包装类进行修饰和增强。
(1)关于context,如PHP通过stream_context_create()来设置获取文件超时时间,这段代码大家肯定用过:
<?php
    $opts = array(
      ‘http’=>array(
        ‘method’=>”GET”,
        ‘timeout’=>60,
      )
    );
    $context = stream_context_create($opts);
    $html =file_get_contents(”, false,
$context);
?>

(2)关于filter过滤器,首先来看看PHP有哪些内置的过滤器:
    print_r(stream_get_filters());

 

提供PHP中streams函数列表如下:
stream_bucket_append函数:为队列添加数据 
stream_bucket_make_writeable函数:从操作的队列中返回一个数据对象
stream_bucket_new函数:为当前队列创建一个新的数据
stream_bucket_prepend函数:预备数据到队列 
stream_context_create函数:创建数据流上下文
stream_context_get_default函数:获取默认的数据流上下文
stream_context_get_options函数:获取数据流的设置
stream_context_set_option函数:对数据流、数据包或者上下文进行设置
stream_context_set_params函数:为数据流、数据包或者上下文设置参数
stream_copy_to_stream函数:在数据流之间进行复制操作
stream_filter_append函数:为数据流添加过滤器
stream_filter_prepend函数:为数据流预备添加过滤器
stream_filter_register函数:注册一个数据流的过滤器并作为PHP类执行
stream_filter_remove函数:从一个数据流中移除过滤器
stream_get_contents函数:读取数据流中的剩余数据到字符串
stream_get_filters函数:返回已经注册的数据流过滤器列表
stream_get_line函数:按照给定的定界符从数据流资源中获取行
stream_get_meta_data函数:从封装协议文件指针中获取报头/元数据
stream_get_transports函数:返回注册的Socket传输列表
stream_get_wrappers函数:返回注册的数据流列表
stream_register_wrapper函数:注册一个用PHP类实现的URL封装协议
stream_select函数:接收数据流数组并等待它们状态的改变
stream_set_blocking函数:将一个数据流设置为堵塞或者非堵塞状态
stream_set_timeout函数:对数据流进行超时设置
stream_set_write_buffer函数:为数据流设置缓冲区
stream_socket_accept函数:接受由函数stream_
socket_server()创建的Socket连接
stream_socket_client函数:打开网络或者UNIX主机的Socket连接
stream_socket_enable_crypto函数:为一个已经连接的Socket打开或者关闭数据加密
stream_socket_get_name函数:获取本地或者网络Socket的名称
stream_socket_pair函数:创建两个无区别的Socket数据流连接
stream_socket_recvfrom函数:从Socket获取数据,不管其连接与否
stream_socket_sendto函数:向Socket发送数据,不管其连接与否
stream_socket_server函数:创建一个网络或者UNIX Socket服务端
stream_wrapper_restore函数:恢复一个事先注销的数据包
stream_wrapper_unregister函数:注销一个URL地址包

 

发表评论

电子邮件地址不会被公开。 必填项已用*标注