Skip to content
BranchesTags

Repository files navigation

本文介绍 tencentcloud_cos_sdk_plugin 如何快速入门以及 API 介绍。

相关资源

准备工作

  1. 您需要一个纯 Flutter 项目或 Flutter 原生混合项目，这个应用可以是您现有的工程，也可以是您新建的一个空的工程。
  2. Flutter 版本要求（1.4.0 起）：
  sdk: ">=3.0.0 <4.0.0"
  flutter: ">=3.10.0"

1.3.x 及更早版本为 sdk: ">=2.15.0" / flutter: ">=2.5.0"。 鸿蒙平台还需使用 OpenHarmony 适配版 Flutter，详见文末鸿蒙章节。

第一步：SDK 介绍

tencentcloud_cos_sdk_plugin 目前兼容支持 iOS、Android、HarmonyOS NEXT（鸿蒙），是通过 Flutter Plugin 桥接原生 Android、iOS 和 HarmonyOS 的 COS SDK 实现。

鸿蒙支持从 1.4.0 起提供，接入前请先阅读 鸿蒙（HarmonyOS）平台说明与差异。

第二步：集成 SDK

  1. 运行此命令：
flutter pub add tencentcloud_cos_sdk_plugin
  1. 这将向您的包的 pubspec.yaml 添加这样一行（并运行隐式 flutter pub get）
dependencies:
  tencentcloud_cos_sdk_plugin: ^1.4.0
  1. 在您的 Dart 代码中，您可以使用 import 进行导入，然后开始使用：
import 'package:tencentcloud_cos_sdk_plugin/cos.dart';

⚠️ 1.4.0 起最低环境要求提高：Dart >= 3.0.0、Flutter >= 3.10.0（原为 2.15.0 / 2.5.0）。

关闭腾讯灯塔上报功能

为了持续跟踪和优化 SDK 的质量，给您带来更好的使用体验，我们在 SDK 中引入了 腾讯灯塔 SDK，腾讯灯塔只对 COS 侧的请求性能进行监控，不会上报业务侧数据。 若是想关闭该功能，可以在依赖引入和 import 时将 tencentcloud_cos_sdk_plugin 替换为 tencentcloud_cos_sdk_plugin_nobeacon即可。

第三步：开始使用

!

  • 建议用户 使用临时密钥 调用 SDK，通过临时授权的方式进一步提高 SDK 使用的安全性。申请临时密钥时，请遵循 最小权限指引原则，防止泄漏目标存储桶或对象之外的资源。
  • 如果您一定要使用永久密钥，建议遵循 最小权限指引原则 对永久密钥的权限范围进行限制。

1. 初始化密钥

实现获取临时密钥

实现一个 IFetchCredentials 的类，实现请求临时密钥并返回结果的过程。

import 'dart:convert';
import 'dart:io';

import 'package:tencentcloud_cos_sdk_plugin/fetch_credentials.dart';
import 'package:tencentcloud_cos_sdk_plugin/pigeon.dart';

class FetchCredentials implements IFetchCredentials{
  @override
  Future<SessionQCloudCredentials> fetchSessionCredentials() async {
    // 首先从您的临时密钥服务器获取包含了密钥信息的响应，例如：
    var httpClient = HttpClient();
    try {
      // 临时密钥服务器 url
      var stsUrl = "http://stsservice.com/sts";
      var request = await httpClient.getUrl(Uri.parse(stsUrl));
      var response = await request.close();
      if (response.statusCode == HttpStatus.OK) {
        var json = await response.transform(utf8.decoder).join();
        // 注意：不要打印 json 原文，它包含临时密钥明文（tmpSecretKey / sessionToken），
        // 会进入本地日志、CI 日志与崩溃上报。

        // 然后解析响应，获取临时密钥信息
        var data = jsonDecode(json);
        // 最后返回临时密钥信息对象
        return SessionQCloudCredentials(
            secretId: data['credentials']['tmpSecretId'],// 临时密钥 SecretId
            secretKey: data['credentials']['tmpSecretKey'],// 临时密钥 SecretKey
            token: data['credentials']['sessionToken'],// 临时密钥 Token
            startTime: data['startTime'],//临时密钥有效起始时间，单位是秒
            expiredTime: data['expiredTime']//临时密钥有效截止时间戳，单位是秒
        );
      } else {
        throw ArgumentError();
      }
    } catch (exception) {
      throw ArgumentError();
    }
  }
}

