flutter---->阿里雲oss的外掛

huhx發表於2023-03-26

Flutter阿里

目前為止，阿里雲官方並沒有dart版本的oss sdk，所以才開發了這個外掛flutter_oss_aliyun提供對oss sdk的支援。

flutter_oss_aliyun

一個訪問阿里雲oss並且支援STS臨時訪問憑證訪問OSS的flutter庫，基本上涵蓋阿里雲oss sdk的所有功能。⭐

flutter pub: https://pub.dev/packages/flutter_oss_aliyun

github : https://github.com/huhx/flutter_oss_aliyun

oss sts document: https://help.aliyun.com/document_detail/100624.html

? 初始化Client

新增依賴

dependencies:
  flutter_oss_aliyun: ^6.2.2

初始化oss client, 這裡我們提供兩種方式

1. 提供sts server地址，需要後端新增這個api

Client.init(
    stsUrl: "server url get sts token",
    ossEndpoint: "oss-cn-beijing.aliyuncs.com",
    bucketName: "bucket name",
);

後端api至少需要返回以下資料:

{
  "AccessKeyId": "AccessKeyId",
  "AccessKeySecret": "AccessKeySecret",
  "SecurityToken": "SecurityToken",
  "Expiration": "2022-03-22T11:33:06Z"
}

2. 自定義authGetter得到Auth

Client.init(
    ossEndpoint: "oss-cn-beijing.aliyuncs.com",
    bucketName: "bucketName",
    authGetter: _authGetter
);

Auth _authGetter() {
  return Auth(
      accessKey: "accessKey",
      accessSecret: 'accessSecret',
      expire: '2023-02-23T14:02:46Z',
      secureToken: 'token',
  );
}

你可以傳入自定義的Dio

在init函式中，你可以傳入dio，做到dio的定製化。比如日誌或者其他的interceptors.

Client.init(
    stsUrl: "server url get sts token",
    ossEndpoint: "oss-cn-beijing.aliyuncs.com",
    bucketName: "bucket name",
    dio: Dio(BaseOptions(connectTimeout: 9000)),
);

? 使用

檔案上傳

關於callback的使用: https://help.aliyun.com/document_detail/31989.htm?spm=a2c4g.11186623.0.0.73a830ffn45LMY#reference-zkm-311-hgb

final bytes = "file bytes".codeUnits;

await Client().putObject(
  bytes,
  "test.txt",
  option: PutRequestOption(
    onSendProgress: (count, total) {
      print("send: count = $count, and total = $total");
    },
    onReceiveProgress: (count, total) {
      print("receive: count = $count, and total = $total");
    },
    override: false,
    aclModel: AclMode.publicRead,
    storageType: StorageType.ia,
    headers: {"cache-control": "no-cache"},
    callback: Callback(
      callbackUrl: "callback url",
      callbackBody: "{\"mimeType\":\${mimeType}, \"filepath\":\${object},\"size\":\${size},\"bucket\":\${bucket},\"phone\":\${x:phone}}",
      callbackVar: {"x:phone": "android"},
      calbackBodyType: CalbackBodyType.json,
    ),       
  ),
);

PutRequestOption 欄位說明,欄位皆為非必需

Filed	Default value	Description
override	true	true: 允許覆蓋同名Object false: 禁止覆蓋同名Object
aclModel	inherited	1. publicWrite: 任何人（包括匿名訪問者）都可以對該Object進行讀寫操作 2. publicRead: 只有該Object的擁有者可以對該Object進行寫操作，任何人（包括匿名訪問者）都可以對該Object進行讀操作 3. private: 只有Object的擁有者可以對該Object進行讀寫操作，其他人無法訪問該Object 4. inherited: 該Object遵循Bucket的讀寫許可權，即Bucket是什麼許可權，Object就是什麼許可權參考檔案: https://help.aliyun.com/document_detail/100676.htm?spm=a2c4g.11186623.0.0.56637952SnxOWV#concept-blw-yqm-2gb
storageType	Standard	參考檔案: https://help.aliyun.com/document_detail/51374.htm?spm=a2c4g.11186623.0.0.56632b55htpEQX#concept-fcn-3xt-tdb

追加檔案上傳

final Response<dynamic> resp = await Client().appendObject(
  Uint8List.fromList(utf8.encode("Hello World")),
  "test_append.txt",
);

final Response<dynamic> resp2 = await Client().appendObject(
  position: int.parse(resp.headers["x-oss-next-append-position"]?[0]),
  Uint8List.fromList(utf8.encode(", Fluter.")),
  "test_append.txt",
);

跨bucket複製檔案

