一，介绍
二，新建项目
1. 新建云开发模板
也可以省略此步骤，直接在已有项目上开通和使用云开发。
新建项目选择一个空目录，填入 AppID（使用云开发能力必须填写 AppID），勾选创建 “云开发 QuickStart 项目”，点击创建即可得到一个展示云开发基础能力的示例小程序。该小程序与普通 QuickStart 小程序有以下不同需注意：
无游客模式、也不可以使用 测试号
project.config.json 中增加了字段 cloudfunctionRoot 用于指定存放云函数的目录
cloudfunctionRoot 指定的目录有特殊的图标
云开发能力从基础库 2.2.3 开始支持（覆盖率 97.3%，查看兼容性问题）
从基础库 2.4.1 开始，在小程序插件中可以使用云开发，插件中使用云开发时，使用的是插件方的云资源而非宿主的云资源，在使用方式上与在小程序中使用无异。
2. 开通云开发、创建环境
创建了第一个云开发小程序后，在使用云开发能力之前需要先开通云开发。在开发者工具工具栏左侧，点击 “云开发” 按钮即可打开云控制台、根据提示开通云开发、创建云环境。默认配额下可以创建两个环境，各个环境相互隔离，每个环境都包含独立的数据库实例、存储空间、云函数配置等资源。每个环境都有唯一的环境 ID 标识，初始创建的环境自动成为默认环境。
注：AppID 首次开通云环境后，需等待大约 10 分钟方可正常使用云 API，在此期间官方后台服务正在做准备服务，如尝试在小程序中调用云 API 则会报 cloud init error：{ errMsg: “invalid scope” } 的错误
3. 体验小程序
开通创建环境后，即可以开始在模拟器上操作小程序体验云开发提供的部分基础能力演示。
4. 查看控制台
云开发控制台是管理云开发资源的地方，控制台提供以下能力：
运营分析：查看云开发监控、配额使用量、用户访问情况
数据库：管理数据库，可查看、增加、更新、查找、删除数据、管理索引、管理数据库访问权限等
存储管理：查看和管理存储空间
云函数：查看云函数列表、配置、日志
三，云开发优点
小程序·云开发提供了多个基础能力，以下对各个主要能力介绍。
数据库
云开发提供了一个 JSON 数据库，顾名思义，数据库中的每条记录都是一个 JSON 格式的对象。一个数据库可以有多个集合（相当于关系型数据中的表），集合可看做一个 JSON 数组，数组中的每个对象就是一条记录，记录的格式是 JSON 对象。
关系型数据库和 JSON 数据库的概念对应关系如下表：
关系型 文档型
数据库 database 数据库 database
表 table 集合 collection
行 row 记录 record / doc
列 column 字段 field
以下是一个示例的集合数据，假设我们有一个 books 集合存放了图书记录，其中有两本书：
[
{
“_id”: “Wzh76lk5_O_dt0vO”,
“title”: “The Catcher in the Rye”,
“author”: “J. D. Salinger”,
“characters”: [
“Holden Caulfield”,
“Stradlater”,
“Mr. Antolini”
],
“publishInfo”: {
“year”: 1951,
“country”: “United States”
}
},
{
“_id”: “Wzia0lk5_O_dt0vR”,
“_openid”: “ohl4L0Rnhq7vmmbT_DaNQa4ePaz0”,
“title”: “The Lady of the Camellias”,
“author”: “Alexandre Dumas fils”,
“characters”: [
“Marguerite Gautier”,
“Armand Duval”,
“Prudence”,
“Count de Varville”
],
“publishInfo”: {
“year”: 1848,
“country”: “France”
}
}
]
在图书信息中，我们用 title, author 来记录图书标题和作者，用 characters 数组来记录书中的主要人物，用 publishInfo 来记录图书的出版信息。在其中我们可以看到，字段既可以是字符串或数字，还可以是对象或数组，就是一个 JSON 对象。
每条记录都有一个 _id 字段用以唯一标志一条记录、一个 _openid 字段用以标志记录的创建者，即小程序的用户。需要特别注意的是，在管理端（控制台和云函数）中创建的不会有 _openid 字段，因为这是属于管理员创建的记录。开发者可以自定义 _id，但不可自定义和修改 _openid 。_openid 是在文档创建时由系统根据小程序用户默认创建的，开发者可使用其来标识和定位文档。
数据库 API 分为小程序端和服务端两部分，小程序端 API 拥有严格的调用权限控制，开发者可在小程序内直接调用 API 进行非敏感数据的操作。对于有更高安全要求的数据，可在云函数内通过服务端 API 进行操作。云函数的环境是与客户端完全隔离的，在云函数上可以私密且安全的操作数据库。
数据库 API 包含增删改查的能力，使用 API 操作数据库只需三步：获取数据库引用、构造查询/更新条件、发出请求。以下是一个在小程序中查询数据库的发表于美国的图书记录的例子：
// 1. 获取数据库引用
const db = wx.cloud.database()
// 2. 构造查询语句
// collection 方法获取一个集合的引用
// where 方法传入一个对象，数据库返回集合中字段等于指定值的 JSON 文档。API 也支持高级的查询条件（比如大于、小于、in 等），具体见文档查看支持列表
// get 方法会触发网络请求，往数据库取数据
db.collection(‘books’).where({
publishInfo: {
country: ‘United States’
}
}).get({
success: function(res) {
// 输出 [{ “title”: “The Catcher in the Rye”, … }]
console.log(res)
}
})
更多的数据库的 API 的使用和数据库管理，可以参考数据库指引章节。
存储
云开发提供了一块存储空间，提供了上传文件到云端、带权限管理的云端下载能力，开发者可以在小程序端和云函数端通过 API 使用云存储功能。
在小程序端可以分别调用 wx.cloud.uploadFile 和 wx.cloud.downloadFile 完成上传和下载云文件操作。下面简单的几行代码，即可实现在小程序内让用户选择一张图片，然后上传到云端管理的功能：
// 让用户选择一张图片
wx.chooseImage({
success: chooseResult => {
// 将图片上传至云存储空间
wx.cloud.uploadFile({
// 指定上传到的云路径
cloudPath: ‘my-photo.png’,
// 指定要上传的文件的小程序临时文件路径
filePath: chooseResult.tempFilePaths[0],
// 成功回调
success: res => {
console.log(‘上传成功’, res)
},
})
},
})
上传完成后可在控制台中看到刚上传的图片。
更多的存储 API 和管理，可以参考存储指引章节。
云函数
云函数是一段运行在云端的代码，无需管理服务器，在开发工具内编写、一键上传部署即可运行后端代码。
小程序内提供了专门用于云函数调用的 API。开发者可以在云函数内使用 wx-server-sdk 提供的 getWXContext 方法获取到每次调用的上下文（appid、openid 等），无需维护复杂的鉴权机制，即可获取天然可信任的用户登录态（openid）。
比如我们如下定义一个云函数，命名为 add ，功能是将传入的两个参数 a 和 b 相加：
// index.js 是入口文件，云函数被调用时会执行该文件导出的 main 方法
// event 包含了调用端（小程序端）调用该函数时传过来的参数，同时还包含了可以通过 getWXContext 方法获取的用户登录态 openId 和小程序 appId 信息
const cloud = require(‘wx-server-sdk’)
exports.main = (event, context) => {
let { userInfo, a, b} = event
let { OPENID, APPID } = cloud.getWXContext() // 这里获取到的 openId 和 appId 是可信的
let sum = a + b
return {
OPENID,
APPID,
sum
}
}
在开发者工具中上传部署云函数后，我们在小程序中可以这么调用：
wx.cloud.callFunction({
// 需调用的云函数名
name: ‘add’,
// 传给云函数的参数
data: {
a: 12,
b: 19,
},
// 成功回调
complete: console.log
})
// 当然 promise 方式也是支持的
wx.cloud.callFunction({
name: ‘add’,
data: {
a: 12,
b: 19
}
}).then(console.log)
四，环境
资源环境
一个环境对应一整套独立的云开发资源，包括数据库、存储空间、云函数等资源。各个环境是相互独立的，用户开通云开发后即创建了一个环境，默认可拥有最多两个环境。在实际开发中，建议每一个正式环境都搭配一个测试环境，所有功能先在测试环境测试完毕后再上到正式环境。以初始可创建的两个环境为例，建议一个创建为 test 测试环境，一个创建为 release 正式环境。
为了方便开发者调试，从开发者工具 1.02.1905302 及基础库 2.7.1 起，在 wx.cloud.init 后会在调试器中输出 SDK 中所使用的默认环境：
devtools-network-cloud-init
同时，在 Network 面板中会输出各个云开发操作的请求详情，其中包括该调用所请求的环境 ID
五，开发指引
初始化
在小程序端开始使用云能力前，需先调用 wx.cloud.init 方法完成云能力初始化（注意小程序需先开通云服务，开通的方法是点击工具栏左上角的 “控制台” 按钮）。因此，如果要使用云能力，通常我们在小程序初始化时即调用这个方法。
小程序端初始化
wx.cloud.init 方法的定义如下：
function init(options): void
wx.cloud.init 方法接受一个可选的 options 参数，方法没有返回值。方法只能调用一次，多次调用时只有第一次调用生效。
options 参数定义了云开发的默认配置，该配置会作为之后调用其他所有云 API 的默认配置，options 提供的可选配置如下：
字段 数据类型 必填 默认值 说明
env string | object 是 后续 API 调用的默认环境配置，传入字符串形式的环境 ID 可以指定所有服务的默认环境，传入对象可以分别指定各个服务的默认环境，见下方详细定义
traceUser boolean 否 false 是否在将用户访问记录到用户管理中，在控制台中可见
当 env 传入参数为对象时，可以指定各个服务的默认环境，可选字段如下：
字段 数据类型 必填 默认值 说明
database string 否 空 数据库 API 默认环境配置
storage string 否 空 存储 API 默认环境配置
functions string 否 空 云函数 API 默认环境配置
注意：env 设置只会决定小程序端 API 调用的云环境，并不会决定云函数中的 API 调用的环境，在云函数中需要通过 wx-server-sdk 的 init 方法重新设置环境。
示例代码：
wx.cloud.init({
env: ‘test-x1dzi’
})
云函数端初始化
cloud.init 方法的定义如下：
function init(options): void
cloud.init 方法接受一个可选的 options 参数，方法没有返回值。方法只能调用一次，多次调用时只有第一次调用生效。
options 参数定义了云开发的默认配置，该配置会作为之后调用其他所有云 API 的默认配置，options 提供的可选配置如下：
字段 数据类型 必填 默认值 说明
env string | object 是 后续 API 调用的默认环境配置，传入字符串形式的环境 ID 或传入 cloud.DYNAMIC_CURRENT_ENV 可以指定所有服务的默认环境，传入对象可以分别指定各个服务的默认环境，见下方详细定义
当 env 传入参数为对象时，可以指定各个服务的默认环境，可选字段如下：
字段 数据类型 必填 默认值 说明
database string 否 default 数据库 API 默认环境配置
storage string 否 default 存储 API 默认环境配置
functions string 否 default 云函数 API 默认环境配置
default string 否 空 缺省时 API 默认环境配置
注意：env 设置只会决定本次云函数 API 调用的云环境，并不会决定接下来其他被调云函数中的 API 调用的环境，在其他被调云函数中需要通过 init 方法重新设置环境。
建议：在设置 env 时指定 cloud.DYNAMIC_CURRENT_ENV 常量 (需 SDK v1.1.0 或以上) ，这样云函数内发起数据库请求、存储请求或调用其他云函数的时候，默认请求的云环境就是云函数当前所在的环境：
const cloud = require(‘wx-server-sdk’)
cloud.init({
env: cloud.DYNAMIC_CURRENT_ENV
})
exports.main = async (event) => {
const { ENV, OPENID, APPID } = cloud.getWXContext()
// 如果云函数所在环境为 abc，则下面的调用就会请求到 abc 环境的数据库
const dbResult = await cloud.database().collection(‘test’).get()
return {
dbResult,
ENV,
OPENID,
APPID,
}
}
注：上述代码中的 env 参数的值不能用 cloud.getWXContext().ENV 替代，因为在 exports.main 外部调用的 getWXContext() 无法获取到当前环境
API 风格
云开发的 API 风格与框架组件和 API 风格一致，但同时支持回调风格和Promise风格。在传入 API 的 Object 参数中，如果传入了 success、fail、complete 字段，则我们认为是采用回调风格，API 方法调用不返回 Promise。如果传入 API 的 Object 参数中 success、fail、complete 这三个字段都不存在，则我们认为是采用Promise风格，API 方法调用返回一个 Promise，Promise resolve 的结果同传入 success 回调的参数，reject 的结果同传入 fail 的参数。
注意事项
如果 init 时不传 env 参数，后续 API 调用将默认请求到第一个创建的环境，但这种方式并不总是预期的，因此这种方式已废弃，请务必明确传入 env 参数