云函数

简介 Introduction

• 部署在微信云端的函数服务
• 提供后端服务能力，如：数据库操作、文件存储、HTTP请求
• 需要 Node.js 环境
• 每个云函数都是一个 .js 文件
• 云函数文件名即为云函数名称
• 支持 async/await
• 可以引入和使用 NPM 包
• 数据库直连，只能操作自己的数据；使用云函数，操作的权限得到提升
• 更多信息，请访问 开发者指引 → 基础能力 → 云函数或开发者资源 → SDK → 云函数

特点 Feature

• 无需管理服务器：开发者只需关注业务逻辑代码，无需运维服务器
• 弹性伸缩：根据请求量自动扩缩容
• 按需付费：只在函数执行时计费
• 高可用性：由云服务商保证服务的稳定性和可靠性

场景 Application

• 业务逻辑处理：处理复杂的业务逻辑
• 数据库操作：访问云数据库进行增删改查
• 文件处理：操作云存储中的文件
• 第三方服务调用：调用外部API或服务
• 定时任务：执行定时或计划任务

部署流程 Procedure

• 创建云函数 - 右键 cloudfunctions，新建 Node.js 云函数；以文件夹的形式创建，包括：

  config.json

  index.js - 业务逻辑

  package.json

  node_modules - 安装依赖时才有

• 函数模板默认内容如下：

  event: 包含调用时传入的参数

  context: 包含调用上下文信息，如 openid 和 appid，用于获取用户信息

// 1. 引入云开发SDK
const cloud = require('wx-server-sdk')

// 2. 初始化云环境
cloud.init({
  env: cloud.DYNAMIC_CURRENT_ENV
})

// 3. 导出 main 函数（云函数入口）
exports.main = async (event, context) => {
  const wxContext = cloud.getWXContext()

  // 函数逻辑
  return {
    event,
    openid: wxContext.OPENID,
    appid: wxContext.APPID,
    unionid: wxContext.UNIONID,
  }
}

• 编写云函数代码
• 右键云函数目录选择"上传并部署"；如有依赖，通常选择忽略；但是使用时，如果换了环境，需要先安装依赖
• 在客户端调用已部署的云函数；使用 data 传递参数；可以是 callback 或 promise 方式

// 调用云函数
wx.cloud.callFunction({
  name: '函数名',
  data: {
    // 传递的参数
    a: 1,
    b: 2
  },
  success: res => {
    console.log('调用成功', res)
  },
  fail: err => {
    console.error('调用失败', err)
  },
  complete: () => {
    console.log('调用结束')
  }
})

wx.cloud.callFunction({
  name: '函数名',
  data: {}
})
  .then(res => {})
  .catch(err => {})
  .finally(() => {})

• 云函数的执行是在云端，相关 log 调试需要开启本地调试
• 其它：访问云数据库

const cloud = require('wx-server-sdk')
cloud.init()

// NOT
// const db = cloud.database()

exports.main = async (event, context) => {
  // 这里不需要使用 wx.cloud
  // 不建议放在外面
  const db = cloud.database()
  
  try {
    // 查询数据
    const result = await db.collection('users').get()
    return result
  } catch (error) {
    return { error }
  }
}

• 其它：云函数间调用

const cloud = require('wx-server-sdk')
cloud.init()

exports.main = async (event, context) => {
  // 调用其他云函数
  const result = await cloud.callFunction({
    name: 'otherFunction',
    data: { param: 'value' }
  })
  
  return result
}

• 可以加载商品 products 集合的数据；也可以加载订单 orders 集合的数据
• 使用参数 collection 传递集合名
• 创建云函数 loadData

const cloud = require('wx-server-sdk')

cloud.init({
  env: cloud.DYNAMIC_CURRENT_ENV
})

exports.main = async (event, context) => {
  const db = cloud.database()
  const res = await db.collection(event.collection).get()
  return {
    data: res.data,
  }
}

• 调用云函数 - 传递参数，加载商品集合 products 的数据

wx.cloud.callFunction({
  name: 'loadData',
  data: {
    database: 'products'
  },
  success: res => {
    console.log('load products', res.result);
  },
  fail: err => {
    console.log(err);
  }
})

const cloud = require('wx-server-sdk')
cloud.init()

exports.main = async (event, context) => {
  const { a, b } = event
  const sum = a + b
  
  return {
    sum
  }
}

异常处理 try-catch

• 云函数默认情况下，没有提供错误处理
• 增加错误处理可以

  防止未捕获异常导致云函数崩溃

  提供结构化的返回数据

  记录服务器端错误日志

  避免暴露敏感的系统错误信息

• 同时增加客户端处理，作为补充作用

• 错误控制
• 格式化输出
• 核心代码完善如下

try {
  const res = await db.collection(event.collection).get()
  return {
    errCode: 200,
    errMsg: "get ok",
    data: res.data,
  }
} catch (error) {
  console.log('error', error);
  return {
    errorCode: error.errCode || 'UNKNOWN_ERROR',
    errMsg: error.message || '服务异常'
  }
}