适用于 PHP 的 AWS 开发工具包
开发人员指南
AWS 文档中描述的 AWS 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 AWS 服务入门

Amazon S3 Transfer Manager 与AWS SDK for PHP版本 3

AWS SDK for PHP中的 Amazon S3 Transfer Manager 用于将整个目录上传到 Amazon S3 存储桶以及将整个存储桶下载到本地目录。

将本地目录上传到 Amazon S3

Aws\S3\Transfer 对象用于执行传输。以下示例演示了如何将文件的本地目录递归上传到 Amazon S3 存储桶。

// Create an S3 client $client = new \Aws\S3\S3Client([ 'region' => 'us-west-2', 'version' => '2006-03-01', ]); // Where the files will be source from $source = '/path/to/source/files'; // Where the files will be transferred to $dest = 's3://bucket'; // Create a transfer object $manager = new \Aws\S3\Transfer($client, $source, $dest); // Perform the transfer synchronously $manager->transfer();

在此示例中,我们创建了一个 Amazon S3 客户端,创建了一个 Transfer 对象,并执行了同步传输。使用上一个示例演示执行传输所需的最低代码量。传输对象可执行异步传输,并且拥有各种配置选项可用于自定义传输。

您可以通过提供 s3:// URI 中的键前缀,将本地文件上传到 Amazon S3 存储桶的“子文件夹”。以下示例将磁盘上的本地文件上传到 bucket 存储桶,并将文件存储在 foo 键前缀下。

$source = '/path/to/source/files'; $dest = 's3://bucket/foo'; $manager = new \Aws\S3\Transfer($client, $source, $dest); $manager->transfer();

下载 Amazon S3 存储桶

您可以通过将 $source 参数指定为 Amazon S3 URI(例如 s3://bucket)并将 $dest 参数指定为本地目录的路径,从而将 Amazon S3 存储桶递归下载到磁盘上的本地目录。

// Where the files will be sourced from $source = 's3://bucket'; // Where the files will be transferred to $dest = '/path/to/destination/dir'; $manager = new \Aws\S3\Transfer($client, $source, $dest); $manager->transfer();

注意

开发工具包将在下载存储桶中的对象时自动创建任何必要的目录。

您可以在存储桶后面的 Amazon S3 URI 中包含键前缀,以便仅下载存储在“虚拟文件夹”下的对象。以下示例仅下载存储在给定存储桶的“/foo”键前缀下的文件。

$source = 's3://bucket/foo'; $dest = '/path/to/destination/dir'; $manager = new \Aws\S3\Transfer($client, $source, $dest); $manager->transfer();

配置

Transfer 对象构造函数接受以下参数。

$client

Aws\ClientInterface 对象用于执行传输。

$source (字符串|“迭代器”)

正在传输的源数据。这可以指向磁盘上的本地路径(例如 /path/to/files)或 Amazon S3 存储桶(例如 s3://bucket)。s3:// URI 还可能包含可用于仅传输通用前缀下的对象的键前缀。

如果 $source 参数为 Amazon S3 URI,则 $dest 参数必须是一个本地目录(反之亦然)。

除了提供字符串值之外,您还可以提供生成绝对文件名的 \Iterator 对象。如果您提供了迭代器,则必须提供 $options 关联数组中的 base_dir 选项。

$dest

文件传输目的地。如果 $source 参数是磁盘上的本地路径,则 $dest 必须为 Amazon S3 存储桶 URI(例如 s3://bucket)。如果 $source 参数为 Amazon S3 存储桶 URI,则 $dest 参数必须为磁盘上的本地路径。

$options

传输选项的关联数组。

传输选项

base_dir (string)

源的基本目录 (如果 $source 为迭代器)。如果 $source 选项不是数组,则此选项将被忽略。

before (可调用)

每次传输前要调用的回调。此回调应具有类似 function (Aws\Command $command) {...} 的函数签名。提供的命令将是 GetObjectPutObjectCreateMultipartUploadUploadPartCompleteMultipartUpload 命令。

mup_threshold (int)

应使用分段上传而不是 PutObject 的大小 (以字节为单位)。默认值为 16777216 (16 MB)。

concurrency (整数,默认值=5)

并发上传的文件数。理想的并发值会有所不同,具体取决于正在上传的文件数以及每个文件的平均大小。通常,更高的并发度对较小文件有利,对较大文件则不然。

debug (bool)

设置为 true 可打印输出调试信息用于传输。设置为 fopen() 资源可写入特定流,而不是写入 STDOUT。

异步传输

Transfer 对象是 GuzzleHttp\Promise\PromisorInterface 的实例。这意味着传输可以异步发生,并通过调用对象的 promise 方法启动。

$source = '/path/to/source/files'; $dest = 's3://bucket'; $manager = new \Aws\S3\Transfer($client, $source, $dest); // Initiate the transfer and get a promise $promise = $manager->promise(); // Do something when the transfer is complete using the then() method $promise->then(function () { echo 'Done!'; });

如有任何文件传输失败,则 Promise 将被拒绝。您可以使用 Promise 的 otherwise 方法以异步方式处理失败的传输。出现错误时,otherwise 函数接受要调用的回调。回调接受拒绝的 $reason,这通常是 Aws\Exception\AwsException 的实例 (尽管任何类型的值均可发送到回调)。

$promise->otherwise(function ($reason) { echo 'Transfer failed: '; var_dump($reason); });

由于 Transfer 对象返回一个 Promise,这些传输可以与其他异步 Promise 同时进行。

自定义 Transfer Manager 的命令

可对 Transfer Manager 通过传递给其构造函数的回调执行的操作设置自定义选项。

$uploader = new Transfer($s3Client, $source, $dest, [ 'before' => function (\Aws\Command $command) { // Commands can vary for multipart uploads, so check which command // is being processed if (in_array($command->getName(), ['PutObject', 'CreateMultipartUpload'])) { // Set custom cache-control metadata $command['CacheControl'] = 'max-age=3600'; // Apply a canned ACL $command['ACL'] = strpos($command['Key'], 'CONFIDENTIAL') ### false ? 'public-read' : 'private'; } }, ]);