本文我们接着上文继续来探讨一下如何使用使用 PHP 来操作 Ceph S3 接口。

• 安装 AWS PHP SDK
• 建立连接
• 获取 Bucket 列表
• 创建一个 Bucket
• 删除一个 Bucket
• 获取文件列表
• 上传文件
• 删除文件
• 下载文件
• 生成文件下载地址
• 参考文档

安装 AWS PHP SDK

很简单，直接使用 composer 安装就好了。

composer install aws/aws-sdk-php

你也可以直接新建 composer.json 文件，然后加上如下配置：

{
    "require": {
        "aws/aws-sdk-php": "^3.154"
    }
}

然后再执行：

composer update

建立连接

use Aws\S3\S3Client;

define('AWS_KEY', 'MTAU54XU6ILI6097SNK8');
define('AWS_SECRET_KEY', 'TfYnLGXnOsQ6eXd8j98T3zYlwoewDFwTRwhqygFU');
define('DOMAIN', 'http://s3.rockyang.org');

require __DIR__.'/vendor/autoload.php';

// Instantiate the S3 class and point it at the desired host
$client = new S3Client([
    'region' => '',
    'version' => '2012-10-17',
    'endpoint' => DOMAIN,
    'credentials' => [
        'key' => AWS_KEY,
        'secret' => AWS_SECRET_KEY
    ],
    // Set the S3 class to use objects.dreamhost.com/bucket
    // instead of bucket.objects.dreamhost.com
    'use_path_style_endpoint' => true
]);

获取 Bucket 列表

该 API 将返回一个 ` AWS\Result` 对象。

// list all the buckets
$listResponse = $client->listBuckets();
$buckets = $listResponse['Buckets'];
foreach ($buckets as $bucket) {
    echo $bucket['Name'] . "\t" . $bucket['CreationDate'] . "\n";
}

输出：

bucket1   2020-10-19T22:05:39.000Z
bucket1   2020-10-19T22:05:48.000Z
bucket1   2020-10-19T22:07:18.000Z

创建一个 Bucket

$client->createBucket(['Bucket' => 'my-new-bucket']);

删除一个 Bucket

$client->deleteBucket(['Bucket' => 'my-old-bucket']);

获取文件列表

$objectsListResponse = $client->listObjects(['Bucket' => $bucketname]);
$objects = $objectsListResponse['Contents'] ?? [];
foreach ($objects as $object) {
    echo $object['Key'] . "\t" . $object['Size'] . "\t" . $object['LastModified'] . "\n";
}

上传文件

上传一个文本文件：

$client->putObject([
    'Bucket' => 'my-bucket-name',
    'Key' => 'hello.txt',
    'Body' => "Hello World!" // 文件内容
]);

上传一个二进制文件：

$sourceFile = "hello.jpg";
$r = $client->putObject([
    'Bucket' => 'my-bucket-name',
    'Key' => 'hello.jpg',
    'SourceFile' => $sourceFile
]);
$r = $r->toArray();
$res = $r['@metadata'];
if (isset($res["statusCode"]) && $res["statusCode"] == 200) {
    printf("Upload successfully. url: %s\n", $r["ObjectURL"]);
} else {
    echo "File upload failed.\n";
}

删除文件

$client->deleteObject(['Bucket' => 'my-bucket-name', 'Key' => 'hello.txt']);

下载文件

$object = $client->getObject(['Bucket' => 'my-bucket-name', 'Key' => 'poetry.pdf']);
file_put_contents('/home/larry/documents/poetry.pdf', $object['Body']->getContents());

生成文件下载地址

$hello_url = $client->getObjectUrl('my-bucket-name', 'hello.txt');
echo $hello_url."\n";

$secret_plans_cmd = $client->getCommand('GetObject', ['Bucket' => 'my-bucket-name', 'Key' => 'secret_plans.txt']);
$request = $client->createPresignedRequest($secret_plans_cmd, '+1 hour');
echo $request->getUri()."\n";

输出结果：

http://objects.dreamhost.com/my-bucket-name/hello.txt
http://objects.dreamhost.com/my-bucket-name/secret_plans.txt?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=sandboxAccessKey%2F20190116%2F%2Fs3%2Faws4_request&X-Amz-Date=20190116T125520Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Signature=61921f07c73d7695e47a2192cf55ae030f34c44c512b2160bb5a936b2b48d923

参考文档

• https://docs.ceph.com/en/latest/radosgw/s3/php/

http://docs.ceph.org.cn/radosgw/s3/php/

PHP S3 样例

新建一个连接

下面的代码会新建一个连接，这样你就可以和服务器交互.

<?php
define('AWS_KEY', 'place access key here');
define('AWS_SECRET_KEY', 'place secret key here');
define('AWS_CANONICAL_ID', 'your DHO Username');
define('AWS_CANONICAL_NAME', 'Also your DHO Username!');
$HOST = 'objects.dreamhost.com';

// require the amazon sdk for php library
require_once 'AWSSDKforPHP/sdk.class.php';

