YaoDocs

外观

导航栏

yao 应用中的 sse 函数 ​

在 yao 应用的 js 脚本中，有几个与 sse 相关的处理函数。

函数 ssEvent ​

适用于所有的text/stream api 请求

在 js 脚本中可以使用 ssEvent 函数向客户端发送 sse 事件。这个函数在底层调用了 gin 的 SSEvent 函数。函数接收两个参数：

  • event,事件名称，字符串，一般默认情况下使用 message,使用 eventsource 的情况下会触发浏览器中的 onmessage 事件。
  • data,消息内容，任意数据
js
c.SSEvent('message', msg);

具体请参考：

使用服务器发送事件

函数 cancel ​

适用于所有的text/stream api 请求

js 中的 cancel 函数实际上会调用 go 中的 context 的函数，取消请求连接。

go
ctx, cancel := context.WithCancel(context.Background())

需要注意的是在调用 ssEvent 与 cancel 时，需要在 api 关联的处理函数里直接使用，不能在 api 函数里通过调用处理器间接调用。 比如 api 定义如下，那么 ssEvent 函数需要在处理器scripts.chatweb.process或是其直接调用的 js 函数中调用，而不能在处理scripts.chatweb.process中通过Process("")间接调用。原因是 ssEvent 是一个特定函数，只在固定的 streamHandle 的函数上下文中才会的生效。

json
{
  "path": "/chat-process",
  "method": "POST",
  "guard": "scripts.security.CheckChatKey",
  "process": "scripts.chatweb.process",
  "in": [":payload"],
  "out": {
    "status": 200,
    "type": "text/event-stream; charset=utf-8"
  }
}

函数 ssWrite ​

只有 neo 请求中生效。

在与 neo 助手的交互过程中通过 sse 向浏览器写入文本数据,参考下面的数据结构中message.text。

函数 done ​

只有 neo 请求中生效。

在与 neo 助手的交互过程中向浏览器写入message.done=true的标识,注意并不是写入标准的 SSE 消息data: [DONE]，结束此次的会话。

ssWrite 与 done 函数的返回的数据结构如下：

go
// Message the message
type Message struct {
	Text    string                 `json:"text,omitempty"`
	Error   string                 `json:"error,omitempty"`
	Done    bool                   `json:"done,omitempty"`
	Confirm bool                   `json:"confirm,omitempty"`
	Command *Command               `json:"command,omitempty"`
	Actions []Action               `json:"actions,omitempty"`
	Data    map[string]interface{} `json:"-,omitempty"`//调用自定义js脚本后返回的结果
}

// Action the action
type Action struct {
	Name    string      `json:"name,omitempty"`
	Type    string      `json:"type"`
	Payload interface{} `json:"payload,omitempty"`
	Next    string      `json:"next,omitempty"`
}

// Command the command
type Command struct {
	ID      string `json:"id,omitempty"`
	Name    string `json:"name,omitempty"`
	Reqeust string `json:"request,omitempty"`
}

解析 sse 消息 ​

ts
interface SSEParsedData {
  events: string[];
  data: string;
}

/**
 * 转换sse消息，获取sse消息体中的data 数据，可能的格式有：
 * event: message
 * data:
 *
 * event: message
 * data: :
 * data:
 * data:
 *
 * @param sseMessage sse消息，有可能会有多行
 */
function parseSSEMessage(sseMessage: string): SSEParsedData {
  const parsedData: SSEParsedData = {
    events: [],
    data: '',
  };

  let lines = sseMessage.split('\n');
  let currentType: 'event' | 'data' | null = null;
  let previousType: 'event' | 'data' | null = null;

  for (let line of lines) {
    if (line.startsWith('event:')) {
      currentType = 'event';
      parsedData.events.push(line.substring('event:'.length).trim());
    } else if (line.startsWith('data:')) {
      if (previousType === 'data') {
        parsedData.data += '\n'; // 加入换行符，只有在连续的data行之间
      }
      currentType = 'data';
      let data = line.substring('data:'.length).trim();
      if (data === '[DONE]') {
        //结束标识
        break;
      }
      parsedData.data += data;
    }
    previousType = currentType; // 更新前一个类型
  }

  return parsedData;
}