云函数请求中的中间状态通知通道

新增于HBuilderX 4.71

云函数在执行长时间任务时客户端无法获取云端任务执行状态，用户无法确定云函数是否还在正常执行，有些用户可能直接放弃等待刷新页面重新执行，从而导致浪费了更多的云函数资源。因此在此场景下需要一个云函数通知客户端发送执行状态或中间结果的通道。

在常规web开发时通过云端向响应流多次写入数据的方式来实现，但是云函数不支持这种用法，因此我们基于uni-push实现了这个替代方案。

使用此功能前需要先开通uni-push 2.0，参考文档：uni-push 2.0。uni-app-x项目使用SSEChannel需要自行配置uni-push模块到manifest.json内，且开发期间需要打包自定义基座进行测试。

客户端api

SSEChannel(options)

客户端代码示例

async function receiveMessage() {
  const sseChannel = new uniCloud.SSEChannel()
  sseChannel.on('message', (message?: any | null) => {
    console.log('message: ' + (message as string)) // message可能是任意类型，需要自行as为实际类型再使用
  })
  sseChannel.on('end', (message?: any | null) => {
    console.log('end: ' + message) // message可能是任意类型，需要自行as为实际类型再使用。此处在云端end事件返回了null。目标语言是js时可能会返回undefined
  })
  sseChannel.on('open', () => {
    console.log('sseChannel open')
  })
  sseChannel.on('close', () => {
    console.log('sseChannel close')
  })
  sseChannel.on('error', (error: UniCloudError) => {
    console.log('sseChannel error: ' + error.message)
  })
  await sseChannel.open() // 必须await通道开启，才可以将sseChannel传入云函数
  const res = await uniCloud.callFunction({
    name: 'sse',
    data: {
      sseChannel
    }
  })
  console.log(res)
}

云函数api

反序列化消息通道

将客户端传入的sseChannel反序列化为SSEChannel对象，用于发送消息。

uniCloud.deserializeSSEChannel(sseChannelObj: string): SSEChannel

sseChannel.write

向客户端发送消息。

sseChannel.write(message: any): Promise<void>

sseChannel.end

结束消息通道。

sseChannel.end(message: any): Promise<void>

云函数代码示例

'use strict';
exports.main = async (event, context) => {
  const sseChannelObj = event.sseChannel
  const sseChannel = uniCloud.deserializeSSEChannel(sseChannelObj)
  return new Promise(async (resolve, reject) => {
    await sseChannel.write('message1')
    await sseChannel.write('message2')
    setTimeout(async () => {
      await sseChannel.end()
      resolve({
        errCode: 0
      })
    }, 300)
  })
};