tencent cloud

对象存储

动态与公告
产品动态
产品公告
产品简介
产品概述
功能概览
应用场景
产品优势
基本概念
地域和访问域名
规格与限制
产品计费
计费概述
计费方式
计费项
免费额度
计费示例
查看和下载账单
欠费说明
常见问题
快速入门
控制台快速入门
COSBrowser 快速入门
用户指南
创建请求
存储桶
对象
数据管理
批量处理
全球加速
监控与告警
运维中心
数据处理
内容审核
智能工具箱
数据工作流
应用集成
工具指南
工具概览
环境安装与配置
COSBrowser 工具
COSCLI 工具
COSCMD 工具
COS Migration 工具
FTP Server 工具
Hadoop 工具
COSDistCp 工具
HDFS TO COS 工具
GooseFS-Lite 工具
在线辅助工具
自助诊断工具
实践教程
概览
访问控制与权限管理
性能优化
使用 AWS S3 SDK 访问 COS
数据容灾备份
域名管理实践
图片处理实践
COS 音视频播放器实践
工作流实践
数据直传
内容审核实践
数据安全
数据校验
大数据实践
COS 成本优化解决方案
在第三方应用中使用 COS
迁移指南
本地数据迁移至 COS
第三方云存储数据迁移至 COS
以 URL 作为源地址的数据迁移至 COS
COS 之间数据迁移
Hadoop 文件系统与 COS 之间的数据迁移
数据湖存储
云原生数据湖
元数据加速
数据加速器 GooseFS
数据处理
数据处理概述
图片处理
媒体处理
内容审核
文件处理
文档处理
故障处理
获取 RequestId 操作指引
通过外网上传文件至 COS 缓慢
访问 COS 时返回403错误码
资源访问异常
POST Object 常见异常
API 文档
简介
公共请求头部
公共响应头部
错误码
请求签名
操作列表
Service 接口
Bucket 接口
Object 接口
批量处理接口
数据处理接口
任务与工作流
内容审核接口
云查毒接口
SDK 文档
SDK 概览
准备工作
Android SDK
C SDK
C++ SDK
.NET(C#) SDK
Flutter SDK
Go SDK
iOS SDK
Java SDK
JavaScript SDK
Node.js SDK
PHP SDK
Python SDK
React Native SDK
小程序 SDK
错误码
鸿蒙(Harmony) SDK
终端 SDK 质量优化
安全与合规
数据容灾
数据安全
访问管理
常见问题
热门问题
一般性问题
计费计量问题
域名合规问题
存储桶配置问题
域名和 CDN 问题
文件操作问题
日志监控问题
权限管理问题
数据处理问题
数据安全问题
预签名 URL 问题
SDK 类问题
工具类问题
API 类问题
服务协议
Service Level Agreement
隐私政策
数据处理和安全协议
联系我们
词汇表

快速入门

PDF
聚焦模式
字号
最后更新时间: 2026-03-03 15:43:19

相关资源

SDK 源码下载请参见 Flutter SDK
示例 Demo 请参见 Flutter SDK Demo
SDK 更新日志请参见 CHANGELOG
SDK 常见问题请参见 Flutter SDK 常见问题
Pub 地址请参见 Pub 地址

环境配置与准备

您需要一个纯 Flutter 项目或 Flutter 原生混合项目,这个应用可以是您现有的工程,也可以是您新建的一个空的工程。详情请见 Flutter 开发指引
Flutter 版本要求:
sdk: ">=2.15.0 <4.0.0"
flutter: ">=2.5.0"

安装 SDK

tencentcloud_cos_sdk_plugin 目前兼容支持 iOS、Android,是通过 Flutter Plugin 桥接原生 AndroidiOS 的 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.2.6
3. 在您的 Dart 代码中,您可以使用 import 进行导入,然后开始使用。
import 'package:tencentcloud_cos_sdk_plugin/cos.dart';
说明:
为了持续跟踪和优化 SDK 的质量,给您带来更好的使用体验,我们在 SDK 中引入了 腾讯灯塔 SDK,腾讯灯塔只对 COS 侧的请求性能进行监控,不会上报业务侧数据。
若是想关闭该功能,可以在依赖引入import 时将 tencentcloud_cos_sdk_plugin 替换为 tencentcloud_cos_sdk_plugin_nobeacon 即可。

初始化 COS 服务

注意:
建议用户 使用临时密钥 调用 SDK,通过临时授权的方式进一步提高 SDK 使用的安全性。申请临时密钥时,请遵循 最小权限指引原则,防止泄露目标存储桶或对象之外的资源。
如果您一定要使用永久密钥,建议遵循 最小权限指引原则 对永久密钥的权限范围进行限制。
为了您的业务安全,上传文件可参见 上传安全限制

设置 API 访问密钥

单次临时密钥
临时密钥回调
固定密钥(仅测试)
将单个密钥设置给具体 COS 操作方法的 sessionCredentials 参数(例如上传方法 upload 等),该密钥仅用于本次 COS 操作(例如上传等)。
// 获取临时密钥(业务层控制获取的方式)
String tmpSecretId = "SECRETID"; // 临时密钥 SecretId
String tmpSecretKey = "SECRETKEY"; // 临时密钥 SecretKey
String sessionToken = "SESSIONTOKEN"; // 临时密钥 Token
int 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://www.tencentcloud.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://www.tencentcloud.com/document/product/598/37140?from_cn_redirect=1
String SECRET_KEY = "SECRETKEY"; //用户的 SecretKey,建议使用子账号密钥,授权遵循最小权限指引,降低使用风险。子账号密钥获取可参见 https://www.tencentcloud.com/document/product/598/37140?from_cn_redirect=1

await Cos().initWithPlainSecret(SECRET_ID, SECRET_KEY);

初始化 COS

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

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

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

参数说明

CosXmlServiceConfig 用于配置 COS 服务,其主要成员说明如下:
参数名称
描述
类型
默认值
支持平台
必选
region
存储桶所属地域,详情请参见 地域和访问域名
String
null
Android 和 iOS
isDebuggable
是否是 debug 模式(debug 模式会打印 debug 日志)
Bool
false
Android
isHttps
是否使用 https 协议
Bool
true
Android 和 iOS
connectionTimeout
连接超时时间(单位是毫秒)
Int
Android(15000)
iOS(30000)
Android 和 iOS
socketTimeout
读写超时时间(单位是毫秒)
Int
30000
Android
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
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 上传服务,其主要成员说明如下:
参数名称
描述
类型
默认值
支持平台
必选
forceSimpleUpload
是否强制使用简单上传
Bool
false
Android
enableVerification
分片上传时是否整体校验
Bool
true
Android 和 iOS
divisionForUpload
设置启用分块上传的最小对象大小
Int
2097152
Android 和 iOS
sliceSizeForUpload
设置分块上传时的分块大小
Int
1048576
Android 和 iOS

访问 COS 服务

上传对象
下载对象
说明:
更多完整示例,请前往 GitHub 查看。
SDK 支持上传本地文件、二进制数据。下面以上传本地文件为例:
// 获取 TransferManager
CosTransferManger transferManager = Cos().getDefaultTransferManger();
//CosTransferManger transferManager = Cos().getTransferManger("newRegion");
// 存储桶名称,由 bucketname-appid 组成,appid 必须填入,可以在 COS 控制台查看存储桶名称。 https://console.tencentcloud.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.tencentcloud.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 常见问题

帮助和支持

本页内容是否解决了您的问题?

填写满意度调查问卷,共创更好文档体验。

文档反馈