腾讯云对象存储快速入门

相关资源

SDK 源码下载示例 DemoSDK 更新日志Pub 地址

准备工作

1. 您需要一个纯 Flutter 项目或 Flutter 原生混合项目，这个应用可以是您现有的工程，也可以是您新建的一个空的工程。2. Flutter 版本要求：

  sdk: ">=2.15.0 <4.0.0"  flutter: ">=2.5.0"

第一步：SDK 介绍

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

第二步：集成 SDK

1. 运行此命令：

flutter pub add tencentcloud_cos_sdk_plugin

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

dependencies:  tencentcloud_cos_sdk_plugin: ^1.0.9

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

import 'package:tencentcloud_cos_sdk_plugin/cos.dart';

第三步：开始使用

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

1. 初始化密钥

实现获取临时密钥

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

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 FetchCredentials implements IFetchCredentials{  @override  Future 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 提供密钥。

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 fetchScopeLimitCredentials(List 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();        if (kDebugMode) {          print(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 scopes) {    List<Map> scopeList = [];    for (STSCredentialScope? scope in scopes) {      if(scope != null) {        Map 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"; //永久密钥 secretIdString SECRET_KEY = "SECRETKEY"; //永久密钥 secretKey
Cos().initWithPlainSecret(SECRET_ID, SECRET_KEY);

2. 注册 COS 服务

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

参数说明

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

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

第四步：访问 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();



对象存储官网1折活动，限时活动，即将结束，速速收藏
同尘科技为腾讯云授权服务中心。
购买腾讯云产品享受折上折，更有现金返利。同意关联立享优惠