AWS Cognito 开源项目教程

AWS Cognito 开源项目教程

aws-cognitoAWS Cognito package (with MFA Feature) using the AWS SDK for PHP/Laravel项目地址:https://gitcode.com/gh_mirrors/aw/aws-cognito

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

aws-cognito/
├── src/
│   ├── Config/
│   │   ├── aws.php
│   │   ├── cognito.php
│   │   └── ...
│   ├── Http/
│   │   ├── Controllers/
│   │   │   └── AuthController.php
│   │   └── ...
│   ├── Providers/
│   │   └── EllaisysCognitoServiceProvider.php
│   └── ...
├── tests/
│   ├── Feature/
│   │   └── AuthTest.php
│   └── ...
├── composer.json
├── README.md
└── ...

目录结构介绍

• src/: 项目的主要源代码目录。
  • Config/: 包含项目的配置文件，如 aws.php 和 cognito.php。
  • Http/Controllers/: 包含 HTTP 控制器，如 AuthController.php，用于处理认证相关的请求。
  • Providers/: 包含服务提供者，如 EllaisysCognitoServiceProvider.php，用于注册服务。
• tests/: 包含项目的测试代码。
  • Feature/: 包含功能测试，如 AuthTest.php。
• composer.json: 项目的依赖管理文件。
• README.md: 项目的介绍和使用说明。

2. 项目的启动文件介绍

项目的启动文件通常是 src/Providers/EllaisysCognitoServiceProvider.php。这个文件负责注册和配置 AWS Cognito 服务。

namespace Ellaisys\Cognito\Providers;

use Illuminate\Support\ServiceProvider;
use Ellaisys\Cognito\AwsCognito;

class EllaisysCognitoServiceProvider extends ServiceProvider
{
    public function boot()
    {
        // 加载配置文件
        $this->publishes([
            __DIR__.'/../Config/cognito.php' => config_path('cognito.php'),
        ]);
    }

    public function register()
    {
        // 注册服务
        $this->app->singleton(AwsCognito::class, function ($app) {
            return new AwsCognito($app['config']['cognito']);
        });
    }
}

启动文件介绍

• boot(): 加载配置文件，将 cognito.php 配置文件发布到 Laravel 的配置目录中。
• register(): 注册 AWS Cognito 服务，使用单例模式创建 AwsCognito 实例。

3. 项目的配置文件介绍

项目的配置文件主要位于 src/Config/ 目录下，包括 aws.php 和 cognito.php。

aws.php

return [
    'credentials' => [
        'key' => env('AWS_ACCESS_KEY_ID', ''),
        'secret' => env('AWS_SECRET_ACCESS_KEY', ''),
    ],
    'region' => env('AWS_REGION', 'us-east-1'),
    'version' => 'latest',
];

cognito.php

return [
    'app_client_id' => env('COGNITO_CLIENT_ID', ''),
    'app_client_secret' => env('COGNITO_CLIENT_SECRET', ''),
    'user_pool_id' => env('COGNITO_USER_POOL_ID', ''),
    'region' => env('COGNITO_REGION', 'us-east-1'),
];

配置文件介绍

• aws.php: 配置 AWS 的访问密钥、区域和版本。
• cognito.php: 配置 Cognito 的应用客户端 ID、客户端密钥、用户池 ID 和区域。

这些配置文件通过环境变量加载，确保敏感信息的安全性。

aws-cognitoAWS Cognito package (with MFA Feature) using the AWS SDK for PHP/Laravel项目地址:https://gitcode.com/gh_mirrors/aw/aws-cognito