AWS SDK for PHP 在 Laravel 中的使用教程

1. 项目的目录结构及介绍

目录结构

aws-sdk-php-laravel/
├── config/
│   └── aws.php
├── src/
│   ├── AwsServiceProvider.php
│   ├── Facades/
│   │   └── Aws.php
│   └── AwsFacade.php
├── tests/
│   └── AwsServiceProviderTest.php
├── .gitignore
├── composer.json
├── LICENSE
├── README.md
└── phpunit.xml

目录介绍

• config/: 包含项目的配置文件，如 aws.php，用于配置 AWS SDK 的参数。
• src/: 包含项目的主要源代码，包括服务提供者 (AwsServiceProvider.php) 和门面 (Facades/Aws.php)。
• tests/: 包含项目的测试文件，如 AwsServiceProviderTest.php。
• .gitignore: 指定 Git 版本控制系统忽略的文件和目录。
• composer.json: 项目的依赖管理文件，定义了项目所需的依赖包。
• LICENSE: 项目的开源许可证文件。
• README.md: 项目的说明文档。
• phpunit.xml: PHPUnit 测试框架的配置文件。

2. 项目的启动文件介绍

启动文件

• AwsServiceProvider.php: 这是 Laravel 服务提供者文件，负责注册和启动 AWS SDK 服务。

namespace Aws\Laravel;

use Aws\AwsClient;
use Aws\Laravel\AwsFacade as AWS;
use Illuminate\Support\ServiceProvider;

class AwsServiceProvider extends ServiceProvider
{
    public function boot()
    {
        $this->publishes([
            __DIR__.'/../config/aws.php' => config_path('aws.php'),
        ]);
    }

    public function register()
    {
        $this->mergeConfigFrom(
            __DIR__.'/../config/aws.php', 'aws'
        );

        $this->app->singleton('aws', function ($app) {
            return new AwsClient($app['config']['aws']);
        });

        $this->app->alias('aws', AwsClient::class);
    }
}

启动文件介绍

• boot(): 发布配置文件到 Laravel 的配置目录。
• register(): 注册 AWS SDK 服务，并将其绑定到应用程序的容器中。

3. 项目的配置文件介绍

配置文件

• aws.php: 这是 AWS SDK 的配置文件，定义了 AWS 服务的访问密钥、区域和其他配置选项。

return [
    'credentials' => [
        'key'    => env('AWS_ACCESS_KEY_ID', ''),
        'secret' => env('AWS_SECRET_ACCESS_KEY', ''),
    ],
    'region' => env('AWS_REGION', 'us-west-2'),
    'version' => 'latest',
    'ua_append' => [
        'L5MOD/' . AwsServiceProvider::VERSION,
    ],
];

配置文件介绍

• credentials: 定义 AWS 访问密钥和密钥 ID，通常从环境变量中读取。
• region: 定义 AWS 服务的区域。
• version: 定义 AWS SDK 的版本。
• ua_append: 定义用户代理字符串的附加信息。

通过以上配置，您可以在 Laravel 项目中轻松集成和使用 AWS SDK for PHP。