final Response<dynamic> resp = await Client().copyObject(
  const CopyRequestOption(
    sourceFileKey: 'test.csv',
    targetFileKey: "test_copy.csv",
    targetBucketName: "bucket_2"
  ),
);

取消檔案上傳

final CancelToken cancelToken = CancelToken();
final bytes = ("long long bytes" * 1000).codeUnits;

Client().putObject(
  Uint8List.fromList(utf8.encode(string)),
  "cancel_token_test.txt",
  cancelToken: cancelToken,
  option: PutRequestOption(
    onSendProgress: (count, total) {
      if (kDebugMode) {
        print("send: count = $count, and total = $total");
      }
      if (count > 56) {
        cancelToken.cancel("cancel the uploading.");
      }
    },
  ),
).then((response) {
  // success
  print("upload success = ${response.statusCode}");
}).catchError((err) {
  if (CancelToken.isCancel(err)) {
    print("error message = ${err.message}");
  } else {
    // handle other errors
  }
});

批次檔案上傳

await Client().putObjects([
  AssetEntity(
    filename: "filename1.txt",
    bytes: "files1".codeUnits,
    option: PutRequestOption(
      onSendProgress: (count, total) {
        print("send: count = $count, and total = $total");
      },
      onReceiveProgress: (count, total) {
        print("receive: count = $count, and total = $total");
      },
      aclModel: AclMode.private,
    ),
  ),
  AssetEntity(filename: "filename2.txt", bytes: "files2".codeUnits),
]);

本地檔案上傳

final Response<dynamic> resp = await Client().putObjectFile(
  "/Users/aaa.pdf",
  fileKey: "aaa.png",
  option: PutRequestOption(
    onSendProgress: (count, total) {
      print("send: count = $count, and total = $total");
    },
    onReceiveProgress: (count, total) {
      print("receive: count = $count, and total = $total");
    },
    aclModel: AclMode.private,
  ),
);

批次本地檔案上傳

final List<Response<dynamic>> resp = await Client().putObjectFiles(
  [
    AssetFileEntity(
      filepath: "//Users/private.txt",
      option: PutRequestOption(
        onSendProgress: (count, total) {
          print("send: count = $count, and total = $total");
        },
        onReceiveProgress: (count, total) {
          print("receive: count = $count, and total = $total");
        },
        override: false,
        aclModel: AclMode.private,
      ),
    ),
    AssetFileEntity(
      filepath: "//Users/splash.png",
      filename: "aaa.png",
      option: PutRequestOption(
        onSendProgress: (count, total) {
          print("send: count = $count, and total = $total");
        },
        onReceiveProgress: (count, total) {
          print("receive: count = $count, and total = $total");
        },
        override: true,
      ),
    ),
  ],
);

檔案下載

await Client().getObject(
  "test.txt",
  onReceiveProgress: (count, total) {
    debugPrint("received = $count, total = $total");
  },
);

檔案下載並儲存

await Client().downloadObject(
  "test.txt",
  "./example/test.txt",
  onReceiveProgress: (count, total) {
    debugPrint("received = $count, total = $total");
  },
);

檔案刪除

await Client().deleteObject("test.txt");

批次檔案刪除

await Client().deleteObjects(["filename1.txt", "filename2.txt"]);

獲取已簽名的檔案url

需要注意的是: 這個操作並不安全，因為url包含security-token資訊，即使過期時間比較短. 這個url可以直接在瀏覽器訪問

final String url = await Client().getSignedUrl("filename1.txt");

獲取多個已簽名的檔案url

需要注意的是: 這個操作並不安全，因為url包含security-token資訊，即使過期時間比較短

final Map<String, String> result = await Client().getSignedUrls(["test.txt", "filename1.txt"]);

列舉所有的儲存空間

列舉請求者擁有的所有儲存空間（Bucket）。您還可以透過設定prefix、marker或者max-keys引數列舉滿足指定條件的儲存空間。參考: https://help.aliyun.com/document_detail/31957.html

final Response<dynamic> resp = await Client().listBuckets({"max-keys": 2});

列舉儲存空間中所有檔案

介面用於列舉儲存空間（Bucket）中所有檔案（Object）的資訊。請求引數和返回結果，請參考: https://help.aliyun.com/document_detail/187544.html

final Response<dynamic> resp = await Client().listFiles({});

獲取bucket資訊

檢視儲存空間（Bucket）的相關資訊。返回結果請參考: https://help.aliyun.com/document_detail/31968.html

final Response<dynamic> resp = await Client().getBucketInfo();

獲取bucket的儲容量以及檔案數量

