Flutter AWS S3存储插件simple_s3的使用

简介

simple_s3 是一个高级且易于使用的AWS S3插件，支持文件上传和删除功能。它使用AWS原生SDK为iOS和Android提供服务。

特性

快速开始

添加依赖

在pubspec.yaml中添加以下依赖：

dependencies:
  simple_s3: ^0.3.2

示例代码

以下是一个完整的示例应用，展示了如何使用simple_s3插件进行文件上传和删除操作。

import 'dart:async';
import 'dart:io';

import 'package:flutter/material.dart';
import 'package:image_picker/image_picker.dart';
import 'package:simple_s3/simple_s3.dart';
// 假设Credentials.dart文件中有以下内容：
// const String s3_bucketName = "your-bucket-name";
// const String s3_poolD = "your-pool-id";

void main() => runApp(MyApp());

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      debugShowCheckedModeBanner: false,
      title: "S3 Upload/Delete Demo",
      home: Scaffold(body: SimpleS3Test()),
    );
  }
}

class SimpleS3Test extends StatefulWidget {
  @override
  SimpleS3TestState createState() => SimpleS3TestState();
}

class SimpleS3TestState extends State<SimpleS3Test> {
  File? selectedFile;

  SimpleS3 _simpleS3 = SimpleS3();
  bool isLoading = false;
  bool uploaded = false;

  @override
  void dispose() {
    super.dispose();
  }

  @override
  void initState() {
    super.initState();
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        centerTitle: true,
        title: StreamBuilder<dynamic>(
            stream: _simpleS3.getUploadPercentage,
            builder: (context, snapshot) {
              return new Text(
                snapshot.data == null ? "Simple S3 Test" : "Uploaded: ${snapshot.data}",
              );
            }),
      ),
      body: Center(
        child: selectedFile != null
            ? isLoading
                ? CircularProgressIndicator()
                : Image.file(selectedFile!)
            : GestureDetector(
                onTap: () async {
                  final pickedFile = await ImagePicker().getImage(source: ImageSource.gallery);
                  if (pickedFile != null) {
                    setState(() {
                      selectedFile = File(pickedFile.path);
                    });
                  }
                },
                child: Icon(
                  Icons.add,
                  size: 30,
                ),
              ),
      ),
      floatingActionButton: !isLoading
          ? FloatingActionButton(
              backgroundColor: uploaded ? Colors.green : Colors.blue,
              child: Icon(
                uploaded ? Icons.delete : Icons.arrow_upward,
                color: Colors.white,
              ),
              onPressed: () async {
                if (uploaded) {
                  print(await SimpleS3.delete(
                      "test/${selectedFile!.path.split("/").last}", 
                      Credentials.s3_bucketName, 
                      Credentials.s3_poolD, 
                      AWSRegions.apSouth1,
                      debugLog: true));
                  setState(() {
                    selectedFile = null;
                    uploaded = false;
                  });
                }
                if (selectedFile != null) _upload();
              },
            )
          : null,
    );
  }

  Future<String?> _upload() async {
    try {
      setState(() {
        isLoading = true;
      });
      final result = await _simpleS3.uploadFile(
        selectedFile!,
        Credentials.s3_bucketName,
        Credentials.s3_poolD,
        AWSRegions.apSouth1,
        debugLog: true,
        s3FolderPath: "test",
        accessControl: S3AccessControl.publicRead,
      );

      setState(() {
        uploaded = true;
        isLoading = false;
      });

      return result;
    } catch (e) {
      print(e);
      return null;
    }
  }
}

注意事项

• Android Release Mode：如果在Android发布模式下遇到问题，请确保在app/build.gradle中正确配置Proguard规则。具体步骤如下：

  buildTypes {
    release {
      signingConfig signingConfigs.release
      minifyEnabled true
      useProguard true
      proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-aws-2.1.5.pro'
    }
  }
  

  并将proguard-aws-2.1.5.pro的内容复制到项目的app目录下。

通过以上步骤，您可以顺利地在Flutter项目中集成并使用simple_s3插件进行AWS S3的文件上传和删除操作。