帮你快速理解、总结文档立即下载

快速开始

最近更新时间:2026-11-02 18:10:38
我的收藏

概述

本文介绍如何快速开始使用腾讯云开发 CloudBase:创建环境、完成首次调用,并跳转到各能力的详细文档。
说明:
本文只保留快速上手所需的最小步骤。各能力的完整说明、SDK 与 API 参考均维护在 官方文档站 docs.cloudbase.net,文中每个模块都给出了对应入口。

一、选择开发模式

创建环境时需要选择是否使用 PostgreSQL 数据库,这将决定环境的运行模式:
运行模式
数据库
权限模型
适用场景
说明
PG 模式(推荐新建项目使用)
PostgreSQL 实例,基于 PostgREST 自动暴露 RESTful API
表级 GRANT + 行级 RLS 策略
需要强结构化建模、关联查询、事务一致性、精细化行级权限
传统模式
文档型数据库为主,可另开 MySQL 数据库
安全规则(JSON 表达式)
已有存量环境,或需要使用数据模型、MySQL 数据库等传统模式专有能力
注意:
PG 模式仅新建环境支持,存量传统模式环境不支持升级。如需使用 PG 模式,请新建环境并选择 PostgreSQL 数据库。两种模式的完整差异见环境介绍。

二、选择开发场景

开发场景
适用场景
推荐能力
快速开始
微信小程序 / 小游戏
微信小程序、微信小游戏
小程序原生 API、Client SDK
Web 应用
网站、H5、管理后台
静态网站托管 + 后端服务
跨端应用
同时覆盖多端
UniApp、Flutter、React Native
服务端 / 后端
API 服务、数据处理、定时任务
云函数、云托管
Node.js / Python / Go / Java
移动端原生
iOS / Android 原生应用
iOS Swift、Android Kotlin
已有项目迁移
从其他后端平台迁移到云开发
迁移指南

三、5 分钟快速体验

步骤 1:创建云开发环境

环境是应用的后端基础设施,包含数据库、存储、云函数等服务,每个环境相互隔离,拥有唯一的环境 ID(EnvId)。
1. 前往云开发控制台,单击新建环境。
2. 按需选择是否启用 PostgreSQL 数据库(决定运行模式,见上文「选择开发模式」)。
3. 创建完成后,在环境概览页获取环境 ID。
更多创建方式(微信开发者工具可视化创建、CLI 创建等)见创建云开发环境。

步骤 2:获取 Publishable Key(Web 端)

Web 端推荐使用 Publishable Key 鉴权,无需额外的登录步骤。请在云开发控制台的 API Key 配置中生成,生成后填入下方代码的 accessKey。
说明:
Publishable Key 用于客户端鉴权。若你的应用需要识别具体用户身份(如用户登录、按用户隔离数据),请接入身份认证。

步骤 3:Web 端体验

安装 SDK:
npm install @cloudbase/js-sdk -S
初始化并读取一次数据:
import cloudbase from "@cloudbase/js-sdk";

const app = cloudbase.init({
env: "your-env-id", // 替换为步骤 1 获取的环境 ID
accessKey: "your-publishable-key", // 替换为步骤 2 生成的 Publishable Key
});

// 查询 todos 集合的数据
const db = app.database();
const result = await db.collection("todos").get();
console.log(result);
成功标志:控制台打印出查询结果(集合为空时返回空数组,不代表失败)。
说明:
@cloudbase/js-sdk 当前最新版本为 v3,完全兼容 v2 并与 HTTP API 全面对齐;自 v3.1 起已内置 Node.js 适配器,无需额外安装 @cloudbase/node-sdk。完整的初始化参数与服务端鉴权方式见JS SDK(V3) 初始化。

步骤 4:小程序端体验

在小程序项目的 app.js 中使用原生 API 初始化:
App({
onLaunch() {
wx.cloud.init({
env: "your-env-id", // 替换为您的环境 ID
});
},
});
调用数据库:
const db = wx.cloud.database();
const result = await db.collection("todos").get();
console.log(result);
注意:
登录云开发控制台时,请选择**「使用微信公众平台账号登录」**(适用于小程序 / 小游戏 / 公众号网页),不要选择腾讯云账号登录,否则环境无法与小程序关联。
小程序基础库版本需 2.2.3 或以上。
PG 模式环境需先开启 pgdoc 能力并创建 collection,见文档型数据库(PG)。
若原生 API 不支持所需能力,可使用 Client SDK:npm i @cloudbase/wx-cloud-client-sdk --save,安装后在微信开发者工具中单击工具 → 构建 npm。

四、按框架快速开始

以下是各框架的完整快速开始文档,包含环境创建、SDK 接入到首个功能调用的端到端步骤:
框架
文档
框架
文档
微信小程序
Node.js
微信小游戏(原生 API)
Python
微信小游戏(Cocos)
Go
React(Vite)
Java
Vue(Vite)
Flutter
UniApp
Android Kotlin
React Native
iOS Swift
HTTP API
托管后台服务

五、下一步:按能力深入

能力
说明
文档入口
PostgreSQL 数据库
PG 模式的统一数据底座,支持完整 SQL 与 PostgREST RESTful API
初始化
文档型数据库
以文档为单位存储业务数据
云存储
环境内置对象存储,支持文件上传与权限管理
云函数
事件驱动的服务端计算能力
云托管
容器化的后端服务托管
静态网站托管
前端静态资源托管与部署
身份认证
多种登录方式与用户管理
HTTP 访问服务
通过 HTTP 网关访问云开发资源
日志监控
运行日志、检索与告警
环境配置
QPS 控制、限速、安全配置等
场景实践
40+ 篇端到端的场景教程

六、从其他平台迁移

如果你正在把已有项目迁移到云开发,可直接参考对应平台的迁移文档:
来源平台
文档
Supabase
Firebase
Vercel
LeanCloud
S3 标准存储

七、获取帮助

资源
入口
命令行工具
AI 开发工具
常见问题
FAQ
计费说明
云开发控制台
官方文档站