这里假设类名为 FetchCredentials。初始化一个实例，来给 SDK 提供密钥。

Cos().initWithSessionCredential(FetchCredentials());

实现获取限制范围的临时密钥

该方式可以更精细的控制临时密钥的使用范围，STSCredentialScope中包含了本次请求的action(操作)、region、bucket、prefix， 使用STSCredentialScope可以生成一个限定范围的临时密钥，例如根据prefix生成固定路径文件名的上传临时密钥，实现每个上传文件都有单独的临时密钥。

实现一个 IFetchScopeLimitCredentials 的类，实现请求限制范围的临时密钥并返回结果的过程。

import 'dart:convert';
import 'dart:io';

import 'package:flutter/foundation.dart';
import 'package:tencentcloud_cos_sdk_plugin/fetch_credentials.dart';
import 'package:tencentcloud_cos_sdk_plugin/pigeon.dart';

class FetchScopeLimitCredentials implements IFetchScopeLimitCredentials{
  @override
  Future<SessionQCloudCredentials> fetchScopeLimitCredentials(List<STSCredentialScope?> stsCredentialScopes) async {
    // 首先从您的临时密钥服务器获取包含了密钥信息的响应，例如：
    var httpClient = HttpClient();
    try {
      // 临时密钥服务器 url，临时密钥生成服务请参考 https://cloud.tencent.com/document/product/436/14048
      // 范围限制的临时密钥服务请参考：https://cloud.tencent.com/document/product/436/31923
      var stsUrl = "https://stsservice.com/sts/scope";
      var request = await httpClient.postUrl(Uri.parse(stsUrl));
      request.headers.contentType = ContentType.json;
      // 将范围实体列表转换为post body中的json
      final body = jsonifyScopes(stsCredentialScopes);
      if (kDebugMode) {
        print(body);
      }
      request.write(body);

      var response = await request.close();
      if (response.statusCode == HttpStatus.OK) {
        var json = await response.transform(utf8.decoder).join();
        // 同上：json 含密钥明文，请勿打印
        // 然后解析响应，获取临时密钥信息
        var data = jsonDecode(json);
        // 最后返回临时密钥信息对象
        return SessionQCloudCredentials(
            secretId: data['credentials']['tmpSecretId'],
            secretKey: data['credentials']['tmpSecretKey'],
            token: data['credentials']['sessionToken'],
            startTime: data['startTime'],
            expiredTime: data['expiredTime']
        );
      } else {
        throw ArgumentError();
      }
    } catch (exception) {
      if (kDebugMode) {
        print(exception);
      }
      throw ArgumentError();
    }
  }

  // 将范围实体列表转换为json
  String jsonifyScopes(List<STSCredentialScope?> scopes) {
    List<Map<String, String?>> scopeList = [];
    for (STSCredentialScope? scope in scopes) {
      if(scope != null) {
        Map<String, String?> scopeMap = {
          'action': scope.action,
          'bucket': scope.bucket,
          'prefix': scope.prefix,
          'region': scope.region,
        };
        scopeList.add(scopeMap);
      }
    }
    return jsonEncode(scopeList);
  }
}

这里假设类名为 FetchScopeLimitCredentials。初始化一个实例，来给 SDK 提供密钥。

Cos().initWithScopeLimitCredential(FetchScopeLimitCredentials());

强制使本地保存的临时密钥失效

该功能可以强制使 COS SDK 已经缓存的临时密钥失效，包括无限制使用范围和限制使用范围的临时密钥，失效后再使用 COS 接口功能时 SDK 会重新向业务临时密钥服务端获取新的临时密钥。 调用方法：

await Cos().forceInvalidationCredential();

使用永久密钥进行本地调试

您可以使用腾讯云的永久密钥来进行开发阶段的本地调试。由于该方式存在泄漏密钥的风险，请务必在上线前替换为临时密钥的方式。

