同学们，老司机发车了！今天咱们聊聊PHP里一个挺酷炫的东西：Stream Wrappers，中文名儿可以叫“流包装器”，听着就带劲儿！这玩意儿能让你像变魔术一样，定制PHP处理文件、网络连接等等I/O操作的方式。
1. 啥是Stream Wrappers？为什么要用它？
想象一下，你用fopen()打开一个文件，或者用file_get_contents()读取一个网页，这些操作背后都用到了PHP的“流”机制。Stream Wrappers 就是“流”的“外挂”，让你能插手这些“流”的运作过程，实现各种奇葩但有用的功能。
简单来说，Stream Wrappers 允许你：
- 自定义协议： 不再局限于
http://、ftp://、file://这些内置协议，可以创造自己的协议，比如myprotocol://。 - 拦截和修改 I/O 操作： 在读取、写入、打开、关闭等操作发生时，你可以做一些手脚，比如自动加密解密、数据转换、访问控制等等。
- 虚拟文件系统： 模拟出一个文件系统，数据可以来自数据库、内存、云存储，而不是硬盘。
举个栗子：
假设你想做一个自动压缩解压缩文件的功能，每次读取.gz文件自动解压，写入时自动压缩。有了Stream Wrappers，你就可以创建一个gz_auto://协议，让PHP像操作普通文件一样操作压缩文件，底层的压缩解压缩都由你的Stream Wrapper搞定。
2. 如何创建自己的Stream Wrapper？
创建一个Stream Wrapper，你需要定义一个类，实现一系列特定的方法。这些方法对应于PHP对“流”的各种操作。
核心方法（必须实现）：
| 方法名 | 作用 |
|---|---|
stream_open() |
打开流（相当于fopen()） |
stream_read() |
从流中读取数据（相当于fread()） |
stream_write() |
向流中写入数据（相当于fwrite()） |
stream_close() |
关闭流（相当于fclose()） |
stream_eof() |
检查是否到达流的末尾（相当于feof()） |
url_stat() |
获取URL的信息，比如文件大小、修改时间等（相当于stat()、file_exists()） |
其他常用方法（可选实现）：
| 方法名 | 作用 |
|---|---|
stream_cast() |
将流转换为资源类型（不常用） |
stream_flush() |
刷新流的缓冲区（相当于fflush()） |
stream_lock() |
对流进行加锁/解锁（相当于flock()） |
stream_seek() |
在流中定位到指定位置（相当于fseek()） |
stream_set_option() |
设置流的选项（不常用） |
stream_tell() |
返回流的当前位置（相当于ftell()） |
unlink() |
删除URL指向的文件（相当于unlink()） |
rename() |
重命名URL指向的文件（相当于rename()） |
mkdir() |
创建目录（相当于mkdir()） |
rmdir() |
删除目录（相当于rmdir()） |
dir_opendir() |
打开目录（相当于opendir()） |
dir_readdir() |
读取目录中的条目（相当于readdir()） |
dir_rewinddir() |
重置目录指针（相当于rewinddir()） |
dir_closedir() |
关闭目录（相当于closedir()） |
代码示例：一个简单的uppercase:// Stream Wrapper
这个例子会创建一个uppercase://协议，每次读取文件时，自动将内容转换为大写。
<?php
class UppercaseStream {
private $fp;
public function stream_open(string $path, string $mode, int $options, ?string &$opened_path): bool {
$realPath = substr($path, strlen('uppercase://')); // 去掉协议头
$this->fp = fopen($realPath, $mode);
if ($this->fp === false) {
return false;
}
$opened_path = realpath($realPath); // 设置实际打开的路径
return true;
}
public function stream_read(int $count): string|false {
if (feof($this->fp)) {
return false;
}
$content = fread($this->fp, $count);
if ($content === false) {
return false;
}
return strtoupper($content);
}
public function stream_write(string $data): int|false {
// 不支持写入，直接返回false
return false;
}
public function stream_close(): void {
if (is_resource($this->fp)) {
fclose($this->fp);
}
}
public function stream_eof(): bool {
return feof($this->fp);
}
public function url_stat(string $path, int $flags): array|false {
$realPath = substr($path, strlen('uppercase://'));
if (file_exists($realPath)) {
return stat($realPath);
}
return false;
}
}
// 注册Stream Wrapper
stream_wrapper_register("uppercase", "UppercaseStream")
or die("Failed to register protocol");
// 使用
$content = file_get_contents("uppercase://test.txt"); // test.txt 需先存在
echo $content; // 输出大写的内容
?>代码解释：
UppercaseStream类： 实现了Stream Wrapper的核心方法。stream_open()： 打开底层的文件流，并去掉协议头。stream_read()： 从底层文件流读取数据，转换为大写，然后返回。stream_write()： 这个例子不支持写入，所以直接返回false。stream_close()： 关闭底层的文件流。stream_eof()： 检查底层文件流是否到达末尾。url_stat()： 获取底层文件的信息。stream_wrapper_register()： 将UppercaseStream类注册为uppercase协议的Stream Wrapper。file_get_contents("uppercase://test.txt")： 使用uppercase://协议读取test.txt文件，PHP会自动调用UppercaseStream类的方法来处理I/O操作。
3. 进阶技巧：更多Stream Wrapper的应用
- 加密解密： 创建一个
encrypted://协议，自动加密解密文件内容。 - 数据压缩： 创建一个
gz_auto://协议，自动压缩解压缩文件。 - 访问控制： 创建一个
auth://协议，根据用户权限控制文件访问。 - 虚拟文件系统： 创建一个
database://协议，将数据库中的数据模拟成文件系统。 - 网络代理： 创建一个
proxy://协议，通过代理服务器访问网络资源。
代码示例：一个简单的加密Stream Wrapper（使用XOR加密）
<?php
class EncryptedStream {
private $fp;
private $key;
public function stream_open(string $path, string $mode, int $options, ?string &$opened_path): bool {
$parts = parse_url($path);
$realPath = $parts['path'];
$this->key = $parts['query']; // 从URL中获取密钥
$this->fp = fopen($realPath, $mode);
if ($this->fp === false) {
return false;
}
$opened_path = realpath($realPath);
return true;
}
public function stream_read(int $count): string|false {
if (feof($this->fp)) {
return false;
}
$encrypted = fread($this->fp, $count);
if ($encrypted === false) {
return false;
}
return $this->decrypt($encrypted, $this->key);
}
public function stream_write(string $data): int|false {
$encrypted = $this->encrypt($data, $this->key);
return fwrite($this->fp, $encrypted);
}
public function stream_close(): void {
if (is_resource($this->fp)) {
fclose($this->fp);
}
}
public function stream_eof(): bool {
return feof($this->fp);
}
private function encrypt(string $data, string $key): string {
$encrypted = '';
$keyLength = strlen($key);
for ($i = 0; $i < strlen($data); $i++) {
$encrypted .= chr(ord($data[$i]) ^ ord($key[$i % $keyLength]));
}
return $encrypted;
}
private function decrypt(string $data, string $key): string {
return $this->encrypt($data, $key); // XOR加密解密是相同的操作
}
public function url_stat(string $path, int $flags): array|false {
$parts = parse_url($path);
$realPath = $parts['path'];
if (file_exists($realPath)) {
return stat($realPath);
}
return false;
}
}
stream_wrapper_register("encrypted", "EncryptedStream")
or die("Failed to register protocol");
// 使用
$key = 'mysecretkey';
$filename = 'encrypted://test.txt?'.$key; // 密钥作为URL参数传递
file_put_contents($filename, "This is a secret message."); // 写入加密内容
$content = file_get_contents($filename); // 读取解密内容
echo $content; // 输出 "This is a secret message."
?>代码解释：
EncryptedStream类： 实现了加密和解密的功能。stream_open()： 从URL中解析出密钥。stream_read()： 读取加密后的数据，解密后返回。stream_write()： 将数据加密后写入文件。encrypt()和decrypt()： 使用简单的XOR加密算法。$filename = 'encrypted://test.txt?'.$key;： 将密钥作为URL参数传递。
4. 注意事项：安全与性能
- 安全： Stream Wrappers可以访问文件系统、网络等资源，所以一定要注意安全问题，防止恶意代码利用。
- 验证输入： 对所有输入进行严格的验证，防止路径穿越、代码注入等攻击。
- 权限控制： 只允许Stream Wrapper访问必要的资源，避免过度授权。
- 加密： 如果涉及敏感数据，一定要使用安全的加密算法。
- 性能： Stream Wrappers 会增加I/O操作的开销，所以要尽量优化代码，避免不必要的性能损失。
- 缓存： 对读取的数据进行缓存，减少I/O操作次数。
- 批量操作： 尽量使用批量操作，减少函数调用次数。
- 避免阻塞： 尽量使用非阻塞I/O，避免阻塞主线程。
5. 总结：Stream Wrappers 的威力
Stream Wrappers 是 PHP 中一个非常强大的工具，可以让你定制I/O操作，实现各种有趣和实用的功能。但是，使用Stream Wrappers 需要谨慎，要注意安全和性能问题。
掌握了Stream Wrappers，你就掌握了PHP I/O操作的“魔法”，可以创造出各种奇妙的应用。希望今天的讲座能给你带来一些启发。
课后作业：
- 尝试创建一个Stream Wrapper，实现自动将读取的文件内容转换为小写的功能。
- 尝试创建一个Stream Wrapper，实现从数据库中读取数据，模拟成一个文件系统。
- 思考一下，Stream Wrappers 还有哪些应用场景？
好了，今天的课就上到这里，下课！