// Instantiate the S3 class and point it at the desired host
$Connection = new AmazonS3(array(
        'key' => AWS_KEY,
        'secret' => AWS_SECRET_KEY,
        'canonical_id' => AWS_CANONICAL_ID,
        'canonical_name' => AWS_CANONICAL_NAME,
));
$Connection->set_hostname($HOST);
$Connection->allow_hostname_override(false);

// Set the S3 class to use objects.dreamhost.com/bucket
// instead of bucket.objects.dreamhost.com
$Connection->enable_path_style();

列出用户的所有 BUCKET

下面的代码会生成 CFSimpleXML 类型的对象列表，它代表你拥有的bucket。这也会打印出每个bucket 的 bucket 名和创建时间。

<?php
$ListResponse = $Connection->list_buckets();
$Buckets = $ListResponse->body->Buckets->Bucket;
foreach ($Buckets as $Bucket) {
        echo $Bucket->Name . "\t" . $Bucket->CreationDate . "\n";
}

输出形式类似下面这样:

mahbuckat1   2011-04-21T18:05:39.000Z
mahbuckat2   2011-04-21T18:05:48.000Z
mahbuckat3   2011-04-21T18:07:18.000Z

新建一个 BUCKET

下面的代码会新建一个名为 my-new-bucket 的bucket，并返回一个 CFResponse 对象

Note

这个命令需要指定 region 作为第二个参数， 所以我们使用 AmazonS3::REGION_US_E1, 因为它的内容是 ''

<?php
$Connection->create_bucket('my-new-bucket', AmazonS3::REGION_US_E1);

列出 BUCKET 的内容

下面的代码会输出 CFSimpleXML 对象的一个数组，它代表了bucket内的对象。这也会打印出每一个对象的名字、文件尺寸和最近修改时间。

<?php
$ObjectsListResponse = $Connection->list_objects($bucketname);
$Objects = $ObjectsListResponse->body->Contents;
foreach ($Objects as $Object) {
        echo $Object->Key . "\t" . $Object->Size . "\t" . $Object->LastModified . "\n";
}

Note

如果在这个 bucket 中有超过1000个对象，你需要检查 $ObjectListResponse->body->isTruncated 的值，然后使用列出的最后一个 key 的名字再次运行。一直这样 做直到 isTruncated 的值不再是 true。

如果该 bucket 内有文件，输出形式类似下面这样:

myphoto1.jpg 251262  2011-08-08T21:35:48.000Z
myphoto2.jpg 262518  2011-08-08T21:38:01.000Z

删除 BUCKET

下面的代码会删除名为 my-old-bucket 的 bucket，并返回一个 CFResponse 对象。

Note

Bucket必须为空！否则它不会工作!

<?php
$Connection->delete_bucket('my-old-bucket');

强制删除非空 BUCKETS

下面的代码会删除一个 bucket 即使它不是空的。

<?php
$Connection->delete_bucket('my-old-bucket', 1);

新建一个对象

下面的代码会新建一个内容是字符串``”Hello World!”`` 的文件 hello.txt。

<?php
$Connection->create_object('my-bucket-name', 'hello.txt', array(
        'body' => "Hello World!",
));

修改一个对象的 ACL

下面的代码会将对象 hello.txt 的权限变为公开可读，而将 secret_plans.txt 的权限设为私有。

<?php
$Connection->set_object_acl('my-bucket-name', 'hello.txt', AmazonS3::ACL_PUBLIC);
$Connection->set_object_acl('my-bucket-name', 'secret_plans.txt', AmazonS3::ACL_PRIVATE);

删除一个对象

下面的代码会删除对象 goodbye.txt

<?php
$Connection->delete_object('my-bucket-name', 'goodbye.txt');

下载一个对象 (到文件)

下面的代码会下载对象 perl_poetry.pdf 并将它存到位置 C:\Users\larry\Documents

<?php
$FileHandle = fopen('/home/larry/documents/poetry.pdf', 'w+');
$Connection->get_object('my-bucket-name', 'poetry.pdf', array(
        'fileDownload' => $FileHandle,
));

生成对象的下载 URLS (带签名和不带签名)

下面的代码会为 hello.txt 生成一个无签名为下 载URL。这个操作会生效是因为前面我们已经设置 hello.txt 的ACL 为公开可读。下面的代码同时会 为 secret_plans.txt 生成一个有效时间是一个小 时的带签名的下载 URL。带签名的下载URL 在这个时间内 是可用的，即使对象的权限是私有(当时间到期后URL 将不 可用)。

<?php
my $plans_url = $Connection->get_object_url('my-bucket-name', 'hello.txt');
echo $plans_url . "\n";
my $secret_url = $Connection->get_object_url('my-bucket-name', 'secret_plans.txt', '1 hour');
echo $secret_url . "\n";

输出形式类似下面这样:

http://objects.dreamhost.com/my-bucket-name/hello.txt
http://objects.dreamhost.com/my-bucket-name/secret_plans.txt?Signature=XXXXXXXXXXXXXXXXXXXXXXXXXXX&Expires=13160270