String SECRET_ID = "SECRETID"; //永久密钥 secretId
String SECRET_KEY = "SECRETKEY"; //永久密钥 secretKey

Cos().initWithPlainSecret(SECRET_ID, SECRET_KEY);

2. 注册 COS 服务

// 存储桶所在地域简称，例如广州地区是 ap-guangzhou
String region = "COS_REGION";
// 创建 CosXmlServiceConfig 对象，根据需要修改默认的配置参数
CosXmlServiceConfig serviceConfig = CosXmlServiceConfig(
    region: region,
    isDebuggable: true,
    isHttps: true,
);
// 注册默认 COS Service
Cos().registerDefaultService(serviceConfig);

// 创建 TransferConfig 对象，根据需要修改默认的配置参数
// TransferConfig 可以设置智能分块阈值 默认对大于或等于2M的文件自动进行分块上传，可以通过如下代码修改分块阈值
TransferConfig transferConfig = TransferConfig(
    forceSimpleUpload: false,
    enableVerification: true,
    divisionForUpload: 2097152, // 设置大于等于 2M 的文件进行分块上传
    sliceSizeForUpload: 1048576, //设置默认分块大小为 1M
);
// 注册默认 COS TransferManger
Cos().registerDefaultTransferManger(serviceConfig, transferConfig);

// 也可以通过 registerService 和 registerTransferManger 注册其他实例， 用于后续调用
// 一般用 region 作为注册的key
String newRegion = "NEW_COS_REGION";
Cos().registerService(newRegion, serviceConfig..region = newRegion);
Cos().registerTransferManger(newRegion, serviceConfig..region = newRegion, transferConfig);

参数说明

CosXmlServiceConfig 用于配置 COS 服务，其主要成员说明如下：

