# 在云函数中使用 wx-server-sdk
云函数属于管理端,在云函数中运行的代码拥有不受限的数据库读写权限和云文件读写权限。需特别注意,云函数运行环境即是管理端,与云函数中的传入的 openId 对应的微信用户是否是小程序的管理员 / 开发者无关。
云函数中使用 wx-server-sdk 需在对应云函数目录下安装 wx-server-sdk 依赖,在创建云函数时会在云函数目录下默认新建一个 package.json 并提示用户是否立即本地安装依赖。请注意云函数的运行环境是 Node.js,因此在本地安装依赖时务必保证已安装 Node.js,同时 node 和 npm 都在环境变量中。如不本地安装依赖,可以用命令行在该目录下运行:
npm install --save wx-server-sdk@latest
在云函数中调用其他 API 前,同小程序端一样,也需要执行一次初始化方法:
const cloud = require('wx-server-sdk')
// 给定字符串环境 ID:接下来的 API 调用都将请求到环境 some-env-id
cloud.init({
env: 'some-env-id'
})
或:
const cloud = require('wx-server-sdk')
// 给定 DYNAMIC_CURRENT_ENV 常量:接下来的 API 调用都将请求到与该云函数当前所在环境相同的环境
// 请安装 wx-server-sdk v1.1.0 或以上以使用该常量
cloud.init({
env: cloud.DYNAMIC_CURRENT_ENV
})
# 兼容 PG 存储(wx-server-sdk 5.0.1-beta.1 起)
wx-server-sdk 从 5.0.1-beta.1 版本起兼容 PG 存储(存储桶模式)。使用该版本或更高版本时,云函数中的 cloud.uploadFile 会经由官方网关把文件写入指定存储桶,文件因此具备桶归属,可以在控制台「云存储 - 存储管理」中按存储桶查看,并受该存储桶的权限与 RLS 策略管控。
安装指定版本:
npm install --save wx-server-sdk@5.0.1-beta.1
对应的上传写法没有变化:
const cloud = require('wx-server-sdk')
const fs = require('fs')
const path = require('path')
cloud.init({
env: cloud.DYNAMIC_CURRENT_ENV
})
exports.main = async (event, context) => {
const fileStream = fs.createReadStream(path.join(__dirname, 'demo.jpg'))
return await cloud.uploadFile({
cloudPath: 'demo.jpg',
fileContent: fileStream,
})
}
需要注意:
- 升级只影响新上传的文件。升级前由旧版本 SDK 上传的文件是「存量文件」——它们绕过了存储桶、直接写在环境关联的 COS 桶里,因此没有桶归属,控制台中按存储桶查看看不到,也不受任何存储桶的权限与 RLS 管控。
- 存量文件不会因为升级 SDK 而自动迁移,需要用迁移工具单独处理,详见存量文件迁移指引。迁移过程中文件 key 不变,业务代码无需修改访问路径。
- 云函数属于服务端(管理端)身份,上传的文件不记录 C 端用户的
openid,因此不涉及objects.owner_id归属,可由 B 端直接迁移;而小程序端wx.cloud.uploadFile上传的文件携带用户 openid,若直接迁移会导致owner_id缺失,需要走专门的人工协助流程并补配 RLS 策略。 - 该版本为 beta 版本,如遇问题可参考上述迁移指引与 SDK 文档确认当前版本的存储行为。
wx-server-sdk 与小程序端的云 API 以同样的风格提供了数据库、存储和云函数的 API。下面提供几个简单的操作数据库、存储和云函数的示例:
# 云函数中调用数据库
假设在数据库中已有一个 todos 集合,我们可以如下方式取得 todos 集合的数据:
const cloud = require('wx-server-sdk')
cloud.init({
env: cloud.DYNAMIC_CURRENT_ENV
})
const db = cloud.database()
exports.main = async (event, context) => {
// collection 上的 get 方法会返回一个 Promise,因此云函数会在数据库异步取完数据后返回结果
return db.collection('todos').get()
}
# 云函数中调用存储
假设我们要上传在云函数目录中包含的一个图片文件(demo.jpg):
const cloud = require('wx-server-sdk')
const fs = require('fs')
const path = require('path')
cloud.init({
env: cloud.DYNAMIC_CURRENT_ENV
})
exports.main = async (event, context) => {
const fileStream = fs.createReadStream(path.join(__dirname, 'demo.jpg'))
return await cloud.uploadFile({
cloudPath: 'demo.jpg',
fileContent: fileStream,
})
}
在云函数中,__dirname 的值是云端云函数代码所在目录
# 云函数中调用其他云函数
假设我们要在云函数中调用另一个云函数 sum 并返回 sum 所返回的结果:
const cloud = require('wx-server-sdk')
cloud.init({
env: cloud.DYNAMIC_CURRENT_ENV
})
exports.main = async (event, context) => {
return await cloud.callFunction({
name: 'sum',
data: {
x: 1,
y: 2,
}
})
}
更多的文档可参见API 文档。