Skip to content

Latest commit

 

History

History
169 lines (120 loc) · 6.45 KB

README.md

File metadata and controls

169 lines (120 loc) · 6.45 KB
Raw

腾讯云对象存储（COS）插件

1. 插件介绍

标题 名称
中文名称 腾讯云对象存储（COS）插件
英文名称 tencentcloud-plugin-cos
最新版本 v1.0.6 (2020.11.05)
适用平台 DCloud uni-app
适用产品 腾讯云对象存储（COS）
GitHub项目 tencentcloud-uniapp-plugin-cos
主创团队 腾讯云中小企业产品中心（SMB Product Center of Tencent Cloud）
兼容平台 H5、小程序、APP

一款帮助开发者在uni-app项目开发中快捷使用腾讯云对象存储（COS）产品功能的插件。

2. 功能特性

  • 上传图片、视频等文件到腾讯云COS(支持H5、小程序、APP)
  • 选择自定义类型文件功能（仅支持H5平台, APP端可使用选择文件原生插件）
  • 获取腾讯云COS私有读文件的临时访问链接

3. 安装指引

本插件需要调用uniCloud云函数，而使用云函数的前提是：

  • 使用DCloud官方开发工具HBuilderX 2.7+；
  • 已注册DCloud开发者账号并通过实名认证；
  • 开通了uniCloud并创建一个腾讯云的服务空间；

3.1. 新建或打开已有项目

  1. 打开HBuilderX开发工具；
  2. 新建或打开一个uni-app项目；

3.2. 导入云函数

  1. 访问 DCloud 插件市场的 腾讯云插件 - 云函数模板 详情页；
  2. 点击详情页右上角 使用 HBuilderX 导入插件，将云函数模板导入到您的项目中；
  3. 在项目中打开 cloudfunctions/tencentcloud-plugin/config.js 文件，将腾讯云的密钥信息配置进去，可以在腾讯云 API 密钥管理 中获取 SecretId、SecretKey 和 APPID；
  4. 在uniCloud控制台注册HBuild账号并登录，创建云服务空间；
  5. 绑定云函数的云服务空间，将云函数 上传部署 到您的云服务空间；

如果您之前在使用其它腾讯云产品的 uni-app 插件时已经导入过此云函数模板，则前 4 个步骤可以省略。

若导入失败或有其它疑问，请查看 uniCloud帮助文档 云函数相关章节。

3.3. 导入插件

  1. 访问DCloud插件市场 腾讯云对象存储（COS）插件 详情页；
  2. 点击详情页右上角 使用HBuilderX导入插件 ，将插件导入到您的项目中；
  3. 在项目中通过 import 语法将插件提供的方法导入到相关业务组件并使用；

本插件的默认导入位置是在您项目的“js_sdk”目录下

4. 使用指引

4.1. 插件API导图

4.2. 插件使用示例

// 简单上传图片示例代码

import chooseAndUploadImage from '@/js_sdk/tencentcloud-plugin-cos/choose-and-upload-image.js';
import getFileAccessUrl from '@/js_sdk/tencentcloud-plugin-cos/get-file-access-url.js';

export default {
  methods: {
    async eventHandler() {
      try {
        const key = await chooseAndUploadImage(); // 返回的key即上传到COS的图片文件名（不包含域名部分，一般用来提交给后台接口保存到数据库）
        const url = await getFileAccessUrl(key); // 返回的url即前面上传到COS的图片的访问地址（包含临时签名）
      } catch (error) {
        console.log(error);
      }
    }
  }
};
// 自选任意类型文件上传示例，文件校验，上传进度显示（chooseFile仅支付H5平台调用）

import chooseFile from '@/js_sdk/tencentcloud-plugin-cos/choose-file.js';
import uploadFile from '@/js_sdk/ttencentcloud-plugin-cos/upload-file.js';
import getFileAccessUrl from '@/js_sdk/tencentcloud-plugin-cos/get-file-access-url.js';

export default {
  methods: {
    async eventHandler() {
      try {
        const [file] = await chooseFile();
        if (file.size > 1024 * 1024) {
          throw new Error('文件大小不能超过1M');
        }
        const key = await uploadFile(file, null, ({progress}) => {
          console.log(`文件上传中(${progress}%)`);
        });
        const url = await getFileAccessUrl(key);
      } catch (error) {
        console.log(error);
      }
    }
  }
};

4.3. 名词解释

服务空间：一个服务空间对应一整套独立的云开发资源，包括数据库、存储空间、云函数等资源。服务空间之间彼此隔离。更多详情请访问 uniCloud开发文档

云函数：云函数是运行在云端的JavaScript代码，更多详情请见 uniCloud云函数文档

5. 获取入口

插件入口 链接
DCloud插件市场 腾讯云对象存储（COS）插件

6. FAQ

暂无

7. GitHub版本迭代记录

7.1. tencentcloud-uniapp-plugin-cos v1.0.6

  • 代码优化

7.2. tencentcloud-uniapp-plugin-cos v1.0.6

  • 代码优化

7.3. tencentcloud-uniapp-plugin-cos v1.0.4

  • 代码优化

7.4. tencentcloud-uniapp-plugin-cos v1.0.3

  • 插件名称优化
  • 代码优化

7.5. tencentcloud-uniapp-plugin-cos v1.0.2

  • 修复插件导入时目录层级重复问题

7.6. tencentcloud-uniapp-plugin-cos v1.0.1

  • 新增上传图片、视频等文件到腾讯云COS功能
  • 新增选择自定义类型文件功能（仅支持H5平台）
  • 新增获取腾讯云COS私有读文件临时访问链接的功能

7.7. tencentcloud-uniapp-plugin-cos v1.0.0

  • 新增上传图片、视频等文件到腾讯云COS功能
  • 新增选择自定义类型文件功能（仅支持H5平台）
  • 新增获取腾讯云COS私有读文件临时访问链接的功能

8. 联系我们

   扫码备注“春雨”来联络到我们