参数名称 描述 类型 默认值 支持平台
region 存储桶地域 地域和访问域名 String null Android和iOS
connectionTimeout 连接超时时间（单位是毫秒） Int Android(15000) iOS(30000) Android和iOS
socketTimeout 读写超时时间（单位是毫秒） Int 30000 Android
isHttps 是否使用https协议 Bool true Android和iOS
host 设置除了 GetService 请求外的 host String null Android和iOS
hostFormat 设置 host 的格式化字符串，sdk 会将 ${bucket} 替换为真正的 bucket，${region} 替换为真正的 region
例如将 hostFormat 设置为 ${bucket}.${region}.tencent.com，并且您的存储桶和地域分别为 bucket-1250000000 和 ap-shanghai，那么最终的请求地址为 bucket-1250000000.ap-shanghai.tencent.com
  • 注意，这个设置不会影响 GetService 请求
    		•  String null Android
    port 设置请求的端口 Int null Android
    isDebuggable 是否是 debug 模式（debug 模式会打印 debug 日志） Bool false Android
    signInUrl 是否将签名放在 URL 中，默认放在 Header 中 Bool false Android
    userAgent ua 拓展参数 String null Android和iOS
    dnsCache 是否开启 DNS 解析缓存，开启后，将 DNS 解析的结果缓存在本地，当系统 DNS 解析失败后，会使用本地缓存的 DNS 结果 Bool true Android
    accelerate 是否使用全球加速域名 Bool false Android和iOS

    TransferConfig 用于配置 COS 上传服务，其主要成员说明如下：

    参数名称 描述 类型 默认值 支持平台
    divisionForUpload 设置启用分块上传的最小对象大小 Int 2097152 Android和iOS
    sliceSizeForUpload 设置分块上传时的分块大小 Int 1048576 Android和iOS
    enableVerification 分片上传时是否整体校验 Bool true Android和iOS
    forceSimpleUpload 是否强制使用简单上传 Bool false Android

    第四步：访问 COS 服务

    上传对象

    SDK 支持上传本地文件、二进制数据。下面以上传本地文件为例：

        // 获取 TransferManager
    CosTransferManger transferManager = Cos().getDefaultTransferManger();
    //CosTransferManger transferManager = Cos().getTransferManger("newRegion");
    // 存储桶名称，由 bucketname-appid 组成，appid 必须填入，可以在 COS 控制台查看存储桶名称。 https://console.cloud.tencent.com/cos5/bucket
    String bucket = "examplebucket-1250000000";
    String cosPath = "exampleobject"; //对象在存储桶中的位置标识符，即称对象键
    String srcPath = "本地文件的绝对路径"; //本地文件的绝对路径
    //若存在初始化分块上传的 UploadId，则赋值对应的 uploadId 值用于续传；否则，赋值 null
    String? _uploadId;

    // 上传成功回调
    successCallBack(result) {
      // todo 上传成功后的逻辑
    }
    //上传失败回调
    failCallBack(clientException, serviceException) {
      // todo 上传失败后的逻辑
      if (clientException != null) {
        print(clientException);
      }
      if (serviceException != null) {
        print(serviceException);
      }
    }
    //上传状态回调, 可以查看任务过程
    stateCallback(state) {
      // todo notify transfer state
    }
    //上传进度回调
    progressCallBack(complete, target) {
      // todo Do something to update progress...
    }
    //初始化分块完成回调
    initMultipleUploadCallback(
        String bucket, String cosKey, String uploadId) {
      //用于下次续传上传的 uploadId
      _uploadId = uploadId;
    }
    //开始上传
    TransferTask transferTask = await transferManager.upload(bucket, cosPath,
        filePath: srcPath,
        uploadId: _uploadId,
        resultListener: ResultListener(successCallBack, failCallBack),
        stateCallback: stateCallback,
        progressCallBack: progressCallBack,
        initMultipleUploadCallback: initMultipleUploadCallback
    );
    //暂停任务
    transferTask.pause();
    //恢复任务
    transferTask.resume();
    //取消任务
    transferTask.cancel();

    下载对象

        // 高级下载接口支持断点续传，所以会在下载前先发起 HEAD 请求获取文件信息。
    // 如果您使用的是临时密钥或者使用子账号访问，请确保权限列表中包含 HeadObject 的权限。

    // TransferManager 支持断点下载，您只需要保证 bucket、cosPath、savePath
    // 参数一致，SDK 便会从上次已经下载的位置继续下载。

    // 获取 TransferManager
    CosTransferManger transferManager = Cos().getDefaultTransferManger();
    //CosTransferManger transferManager = Cos().getTransferManger("newRegion");
    // 存储桶名称，由 bucketname-appid 组成，appid 必须填入，可以在 COS 控制台查看存储桶名称。 https://console.cloud.tencent.com/cos5/bucket
    String bucket = "examplebucket-1250000000";
    String cosPath = "exampleobject"; //对象在存储桶中的位置标识符，即称对象键
    String downliadPath = "本地文件的绝对路径"; //保存到本地文件的绝对路径

    // 下载成功回调
    successCallBack(result) {
      // todo 下载成功后的逻辑
    }
    //下载失败回调
    failCallBack(clientException, serviceException) {
      // todo 下载失败后的逻辑
      if (clientException != null) {
        print(clientException);
      }
      if (serviceException != null) {
        print(serviceException);
      }
    }
    //下载状态回调, 可以查看任务过程
    stateCallback(state) {
      // todo notify transfer state
    }
    //下载进度回调
    progressCallBack(complete, target) {
      // todo Do something to download progress...
    }
    //开始下载
    TransferTask transferTask = await transferManager.download(bucket, cosPath, downliadPath, 
        resultListener: ResultListener(successCallBack, failCallBack),
        stateCallback: stateCallback,
        progressCallBack: progressCallBack
    );
    //暂停任务
    transferTask.pause();
    //恢复任务
    transferTask.resume();
    //取消任务
    transferTask.cancel();

    鸿蒙（HarmonyOS）平台说明与差异

    鸿蒙支持自 1.4.0 起提供，通过桥接 鸿蒙 COS SDK（@tencentcloud/cos）实现。 下面列出的差异都是已实测确认的，请在接入前评估。

    环境要求

    项 要求
    Flutter OpenHarmony 适配版（官方 Flutter 不支持鸿蒙）。推荐 3.27.5-ohos-1.0.7，见 CPF-Flutter/flutter_flutter
    鸿蒙 COS SDK @tencentcloud/cos >= 1.2.5
    DevEco Studio 5.0+（含 ohpm / hvigor / node 工具链）
    鸿蒙 SDK API 12+

    必须自行声明的权限

    鸿蒙的 HAR 不能声明权限，接入方必须在 app 的 entry 模块 src/main/module.json5 中声明，否则所有网络请求都会失败：

    {
  "module": {
    "requestPermissions": [
      { "name": "ohos.permission.INTERNET" }
    ]
  }
}

    不支持 / 降级的能力

    调用这些 API 在鸿蒙上不会崩溃，但不会产生效果（首次调用会打一条 warn 日志说明）。请勿在鸿蒙上依赖它们：

    能力 鸿蒙状态 说明
    日志与 CLS 共 16 项
    enableLogFile / setMinLevel / setLogcatMinLevel / setFileMinLevel / setClsMinLevel / setDeviceID / setDeviceModel / setAppVersion / setExtras / setLogFileEncryptionKey / getLogRootDir / setCLsChannel* / addSensitiveRule / removeSensitiveRule    		 ❌ 不支持 鸿蒙 COS SDK 的 QCloudLogger 只有 hilog 输出，没有落文件、结构化监听、CLS 上报、日志加密与脱敏能力。从零补齐等于新写一套日志子系统，本期不做
    addLogListener ⚠️ 降级 底层只提供「已格式化字符串」的单个全局回调，LogEntity 仅 timestamp/message 为真实值，level 恒为 INFO、category 恒为 PROCESS，threadName/extras/throwable 拿不到。不要按 level/category 过滤
    initWithScopeLimitCredential（范围限制签名） ❌ 不支持 鸿蒙 CredentialCallBack 无法从待签请求中取到 action/bucket/region，无法还原 scope。会退化为普通临时密钥并 warn。该能力在 Android/iOS 侧亦已基本废弃
    initCustomerDNSFetch（动态 DNS 回调） ❌ 不支持 鸿蒙 rcp.DnsConfiguration 只支持静态映射，无 per-request 回调。需自定义网络层才能实现，本期未做
    initCustomerDNS（静态 DNS 映射） ⚠️ 有限制 鸿蒙 rcp.StaticDnsRule 强制要求 port，而 Flutter 侧只给域名。已按 config 推导（显式 port > https:443 / http:80）；端口不匹配时规则静默不命中
    setCloseBeacon ⭕ 空实现 鸿蒙 COS SDK 无灯塔/上报模块，本就无需关闭
    config.dnsCache ⭕ 空实现 鸿蒙无对应开关
    config.isDebuggable ⚠️ 全局生效 鸿蒙 setDebuggable 是静态方法，多 service 实例配不同值会互相覆盖
    TransferConfig.forceSimpleUpload ❌ 不支持 鸿蒙无对应字段。用「把分块阈值设为极大」模拟会在 >5GB 时失败，故不做假实现
    TransferConfig.enableVerification ❌ 不支持 鸿蒙无 CRC64 校验开关
    TransferConfig（下载方向） ⚠️ 无效 鸿蒙 download() 不接受 TransferConfig，相关字段仅对上传生效
    CosXmlServiceException.httpMsg ⚠️ 近似值 鸿蒙不返回 HTTP reason phrase，按 statusCode 查标准表近似
    CosXmlServiceException.serviceName ⚠️ 固定值 固定为 "cos"

    行为差异（需要注意，但功能可用）

    项 差异
    暂停/取消的失败回调 · 三端一致：主动 pause() / cancel()（下载、filePath 上传）不会触发 resultFailCallback，状态稳定停在 PAUSED / CANCELED；仅系统级取消（非用户主动）才经 FAILED 上报。
    · iOS 特例（SDK 限制）：byteArr（NSData）上传不支持断点续传，pause() 会退化为取消并触发一次 resultFailCallback、状态落到 FAILED。
    TransferState 取值 鸿蒙只产生 WAITING（少数场景）/ IN_PROGRESS / PAUSED / COMPLETED / CANCELED / FAILED，不会产生 CONSTRAINED / RESUMED_WAITING / UNKNOWN
    initMultipleUploadCallback 鸿蒙底层只回 uploadId，bucket / cosKey 由插件层用发起入参补齐（值正确）
    config.userAgent 鸿蒙是覆盖语义（Android 是追加）。插件层已自动拼成 cos-harmony-sdk-{版本} FlutterPlugin 以保留版本信息
    getPresignedUrl 的 signValidTime 鸿蒙无独立的「签名有效期」概念，实际时长 = min(signValidTime, 密钥剩余有效期)
    doesBucketExist / doesObjectExist 接口签名没有 region 参数（Android 亦然），内部回落到 config.region。跨地域探测会因域名拼错而返回 false。跨地域场景请改用带 region 的 headBucket / headObject
    多实例的全局状态 鸿蒙侧 CredentialCache、isDebuggable、任务并发数、session 均为全局单例，多 service 配不同值时会互相影响

    发版门禁：三端一致性测试

    本插件桥接三套原生 SDK，有一类缺陷编译器完全不报、且只在特定取值下暴露。历史上真实发生过：

    • iOS ABI 失配（NSNumber* vs BOOL）：传 false 因指针恰为 nil 而"碰巧正确"，传 true 时指针为 0x1 → SIGSEGV。只测 false 会全绿。
    • 指针→BOOL 静默转换：@NO 也是非空指针，转 BOOL 恒为 true（isTruncated 曾因此恒真，分页逻辑全错）。只测 true 会全绿。
    • 鸿蒙子请求未继承 region：只在跨地域场景 404，同地域一切正常。

    因此每次发版前必须三端全绿，且测试中每个布尔参数都成对验证 true / false。

    运行

    # 三端全跑（需三端模拟器/真机均已启动）
