如何在Flutter中获取AWS S3所有存储桶并实现桶及数据操作？

准备工作 #

1. 添加依赖
   在pubspec.yaml中引入AWS SDK for Flutter：

dependencies:
  aws_sdk_for_flutter: ^0.1.0
  path_provider: ^2.0.15 # 操作本地文件时需引入

运行flutter pub get完成依赖安装。

2. 配置AWS凭证
   禁止硬编码凭证到代码中，推荐以下安全方式：

• 移动端：借助AWS Amplify Auth获取临时凭证，或存储在设备安全存储中
• 测试环境：通过dart-define参数传递环境变量

初始化S3客户端 #

创建全局可复用的S3客户端实例：

import 'package:aws_sdk_for_flutter/aws_sdk_for_flutter.dart';

final s3Client = S3Client(
  region: 'us-east-1', // 替换为你的AWS区域
  credentials: AwsCredentials(
    accessKey: 'YOUR_ACCESS_KEY', // 从安全渠道获取
    secretKey: 'YOUR_SECRET_KEY',
  ),
);

核心操作实现 #

1. 获取所有存储桶 #

调用listBuckets方法获取账号下的全部S3桶：

Future<List<Bucket>> getAllBuckets() async {
  try {
    final response = await s3Client.listBuckets();
    return response.buckets ?? [];
  } on S3Exception catch (e) {
    print('获取桶列表失败: ${e.message}');
    rethrow;
  }
}

// 使用示例
void fetchBuckets() async {
  final buckets = await getAllBuckets();
  for (var bucket in buckets) {
    print('桶名: ${bucket.name}, 创建时间: ${bucket.creationDate}');
  }
}

2. 创建存储桶 #

S3桶名需全局唯一，仅允许小写字母、数字、连字符和点，且不能以连字符/点开头或结尾：

Future<void> createBucket(String bucketName) async {
  try {
    await s3Client.createBucket(
      CreateBucketRequest(
        bucket: bucketName,
        createBucketConfiguration: CreateBucketConfiguration(
          locationConstraint: 'us-east-1', // 与客户端区域保持一致
        ),
      ),
    );
    print('桶 $bucketName 创建成功');
  } on S3Exception catch (e) {
    print('创建桶失败: ${e.message}');
    rethrow;
  }
}

3. 上传/创建对象（添加数据） #

支持上传字符串或本地文件到指定桶：

// 上传字符串内容
Future<void> uploadString(String bucketName, String key, String content) async {
  try {
    await s3Client.putObject(
      PutObjectRequest(
        bucket: bucketName,
        key: key, // 对象在桶中的路径/唯一标识
        body: S3Body.fromString(content),
      ),
    );
    print('对象 $key 上传成功');
  } on S3Exception catch (e) {
    print('上传对象失败: ${e.message}');
    rethrow;
  }
}

// 上传本地文件
Future<void> uploadFile(String bucketName, String key, File file) async {
  try {
    await s3Client.putObject(
      PutObjectRequest(
        bucket: bucketName,
        key: key,
        body: S3Body.fromFile(file),
      ),
    );
    print('文件 ${file.path} 上传成功');
  } on S3Exception catch (e) {
    print('上传文件失败: ${e.message}');
    rethrow;
  }
}

4. 更新对象 #

S3无单独更新接口，通过覆盖同名key的对象实现更新：

// 直接调用上传方法，传入相同key即可覆盖原有对象
Future<void> updateObject(String bucketName, String key, String newContent) async {
  await uploadString(bucketName, key, newContent);
}

5. 获取/查看对象内容 #

可读取对象为字符串或下载到本地文件：

// 读取对象为字符串
Future<String> getObjectAsString(String bucketName, String key) async {
  try {
    final response = await s3Client.getObject(
      GetObjectRequest(
        bucket: bucketName,
        key: key,
      ),
    );
    return await response.body?.readAsString() ?? '';
  } on S3Exception catch (e) {
    print('获取对象失败: ${e.message}');
    rethrow;
  }
}

// 下载对象到本地文件
Future<void> downloadObjectToFile(String bucketName, String key, File saveFile) async {
  try {
    final response = await s3Client.getObject(
      GetObjectRequest(
        bucket: bucketName,
        key: key,
      ),
    );
    final fileSink = saveFile.openWrite();
    await response.body?.pipe(fileSink);
    await fileSink.close();
    print('对象已保存到 ${saveFile.path}');
  } on S3Exception catch (e) {
    print('下载对象失败: ${e.message}');
    rethrow;
  }
}

6. 删除对象 #

删除指定桶中的目标对象：

Future<void> deleteObject(String bucketName, String key) async {
  try {
    await s3Client.deleteObject(
      DeleteObjectRequest(
        bucket: bucketName,
        key: key,
      ),
    );
    print('对象 $key 删除成功');
  } on S3Exception catch (e) {
    print('删除对象失败: ${e.message}');
    rethrow;
  }
}

权限注意事项 #

确保你的AWS IAM用户拥有以下权限（通过IAM策略配置）：

• s3:ListAllMyBuckets：获取桶列表
• s3:CreateBucket：创建桶
• s3:PutObject：上传/更新对象
• s3:GetObject：下载对象
• s3:DeleteObject：删除对象

内容的提问来源于stack exchange，提问作者Mukesh Gupta