獲取指定儲存空間（Bucket）的儲存容量以及檔案（Object）數量。返回結果請參考: https://help.aliyun.com/document_detail/426056.html

final Response<dynamic> resp = await Client().getBucketStat();

獲取檔案元資訊

final Response<dynamic> resp = await Client().getObjectMeta("huhx.csv");

regions的查詢

查詢所有

final Response<dynamic> resp = await Client().getAllRegions();

查詢特定

final Response<dynamic> resp = await Client().getRegion("oss-ap-northeast-1");

bucket acl的操作

查詢

final Response<dynamic> resp = await Client().getBucketAcl(
  bucketName: "bucket-name",
);

更新

final Response<dynamic> resp = await Client().putBucketAcl(
  AciMode.publicRead, 
  bucketName: "bucket-name",
);

bucket policy的操作

查詢

final Response<dynamic> resp = await Client().getBucketPolicy(
  bucketName: "bucket-name",
);

更新

final Response<dynamic> resp = await Client().putBucketPolicy(
  {}, 
  bucketName: "bucket-name",
);

刪除

final Response<dynamic> resp = await Client().deleteBucketPolicy(
  bucketName: "bucket-name",
);

蘋果CMS 阿里雲OSS外掛
2024-06-18
蘋果阿里
阿里雲oss配置:
2024-07-12
阿里
阿里雲圖床(PicGo+阿里雲OSS)搭建
2024-08-21
阿里圖床PicGo
android 阿里雲oss上傳
2018-09-23
Android阿里
jquery阿里雲oss 分片上傳
2021-11-03
jQuery阿里
Laravel 使用阿里雲 oss 儲存物件
2018-10-09
Laravel阿里物件
阿里雲OSS專案搭建筆記
2021-01-05
阿里筆記
阿里雲OSS雲端儲存管理實踐
2021-03-04
阿里
使用Typora + 阿里雲OSS + PicGo 打造自己的圖床
2022-04-28
阿里PicGo圖床
阿里雲智慧編碼外掛，更Cosy的開發體驗
2022-03-01
阿里
阿里雲 oss 檔案上傳小坑
2018-10-26
阿里
vue 圖片上傳到阿里雲oss
2018-07-09
Vue阿里
阿里雲CDN+OSS完成圖片加速
2019-06-27
阿里
Flutter 上傳圖片到阿里雲OSS
2021-03-31
Flutter阿里
自動化遷移七牛雲的資料到阿里雲OSS
2018-10-25
阿里
自動化遷移七牛雲的資料到阿里雲 OSS
2018-10-25
阿里
阿里OSS Select
2018-07-28
阿里
阿里雲物件儲存OSS支援版本管理特性
2019-04-03
阿里物件
小程式上傳圖片到阿里雲oss
2018-06-16
阿里
阿里雲 OSS 簽名上傳（結合 elementUI）
2020-01-15
阿里UI
flutter直接上傳檔案到阿里雲oss
2021-05-18
Flutter阿里
圖片裁剪並上傳到阿里雲oss
2020-12-08
阿里
擁抱雲原生，Fluid 結合 JindoFS：阿里雲 OSS 加速利器
2021-02-18
UI阿里
[外掛擴充套件]防護雲Iswaf外掛
2019-05-11
套件
vue 阿里雲oss下載檔案,自定義命名
2018-07-07
Vue阿里
Android圖片上傳到阿里雲OSS小案例
2018-08-23
Android阿里
【保姆級】阿里雲OSS+PicGo+Typora搭建圖床
2024-03-27
阿里PicGo圖床
最佳實踐：使用阿里雲CDN加速OSS訪問
2020-08-18
阿里
阿里雲物件儲存OSS及CDN加速配置
2021-01-01
阿里物件
阿里oss multipartUpload 錯誤
2019-01-21
阿里
Fusion Upload元件對接阿里雲OSS/七牛/又拍
2019-03-28
元件阿里
Springboot 遷移及上傳檔案至阿里雲OSS
2018-09-26
Spring Boot阿里
Spring Boot 整合阿里雲 OSS 進行檔案儲存
2020-09-11
Spring Boot阿里
SpringBoot使用阿里OSS實現檔案雲端儲存
2020-10-27
Spring Boot阿里
前端（react）上傳到阿里雲OSS儲存例項
2022-03-18
前端React阿里
Eclipse-阿里P3C外掛
2018-05-23
Eclipse阿里
二阿里大模型接入：自定義外掛
2024-05-25
阿里大模型
【故障公告】阿里雲OSS故障造成圖片無法上傳
2023-11-12
阿里