对象存储 快速入门（Flutter SDK）

一、相关资源

·SDK 源码下载请参见 Flutter SDK。

·示例 Demo 请参见 Flutter SDK Demo。

·SDK 更新日志请参见 CHANGELOG。

·SDK 常见问题请参见 Flutter SDK 常见问题。

·Pub 地址请参见 Pub 仓库地址。

二、环境配置与准备

·你需要一个纯 Flutter 项目或 Flutter 原生混合项目，这个应用可以是你现有的工程，也可以是你新建的一个空的工程。详情请参见 Flutter 开发指引。

·Flutter 版本要求：

注意：说明：

三、安装 SDK

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

1. 运行以下命令。

flutter pub add tencentcloud_cos_sdk_plugin

2. 这将向你的包的 pubspec.yaml 添加这样一行（并运行隐式 flutter pub get）。

注意：为规避因自动升级导致的兼容性风险（如 ^1.2.0 会升级到 1.2.5 等小版本），建议生产环境固定版本号，你可关注 更新日志 确认当前版本稳定性。

dependencies: tencentcloud_cos_sdk_plugin: 1.4.0

3. 在你的 Dart 代码中，你可以使用 import 进行导入，然后开始使用。

import 'package:tencentcloud_cos_sdk_plugin/cos.dart';

注意：说明：

四、设置 API 访问密钥

单次临时密钥临时密钥回调固定密钥（仅测试）将单个密钥设置给具体 COS 操作方法的 sessionCredentials 参数（例如上传方法 upload 等），该密钥仅用于本次 COS 操作（例如上传等）。// 获取临时密钥（业务层控制获取的方式）String tmpSecretId = "SECRETID"; // 临时密钥 SecretIdString tmpSecretKey = "SECRETKEY"; // 临时密钥 SecretKeyString sessionToken = "SESSIONTOKEN"; // 临时密钥 Tokenint expiredTime = 1556183496;//临时密钥有效截止时间戳，单位是秒// 建议返回服务器时间作为签名的开始时间，避免由于用户手机本地时间偏差过大导致请求过期int startTime = 1556182000; //临时密钥有效起始时间，单位是秒SessionQCloudCredentials sessionQCloudCredentials = SessionQCloudCredentials( secretId: tmpSecretId, secretKey: tmpSecretKey, token: sessionToken, startTime: startTime, expiredTime: expiredTime);// 后续将 sessionQCloudCredentials 传入具体的 COS 操作方法注意：COS Flutter SDK 版本需要大于等于 v1.2.4。采用回调的方式给 COS SDK 提供获取临时密钥的方法，SDK 会在首次和缓存的临时密钥快过期时使用该回调重新获取临时密钥。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';// 实现一个 IFetchCredentials 的类，实现请求临时密钥并返回结果的过程。class FetchCredentials implements IFetchCredentials{ @override Future<SessionQCloudCredentials> fetchSessionCredentials() async { // 首先从你的临时密钥服务器获取包含了密钥信息的响应，例如： var httpClient = HttpClient(); try { // 临时密钥服务器 url，临时密钥生成服务请参考 https://cloud.tencent.com/document/product/436/14048 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(); print(json); // 然后解析响应，获取临时密钥信息 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 提供密钥。await Cos().initWithSessionCredential(FetchCredentials());你可以使用腾讯云的永久密钥来进行开发阶段的本地调试。由于该方式存在泄露密钥的风险，请务必在上线前替换为临时密钥的方式。String SECRET_ID = "SECRETID"; //用户的 SecretId，建议使用子账号密钥，授权遵循最小权限指引，降低使用风险。子账号密钥获取可参见 https://cloud.tencent.com/document/product/598/37140String SECRET_KEY = "SECRETKEY"; //用户的 SecretKey，建议使用子账号密钥，授权遵循最小权限指引，降低使用风险。子账号密钥获取可参见 https://cloud.tencent.com/document/product/598/37140await Cos().initWithPlainSecret(SECRET_ID, SECRET_KEY);

五、初始化 COS

// 存储桶所在地域简称，例如广州地区是 ap-guangzhouString region = "COS_REGION";// 创建 CosXmlServiceConfig 对象，根据需要修改默认的配置参数CosXmlServiceConfig serviceConfig = CosXmlServiceConfig( region: region, isDebuggable: true, isHttps: true,);// 注册默认 COS Serviceawait Cos().registerDefaultService(serviceConfig);// 创建 TransferConfig 对象，根据需要修改默认的配置参数// TransferConfig 可以设置智能分块阈值 默认对大于或等于2M的文件自动进行分块上传，可以通过如下代码修改分块阈值TransferConfig transferConfig = TransferConfig( forceSimpleUpload: false, enableVerification: true, divisionForUpload: 2097152, // 设置大于等于 2M 的文件进行分块上传 sliceSizeForUpload: 1048576, //设置默认分块大小为 1M);// 注册默认 COS TransferMangerawait Cos().registerDefaultTransferManger(serviceConfig, transferConfig);// 也可以通过 registerService 和 registerTransferManger 注册其他实例， 用于后续调用// 一般用 region 作为注册的 keyString newRegion = "NEW_COS_REGION";await Cos().registerService(newRegion, serviceConfig..region = newRegion);await Cos().registerTransferManger(newRegion, serviceConfig..region = newRegion, transferConfig);

六、参数说明

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

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

七、访问 COS 服务

上传对象下载对象说明：更多完整示例，请前往 GitHub 查看。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(Map<String?, String?>? header, CosXmlResult? 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, // 此处配置单次临时密钥，如果不是单次临时密钥的方式不传该参数 sessionCredentials: sessionQCloudCredentials ); //暂停任务 //transferTask.pause(); //恢复任务 //transferTask.resume(); //取消任务 //transferTask.cancel();说明：更多完整示例，请前往 GitHub 查看。 // 高级下载接口支持断点续传，所以会在下载前先发起 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 downloadPath = "本地文件的绝对路径"; //保存到本地文件的绝对路径 // 下载成功回调 successCallBack(Map<String?, String?>? header, CosXmlResult? 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, downloadPath, resultListener: ResultListener(successCallBack, failCallBack), stateCallback: stateCallback, progressCallBack: progressCallBack, // 此处配置单次临时密钥，如果不是单次临时密钥的方式不传该参数 sessionCredentials: sessionQCloudCredentials ); //暂停任务 //transferTask.pause(); //恢复任务 //transferTask.resume(); //取消任务 //transferTask.cancel();

八、常见问题

你在使用过程中可能会碰到的一些常见问题，相关的解决办法可参见 Flutter SDK 常见问题。