Flutter阿里云OSS存储插件better_aliyun_oss的使用

better_aliyun_oss

A Simple Aliyun OSS Upload for Flutter.

安装与开始

1. 添加依赖

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

dependencies:
  better_aliyun_oss: ^0.0.8

2. 安装依赖

运行以下命令安装依赖：

$ flutter pub get

常规用法

以下是一个简单的示例，展示如何使用 better_aliyun_oss 插件进行文件上传。

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

import 'package:better_aliyun_oss/better_aliyun_oss.dart';
import 'package:flutter/material.dart';
import 'package:path_provider/path_provider.dart';
import 'package:uuid/uuid.dart';

void main() {
  runApp(MyApp());
}

class MyApp extends StatefulWidget {
  [@override](/user/override)
  _MyAppState createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  late BetterAliyunOssClient ossClient;

  late StreamSubscription eventStreamSubscription;

  // 简单数据上传请求
  BetterAliyunOssClientRequest? simplePutRequest;

  [@override](/user/override)
  void initState() {
    super.initState();

    // 初始化 OSS 客户端
    ossClient = BetterAliyunOssClient(credentials);

    // 监听事件流
    eventStreamSubscription = ossClient.eventStream.listen((event) {
      print(event);
    });
  }

  [@override](/user/override)
  void dispose() {
    // 取消事件监听
    eventStreamSubscription.cancel();

    super.dispose();
  }

  // 获取临时文件路径
  Future<String> _getFilePath() async {
    final directory = await getTemporaryDirectory();
    return path.join(directory.path, "example.txt");
  }

  // 生成 OSS 凭证
  Future<BetterAliyunOssCredentials?> credentials() async {
    final credentials = {
      "SecurityToken": "",
      "AccessKeyId": "",
      "AccessKeySecret": "",
      "Expiration": "",
    };
    return BetterAliyunOssCredentials.fromMap(credentials);
  }

  // 简单上传文件
  void simpleUpload() async {
    // 创建一个示例文件
    final filePath = await _getFilePath();
    final file = File(filePath);
    await file.writeAsString("Hello OSS!");

    // 定义上传参数
    final objectFileName = Uuid().v1().replaceAll("-", "") + ".txt";
    final objectPath = "example/${DateTime.now().millisecondsSinceEpoch}/$objectFileName";

    // 执行上传
    simplePutRequest = ossClient.putObject(
      bucket: () async => "my-bucket",
      endpoint: () async => "oss-cn-hangzhou.aliyuncs.com",
      domain: () async => "https://domain.com",
      objectPath: objectPath,
      contentType: "text/plain",
      path: filePath,
    );

    print("简单数据上传请求 ID: ${simplePutRequest?.requestTaskId}");
  }

  // 取消简单上传
  void cancelSimpleUpload() {
    if (simplePutRequest != null) {
      ossClient.cancelPutObject(simplePutRequest!);
    }
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(title: Text('better_aliyun_oss 示例')),
        body: Center(
          child: Column(
            mainAxisAlignment: MainAxisAlignment.center,
            children: [
            // 简单上传按钮
            ElevatedButton(
              onPressed: simpleUpload,
              child: Text('简单上传'),
            ),
            // 取消上传按钮
            ElevatedButton(
              onPressed: cancelSimpleUpload,
              child: Text('取消上传'),
            ),
          ],
          ),
        ),
      ),
    );
  }
}