云开发 CloudBase 快速开始

一、概述

注意：说明：

注意：这篇只保留快速上手所需的最小步骤。各能力的完整说明、SDK 与 API 参考均维护在 产品文档站 docs.cloudbase.net，文中每个模块都给出了对应入口。

二、一、选择开发模式

创建环境时需要选择是否使用 PostgreSQL 数据库，这将决定环境的运行模式：

注意：PG 模式仅新建环境支持，存量传统模式环境不支持升级。如需使用 PG 模式，请新建环境并选择 PostgreSQL 数据库。两种模式的完整差异见环境介绍。

三、二、选择开发场景

四、步骤 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);

八、四、按框架快速开始

以下是各框架的完整快速开始文档，包含环境创建、SDK 接入到首个功能调用的端到端步骤：

九、五、下一步：按能力深入

十、六、从其他平台迁移

如果你正在把已有项目迁移到云开发，可直接参考对应平台的迁移文档：

十一、七、获取帮助