快速入门

import { CredentialCallBack, QCloudCredential } from '@tencentcloud/cos';

export class Credential {
  /**
   * 获取 STS 临时密钥
   */
  public static sessionCredential: CredentialCallBack = (request)=>{
    return new Promise((resolve, reject) => {
      // 首先从您的临时密钥服务器获取包含了密钥信息的响应
      let httpRequest = http.createHttp();
      httpRequest.request(
        // 请替换为具体的 sts 临时密钥获取服务 url
        "http://127.0.0.1/sts",
        { method: http.RequestMethod.GET },
        (err: BusinessError, data: http.HttpResponse) => {
          if (!err) {
            const stsSessionQCloudCredentials: StsSessionQCloudCredentials = JSON.parse(data.result.toString());
            let credential : QCloudCredential= new QCloudCredential();
            credential.secretID = stsSessionQCloudCredentials.credentials.tmpSecretId;
            credential.secretKey = stsSessionQCloudCredentials.credentials.tmpSecretKey;
            credential.token = stsSessionQCloudCredentials.credentials.sessionToken;
            // 建议返回服务器时间作为签名的开始时间，避免由于用户手机本地时间偏差过大导致请求过期
            // startDate 和 expirationDate 均为 Date 类型，此处通过毫秒时间戳构造 Date，
            // sts 响应的时间戳一般单位为秒，因此需要乘以1000，如果您的临时密钥服务响应的时间单位为毫秒，则无需乘以1000
            credential.startDate = new Date(stsSessionQCloudCredentials.startTime * 1000);
            credential.expirationDate = new Date(stsSessionQCloudCredentials.expiredTime * 1000);
            httpRequest.destroy();
            // 最后返回临时密钥信息对象
            resolve(credential);
          } else {
            httpRequest.destroy();
            reject(err);
          }
        });
    })
  }
}

/**
 * 临时密钥实体定义
 */
export class StsSessionQCloudCredentials{
  credentials: StsCredentials;
  startTime: number;
  expiredTime: number;

  constructor(credentials: StsCredentials, startTime: number, expiredTime: number) {
    this.credentials = credentials;
    this.startTime = startTime;
    this.expiredTime = expiredTime;
  }
}
export class StsCredentials{
  tmpSecretId: string;
  tmpSecretKey: string;
  sessionToken: string;

  constructor(tmpSecretId: string, tmpSecretKey: string, sessionToken: string) {
    this.tmpSecretId = tmpSecretId;
    this.tmpSecretKey = tmpSecretKey;
    this.sessionToken = sessionToken;
  }
}

// 定义服务端签名回调
let selfSignCallBack = async (request)=>{
  // 首先从您的服务器获取包含了签名信息的响应
  let httpRequest = http.createHttp();
  httpRequest.request(
    // 请替换为具体的签名获取服务 url
    "http://127.0.0.1/sign",
    { method: http.RequestMethod.GET },
    (err: BusinessError, data: http.HttpResponse) => {
      if (!err) {
        // 拿到签名信息
        let signData: object = JSON.parse(data.result.toString());
        // 对 request 进行签名 header 的设置
        request.addHeader(HttpHeader.AUTHORIZATION, signData['authorization'])
        if(signData['securityToken']){
          request.addHeader("x-cos-security-token", signData['securityToken'])
        }
        httpRequest.destroy();
      } else {
        httpRequest.destroy();
      }
  });
}

// 获取签名数据（业务层控制获取的方式）
let authorization: string = "authorization";
let token: string = "token";
let tokenName: string = "x-cos-security-token";

import { CredentialCallBack, QCloudCredential } from '@tencentcloud/cos';

export class Credential {
  /**
   * 获取固定密钥 仅在测试时使用
   */
  public static constCredential: CredentialCallBack = (request)=>{
    return new Promise((resolve, reject) => {
      let credential : QCloudCredential= new QCloudCredential();

      // 用户的 SecretId，建议使用子账号密钥，授权遵循最小权限指引，降低使用风险。子账号密钥获取可参见 https://cloud.tencent.com/document/product/598/37140
      credential.secretID = "SECRETID";
      // 用户的 SecretKey，建议使用子账号密钥，授权遵循最小权限指引，降低使用风险。子账号密钥获取可参见 https://cloud.tencent.com/document/product/598/37140
      credential.secretKey = "SECRETKEY";
      resolve(credential);
    })
  }
}

import { CosXmlBaseService, CosXmlServiceConfig } from '@tencentcloud/cos';

// 服务配置
let cosXmlServiceConfig = new CosXmlServiceConfig("ap-guangzhou");
// 初始化默认的 Service
CosXmlBaseService.initDefaultService(
  this.context.getApplicationContext(),
  cosXmlServiceConfig,
  // 第一步“初始化密钥”中获取到的临时密钥回调
  Credential.sessionCredential
)

import { CosXmlBaseService, CosXmlServiceConfig } from '@tencentcloud/cos';

// 服务配置
let cosXmlServiceConfig = new CosXmlServiceConfig("ap-guangzhou");
// 初始化默认的 Service
CosXmlBaseService.initDefaultService(
  this.context.getApplicationContext(),
  cosXmlServiceConfig
)
// 第一步“初始化密钥”中获取到的服务端签名回调
CosXmlBaseService.default().setSelfSignCallBack(selfSignCallBack);

import { CosXmlBaseService, PutObjectRequest, UploadTask } from '@tencentcloud/cos';

// 任何 CosXmlRequest 都支持这种方式，例如上传 PutObjectRequest、下载 GetObjectRequest、删除 DeleteObjectRequest 等
// 以下用上传进行示例
let putRequest = new PutObjectRequest("examplebucket-1250000000", "exampleobject.txt", "本地文件路径");
// authorization、token、tokenName 为第一步“初始化密钥”中获取到的单次签名信息
putRequest.setSign(authorization, stoken, tokenName);
let task: UploadTask = CosXmlBaseService.default().upload(putRequest);
task.start();

// 服务配置
let cosXmlServiceConfig = new CosXmlServiceConfig("ap-guangzhou");
// 初始化默认的 Service
CosXmlBaseService.initDefaultService(
  this.context.getApplicationContext(),
  cosXmlServiceConfig,
  // 第一步“初始化密钥”中获取到的固定密钥回调
  Credential.constCredential
)