flutter_aws_s3service #

A Flutter package for AWS S3 service operations. This package provides a simple interface for common S3 operations like uploading, downloading, and managing files in AWS S3 buckets.

log tag：AwsS3service

1. Features #

• Initialize AWS S3 service with identity pool or access keys
• Upload files to S3 buckets
• Download files from S3 buckets
• List files in S3 buckets
• Delete files from S3 buckets
• Cross-platform support (iOS, Android)

2. Getting started #

Add this to your package's pubspec.yaml file:

dependencies:
  flutter_aws_s3service: ^0.0.1

3. Usage #

Initialize the S3 service #

You can initialize the service using either identity pool ID or access keys:

final s3service = FlutterAwsS3service();

// Initialize with identity pool ID
await s3service.initialize(
  region: 'YOUR_REGION',
  bucketName: 'YOUR_BUCKET_NAME',
  identityPoolId: 'YOUR_IDENTITY_POOL_ID',
);

// Or initialize with access keys
await s3service.initialize(
  region: 'YOUR_REGION',
  bucketName: 'YOUR_BUCKET_NAME',
  accessKeyId: 'YOUR_ACCESS_KEY_ID',
  secretAccessKey: 'YOUR_SECRET_ACCESS_KEY',
);

Upload a file #

// Upload a file and get the URL
final url = await s3service.uploadFile(
  filePath,  // Local file path
  key        // S3 object key (path in bucket)
);

List files in bucket #

// Get list of files from S3 bucket
final files = await s3service.listFiles();
// Returns List<Map<String, dynamic>> containing file information

Download a file #

// Download a file from S3
await s3service.downloadFile(
  key,        // S3 object key
  localPath   // Local path to save the file
);

Delete files #

// Delete a single file
await s3service.deleteFile(key);

// Delete multiple files
await s3service.deleteFiles(keys);

4. Example #

Check out the example folder for a complete demo application showing how to:

• Initialize the S3 service
• Upload files with progress tracking
• List files in the bucket
• Download files
• Delete files
• Handle errors

5. Additional information #

For more information about AWS S3, visit the AWS S3 documentation.

6. Development #

Create project #

1. Create plugin project:

flutter create -t plugin --platforms android,ios --org com.larack.s3service flutter_aws_s3service

2. tip word 修改lib/FlutterAwsS3service.dart代码，提供aws s3的上传、下载、删除、查看等相关操作，操作s3需传入bucket_name、region、identity_pool_id等参数，也可以通过s3的access_key_id、secret_access_key、region_name、aws_bucket_name等参数， 并通过android和ios原生方法去实现，比如android使用com.amazonaws: aws-android-sdk-s3来处理，最后在example中添加带测试用例的demo代码

Publish #

flutter pub publish --dry-run
flutter pub publish