scripts/release_gate.sh

# 只跑指定端
scripts/release_gate.sh android ios

# 指定设备与鸿蒙 Flutter 路径
ANDROID_DEVICE=emulator-5554 \
IOS_DEVICE=<simulator-udid> \
OHOS_DEVICE=127.0.0.1:5557 \
OHOS_FLUTTER=/path/to/flutter_flutter \
  scripts/release_gate.sh

    退出码 0 = 全部通过；非 0 = 有平台未通过（含被跳过的平台）。

    覆盖内容

    组 用例
    布尔参数双向 isHttps、domainSwitch、accelerate、signHost、putBucketVersioning、putBucketAccelerate、enableLogcat/enableLogFile、setCloseBeacon、addLogListener —— 每项都测 true 与 false
    类型边界 getBucket 的 maxKeys/size；isTruncated 双向可变（maxKeys=1 必为 true、maxKeys=1000 必为 false —— 这是抓"恒为 true"缺陷的关键）；byteArr 上传后下载回来逐字节比对
    预签名跨端一致性 固定入参下断言 URL 结构与参数集合，并打印 PRESIGN-SHAPE（含 q-header-list，直接反映 Host 是否入签）供三端比对
    传输状态机 pause 不被误报为 FAILED、状态跃迁、pause→resume 后任务必须终结（不能静默卡死）
    凭证失败 无效凭证应快速失败（不卡到超时）且错误码可用

    实现位置

    • Android / iOS：example/integration_test/cos_consistency_test.dart
    • 鸿蒙：同源断言在 example/lib/test/transfer_verify_page.dart（--dart-define=COS_VERIFY=true 启用）。 鸿蒙无法直接用 flutter test integration_test（走需签名的安装路径），门禁脚本改用 build hap → bm install（unsigned 即可）→ 启动验证页 → 从 hilog 抓 COSVERIFY| 断言。

    前置条件

    • example/lib/config/config.dart 已配置可用的 STS 服务与 APPID（该文件已被 gitignore，需自行创建，模板见 config.template）
    • 测试会在桶内写入 it/ 前缀的测试对象，并临时开关该桶的 versioning / accelerate（用后复原）
    • 鸿蒙端需 OpenHarmony 适配版 Flutter 与 DevEco 工具链

    About

    对象存储COS Flutter语言SDK（桥接plugin实现）

    Resources

    Readme
    Apache-2.0 license
    Activity
    Custom properties

    Stars

    11 stars

    Watchers

    1 watching

    Forks

    14 forks
    Report repository

    Releases

    Packages

    Used by

    Contributors

    Languages