AWS SDK for PHP 版本 3 的 Amazon S3 直播封装器

Amazon S3 流包装器允许您使用内置PHP函数（例如、、、、、、和）存储和rmdir检索来自 Amazon S3 的数据。file_get_contents fopen copy rename unlink mkdir

您需要注册 Amazon S3 Stream Wrapper 才可使用。

$client = new Aws\S3\S3Client([/** options **/]);

// Register the stream wrapper from an S3Client object
$client->registerStreamWrapper();

这样您就可以使用 s3:// 协议来访问 Amazon S3 中存储的存储桶和对象。Amazon S3 Stream Wrapper 接受包含存储桶名称的字符串，后跟正斜杠和可选的对象键或前缀：s3://<bucket>[/<key-or-prefix>]。

下载数据

您可以使用 file_get_contents 获取对象内容。但使用此功能要小心，它会将对象的全部内容载入内存。

// Download the body of the "key" object in the "bucket" bucket
$data = file_get_contents('s3://bucket/key');

如果处理较大文件或需要从 Amazon S3 流式传输数据，请使用 fopen()。

// Open a stream in read-only mode
if ($stream = fopen('s3://bucket/key', 'r')) {
    // While the stream is still open
    while (!feof($stream)) {
        // Read 1,024 bytes from the stream
        echo fread($stream, 1024);
    }
    // Be sure to close the stream resource when you're done with it
    fclose($stream);
}

打开可搜寻的流

以“r”模式打开的流仅允许读取流中的数据，默认情况下不可搜寻。这样数据才能够真正以流式处理的方式从 Amazon S3 下载，之前读取的字节不需要缓冲到内存中。如果需要对流进行搜寻，可以将 seekable 传递到函数的流上下文选项。

$context = stream_context_create([
    's3' => ['seekable' => true]
]);

if ($stream = fopen('s3://bucket/key', 'r', false, $context)) {
    // Read bytes from the stream
    fread($stream, 1024);
    // Seek back to the beginning of the stream
    fseek($stream, 0);
    // Read the same bytes that were previously read
    fread($stream, 1024);
    fclose($stream);
}

“打开可搜寻的流”支持您搜寻之前读取的字节。您不可跳转到尚未从远程服务器读取的字节。为了允许调用之前读取的数据，使用流装饰器在PHP临时流中缓冲数据。如果缓存数据量超过 2 MB，临时流中的数据会从内存传输到磁盘中。在使用 seekable 流上下文设置从 Amazon S3 下载大文件时，请留意这一点。

上传数据

您可以使用 file_put_contents() 来将数据上传到 Amazon S3。

file_put_contents('s3://bucket/key', 'Hello!');

您可以结合使用 fopen() 和“w”、“x”或“a”流访问模式来流式传输数据，从而上传较大的文件。Amazon S3 Stream Wrapper 不支持同时读取和写入流（例如“r+”、“w+”等）。这是因为该HTTP协议不允许同时读取和写入。

$stream = fopen('s3://bucket/key', 'w');
fwrite($stream, 'Hello!');
fclose($stream);

fopen 模式

PHP的 fopen () 函数要求你指定一个$mode选项。mode 选项指定数据是否可在流中进行读写，以及打开流时文件是否必须存在。

对于以 Amazon S3 对象为目标的流，Amazon S3 Stream Wrapper 支持以下模式。

其他对象函数

流包装器允许许多不同的内置PHP函数与 Amazon S3 等自定义系统配合使用。Amazon S3 Stream Wrapper 允许您针对存储在 Amazon S3 中的对象执行以下函数。

// Delete an object from a bucket
unlink('s3://bucket/key');

// Delete a specific version of an object from a bucket
unlink('s3://bucket/key', stream_context_create([
    's3' => ['VersionId' => '123']
]);

// Get the Content-Length of an object
$size = filesize('s3://bucket/key', );

if (is_file('s3://bucket/key')) {
    echo 'It is a file!';
}

if (file_exists('s3://bucket/key')) {
    echo 'It exists!';
}

使用存储桶和文件夹

使用 mkdir() 来使用存储桶

您可以创建和浏览 Amazon S3 存储桶，就像PHP允许您在文件系统上创建和遍历目录的方式一样。

以下是创建存储桶的示例。

mkdir('s3://amzn-s3-demo-bucket');

您可以使用CreateBucket操作可用的参数将流上下文选项传递给该mkdir()方法，以修改存储桶的创建方式。

// Create a bucket in the EU (Ireland) Region
mkdir('s3://amzn-s3-demo-bucket', 0500, true,
        stream_context_create([
            's3' => ['LocationConstraint' => 'eu-west-1']
        ]));

您可以使用 rmdir() 函数删除存储桶。

// Delete a bucket
rmdir('s3://amzn-s3-demo-bucket);

使用 mkdir() 来使用文件夹

创建存储桶后，您可以使用 mkdir() 来创建对象，这些对象可用作文件夹，就像在文件系统中一样。

以下代码段将名为 “my-folder” 的文件夹对象添加到名为 “amzn-s3-demo-bucket” 的现有存储桶中。使用正斜杠 (/) 字符将文件夹对象名称与存储桶名称和任何其他文件夹名称分开。

mkdir('s3://amzn-s3-demo-bucket/my-folder')

关于 2023 年 4 月之后权限变更的上一个注释也会在您创建文件夹对象时发挥作用。这篇博客文章包含有关如何在需要时调整权限的信息。

使用 rmdir() 函数删除空文件夹对象，如下面的代码段所示。

rmdir('s3://amzn-s3-demo-bucket/my-folder')

列出存储桶的内容。

您可以将 opendir ()、readdir ()、rewinddir () 和 closedir () 函数与 PHP Amazon S3 流包装器一起使用来遍历存储桶的内容。您可以将ListObjects操作可用的参数作为自定义流上下文选项传递给opendir()函数，以修改对象的列出方式。

$dir = "s3://bucket/";

if (is_dir($dir) && ($dh = opendir($dir))) {
    while (($file = readdir($dh)) !== false) {
        echo "filename: {$file} : filetype: " . filetype($dir . $file) . "\n";
    }
    closedir($dh);
}

您可以使用 PHP 'RecursiveDirectoryIterators递归列出存储桶中的每个对象和前缀。

$dir = 's3://bucket';
$iterator = new RecursiveIteratorIterator(new RecursiveDirectoryIterator($dir));

foreach ($iterator as $file) {
    echo $file->getType() . ': ' . $file . "\n";
}

递归列出存储桶内容从而减少HTTP请求量的另一种方法是使用函数。Aws\recursive_dir_iterator($path, $context = null)

<?php
require 'vendor/autoload.php';

$iter = Aws\recursive_dir_iterator('s3://bucket/key');
foreach ($iter as $filename) {
    echo $filename . "\n";
}

流上下文选项

您可以通过传递自定义流上下文选项，自定义 Stream Wrapper 使用的客户端，或用于缓存之前加载的存储桶和键信息的缓存。

Stream Wrapper 针对每个操作支持以下流上下文选项。