AWS SDK for PHP - Version 3
项目标题与描述
AWS SDK for PHP 是一个官方支持的 PHP 开发工具包，让开发者能够轻松地在 PHP 代码中访问 [Amazon Web Services][aws]，并构建稳健的应用程序。该 SDK 支持超过 200 个 AWS 服务，包括 Amazon S3、Amazon DynamoDB、Amazon Glacier 等核心服务。
通过提供一致的 API 接口和丰富的功能特性，AWS SDK for PHP 帮助开发者快速集成 AWS 服务到他们的 PHP 应用程序中。无论是构建 Web 应用、后端服务还是命令行工具，这个 SDK 都能提供强大的支持。
功能特性
- 全面的服务覆盖：支持 200 多个 AWS 服务，持续更新以包含最新的 AWS 功能
- 简单易用的 API：提供直观的操作接口，命名空间组织清晰，易于理解和使用
- 异步操作支持：基于 Guzzle HTTP 库，支持异步操作，提升应用程序性能
- 分页器和等待器：内置分页器简化大数据集处理，等待器方便资源状态轮询
- 灵活的配置选项：支持多种凭证提供方式、区域配置和自定义端点
- 数据模型验证：自动验证输入参数，确保 API 调用的正确性
- 缓存支持：提供多种缓存适配器（Doctrine、PSR-6、PSR-16、LRU 缓存）
- 错误处理：详细的异常信息和错误代码，便于调试和问题排查
- 多区域客户端：支持创建多区域客户端，简化跨区域操作
- 请求压缩：支持请求体压缩，减少网络传输数据量
安装指南
系统要求
- PHP >= 8.1
- 推荐启用 cURL 扩展
- cURL 7.16.2+ 编译时需包含 TLS 后端（如 NSS 或 OpenSSL）
使用 Composer 安装（推荐方式）
composer require aws/aws-sdk-php
其他安装方式
- 下载 ZIP 或 PHAR 文件：从 [最新发布][latest-release] 页面下载
- 使用 GitHub 仓库：克隆仓库并手动配置
环境配置
设置 AWS 凭证环境变量：
export AWS_ACCESS_KEY_ID="your_access_key"
export AWS_SECRET_ACCESS_KEY="your_secret_key"
export AWS_DEFAULT_REGION="us-west-2"
使用说明
基础使用示例
<?php
require 'vendor/autoload.php';use Aws\S3\S3Client;
use Aws\Exception\AwsException;// 创建 S3 客户端
$s3 = new S3Client(['version' => 'latest','region' => 'us-west-2',
]);try {// 列出存储桶$result = $s3->listBuckets();foreach ($result['Buckets'] as $bucket) {echo $bucket['Name'] . "\n";}// 上传文件$s3->putObject(['Bucket' => 'your-bucket-name','Key' => 'test-file.txt','Body' => 'Hello, AWS!']);
} catch (AwsException $e) {echo "Error: " . $e->getMessage() . "\n";
}
异步操作示例
<?php
require 'vendor/autoload.php';use Aws\S3\S3Client;
use GuzzleHttp\Promise;$s3 = new S3Client(['version' => 'latest','region' => 'us-west-2',
]);// 创建多个异步请求
$promises = ['bucket1' => $s3->listObjectsAsync(['Bucket' => 'bucket1']),'bucket2' => $s3->listObjectsAsync(['Bucket' => 'bucket2']),'bucket3' => $s3->listObjectsAsync(['Bucket' => 'bucket3']),
];// 等待所有请求完成
$results = Promise\Utils::settle($promises)->wait();foreach ($results as $key => $result) {if ($result['state'] === 'fulfilled') {echo "{$key}: Success\n";} else {echo "{$key}: Failed - " . $result['reason']->getMessage() . "\n";}
}
使用分页器
<?php
require 'vendor/autoload.php';use Aws\S3\S3Client;$s3 = new S3Client(['version' => 'latest','region' => 'us-west-2',
]);// 使用分页器处理大量对象
$paginator = $s3->getPaginator('ListObjects', ['Bucket' => 'your-bucket-name'
]);foreach ($paginator as $page) {foreach ($page['Contents'] as $object) {echo $object['Key'] . "\n";}
}
使用等待器
<?php
require 'vendor/autoload.php';use Aws\Ec2\Ec2Client;$ec2 = new Ec2Client(['version' => 'latest','region' => 'us-west-2',
]);// 启动实例
$result = $ec2->runInstances(['ImageId' => 'ami-12345678','MinCount' => 1,'MaxCount' => 1,'InstanceType' => 't2.micro'
]);$instanceId = $result['Instances'][0]['InstanceId'];// 等待实例运行
$ec2->waitUntil('InstanceRunning', ['InstanceIds' => [$instanceId]
]);echo "实例 {$instanceId} 已启动并运行\n";
核心代码
1. 客户端基础实现（AwsClient.php）
<?php
namespace Aws;use Aws\Api\ApiProvider;
use Aws\Api\DocModel;
use Aws\Api\Service;
use Aws\Auth\AuthSelectionMiddleware;
use Aws\Auth\AuthSchemeResolverInterface;
use Aws\EndpointDiscovery\EndpointDiscoveryMiddleware;
use Aws\EndpointV2\EndpointProviderV2;
use Aws\EndpointV2\EndpointV2Middleware;
use Aws\Exception\AwsException;
use Aws\Signature\SignatureProvider;
use GuzzleHttp\Psr7\Uri;
use Psr\Http\Message\RequestInterface;/*** 默认 AWS 客户端实现* * 这是所有服务客户端的基类，提供了创建和执行命令的核心功能。* 它处理认证、端点解析、请求签名和错误处理等核心逻辑。*/
class AwsClient implements AwsClientInterface
{use AwsClientTrait;/** @var array 服务别名映射 */private $aliases;/** @var array 客户端配置 */private $config;/** @var string 区域 */private $region;/** @var string 签名区域集 */private $signingRegionSet;/** @var string 端点 */private $endpoint;/** @var Service API 服务模型 */private $api;/** @var callable 签名提供者 */private $signatureProvider;/** @var AuthSchemeResolverInterface 认证方案解析器 */private $authSchemeResolver;/** @var callable 凭证提供者 */private $credentialProvider;/** @var callable Token 提供者 */private $tokenProvider;/** @var HandlerList 处理器列表 */private $handlerList;/** @var array 默认请求选项 */private $defaultRequestOptions;/** @var array 客户端上下文参数 */private $clientContextParams = [];/** @var array 客户端内置参数 */protected $clientBuiltIns = [];/** @var EndpointProviderV2|callable 端点提供者 */protected $endpointProvider;/** @var callable 序列化器 */protected $serializer;/*** 获取客户端构造函数参数的默认值** @return array*/public static function getArguments(){return ClientResolver::getDefaultArguments();}// ... 其他方法 ...
}
2. 命令对象（Command.php）
<?php
namespace Aws;/*** AWS 命令对象* * 封装了控制 HTTP 请求创建和 HTTP 响应处理的输入参数。* 实现了 ArrayAccess、Countable 和 IteratorAggregate 接口，* 可以像数组一样访问命令参数。*/
class Command implements CommandInterface
{use HasDataTrait;/** @var string 命令名称 */private $name;/** @var HandlerList 处理器列表 */private $handlerList;/** @var array 认证方案 */private $authSchemes;/** @var MetricsBuilder 指标构建器 */private $metricsBuilder;/*** 接受命令选项的关联数组，包括：** - @http: (array) 传输特定选项的关联数组** @param string $name 命令名称* @param array $args 传递给命令的参数* @param HandlerList $list 处理器列表* @param MetricsBuilder $metricsBuilder 指标构建器*/public function __construct($name,array $args = [],?HandlerList $list = null,?MetricsBuilder $metricsBuilder = null){$this->name = $name;$this->data = $args;$this->handlerList = $list ?: new HandlerList();if (!isset($this->data['@http'])) {$this->data['@http'] = [];}if (!isset($this->data['@context'])) {$this->data['@context'] = [];}$this->metricsBuilder = $metricsBuilder ?: new MetricsBuilder();}/*** 获取命令名称** @return string*/public function getName(){return $this->name;}/*** 检查命令是否包含指定参数** @param string $name 要检查的参数名称* @return bool*/public function hasParam($name){return array_key_exists($name, $this->data);}/*** 获取处理器列表** @return HandlerList*/public function getHandlerList(){return $this->handlerList;}// ... 其他方法 ...
}
3. 结果对象（Result.php）
<?php
namespace Aws;use JmesPath\Env as JmesPath;/*** AWS 结果对象* * 表示从执行操作返回的 AWS 结果对象。* 实现了 ResultInterface、MonitoringEventsInterface 接口，* 提供了对返回数据的便捷访问和 JMESPath 表达式查询功能。*/
class Result implements ResultInterface, MonitoringEventsInterface
{use HasDataTrait;use HasMonitoringEventsTrait;/*** 构造函数** @param array $data 结果数据*/public function __construct(array $data = []){$this->data = $data;}/*** 检查模型是否包含指定名称的键** @param string $name 要检索的键名* @return bool*/public function hasKey($name){return isset($this->data[$name]);}/*** 从结果模型中获取特定键值** @param string $key 要检索的键* @return mixed|null 键的值或未找到时返回 null*/public function get($key){return $this[$key];}/*** 对结果内容执行 JMESPath 表达式** @param string $expression 要执行的 JMESPath 表达式* @return mixed 返回 JMESPath 表达式的结果*/public function search($expression){return JmesPath::search($expression, $this->toArray());}/*** 将结果对象转换为字符串表示** @return string*/public function __toString(){$jsonData = json_encode($this->toArray(), JSON_PRETTY_PRINT);return <<<EOT
Model Data
----
Data can be retrieved from the model object using the get() method of the
model (e.g., `\$result->get(\$key)`) or "accessing the result like an
associative array (e.g. `\$result['key']`). You can also execute JMESPath
expressions on the result data using the search() method.{$jsonData}EOT;}
}
4. 处理器列表（HandlerList.php）
<?php
namespace Aws;/*** 从零个或多个中间件函数和一个处理器构建单个处理器函数* * 处理器函数用于发送命令对象并返回解析为 AWS 结果对象的 Promise。* 列表的"前端"在列表的"末端"之前被调用。可以使用"prepend"方法将中间件* 添加到列表的前端，使用"append"方法添加到列表的末端。* 处理器列表中调用的最后一个函数是处理器（一个不接受下一个处理器而是* 负责返回解析为 Aws\ResultInterface 对象的 Promise 的函数）。*/
class HandlerList implements \Countable
{const INIT = 'init';const VALIDATE = 'validate';const BUILD = 'build';const SIGN = 'sign';const ATTEMPT = 'attempt';/** @var callable 处理器函数 */private $handler;/** @var array 命名中间件映射 */private $named = [];/** @var array 排序后的中间件列表 */private $sorted;/** @var callable|null 插入函数 */private $interposeFn;/** @var array 步骤列表（反向顺序） */private $steps = [self::INIT,self::VALIDATE,self::BUILD,self::SIGN,self::ATTEMPT,];/*** 构造函数** @param callable|null $handler 处理器函数*/public function __construct(?callable $handler = null){$this->handler = $handler;}/*** 设置处理器函数** @param callable $handler 处理器函数*/public function setHandler(callable $handler){$this->handler = $handler;}/*** 在指定步骤前添加中间件** @param string $step 步骤名称* @param callable $middleware 中间件函数* @param string $name 中间件名称（可选）*/public function prepend($step, callable $middleware, $name = null){$this->add($step, $middleware, $name, true);}/*** 在指定步骤后添加中间件** @param string $step 步骤名称* @param callable $middleware 中间件函数* @param string $name 中间件名称（可选）*/public function append($step, callable $middleware, $name = null){$this->add($step, $middleware, $name, false);}// ... 其他方法 ...
}
5. 分页器实现（ResultPaginator.php）
<?php
namespace Aws;use GuzzleHttp\Promise;/*** 产生页面操作每个结果页面的迭代器* * 用于处理返回分页结果的 AWS 操作，自动处理下一页令牌和请求限制。* 实现了 Iterator 接口，可以在 foreach 循环中直接使用。*/
class ResultPaginator implements \Iterator
{/** @var AwsClientInterface 执行操作的客户端 */private $client;/** @var string 被分页的操作名称 */private $operation;/** @var array 操作参数 */private $args;/** @var array 分页器配置 */private $config;/** @var Result 客户端的最新结果 */private $result;/** @var string|array 用于分页的下一个令牌 */private $nextToken;/** @var int 执行的操作/请求数量 */private $requestCount = 0;/*** 构造函数** @param AwsClientInterface $client 客户端* @param string $operation 操作名称* @param array $args 参数* @param array $config 配置*/public function __construct(AwsClientInterface $client,$operation,array $args,array $config) {$this->client = $client;$this->operation = $operation;$this->args = $args;$this->config = $config;MetricsBuilder::appendMetricsCaptureMiddleware($this->client->getHandlerList(),MetricsBuilder::PAGINATOR);}/*** 异步运行分页器并使用回调处理结果** 回调应该具有签名：function (Aws\Result $result)* 回调的非空返回值将由 Promise 产生。** @param callable $handleResult 结果处理回调* @return PromiseInterface*/public function each(callable $handleResult){return Promise\Coroutine::of(function () use ($handleResult) {$nextToken = $this->nextToken;for ($this->requestCount = 0; $this->requestCount < $this->config['max_attempts']; $this->requestCount++) {$command = $this->client->getCommand($this->operation,$this->args + ($nextToken ? ['NextToken' => $nextToken] : []));$result = yield $this->client->executeAsync($command);$nextToken = $this->determineNextToken($result);$handleResult($result);if (!$nextToken) {break;}}});}// ... 其他迭代器接口方法 ...
}
这些核心组件构成了 AWS SDK for PHP 的基础架构，提供了强大而灵活的功能来与 AWS 服务进行交互。
h4UZHBlKVcEsJsBd66l+GyxlLLEsq6RXN129Szxm4HA=
更多精彩内容 请关注我的个人公众号 公众号（办公AI智能小助手）
对网络安全、黑客技术感兴趣的朋友可以关注我的安全公众号（网络安全技术点滴分享）
公众号二维码
公众号二维码
