Bun 中文文档：API — WebSockets

2023-12-14 21:03:49

Bun WebSockets：构建实时交互式应用程序的指南

服务器端 WebSockets 介绍

WebSockets 是实时通信的基石，它允许客户端和服务器之间建立双向通信通道。Bun.serve() 框架提供内置支持，使您可以轻松地构建服务器端 WebSockets 应用程序。通过传递一个回调函数作为 websocket 选项，您可以创建 WebSocket 服务器，该服务器可以处理客户端连接并交换数据。

基本用法

以下是创建服务器端 WebSocket 的基本示例：

import { serve } from "bun";

serve({
  websocket: (ws) => {
    ws.onopen = () => {
      console.log("WebSocket 连接已打开。");
    };

    ws.onmessage = (msg) => {
      // 服务器将数据回显给客户端
      ws.send(msg);
    };

    ws.onclose = () => {
      console.log("WebSocket 连接已关闭。");
    };
  },
});

高级功能

除了基本功能外，Bun WebSockets API 还提供了以下高级功能：

发布-订阅 (Pub/Sub)： 允许在客户端和服务器之间进行异步通信，使您可以构建复杂的多用户应用程序。
压缩： Bun 自动压缩 WebSocket 流量，以最大限度地减少带宽使用，提高应用程序性能。
TLS： 支持使用 TLS 加密 WebSocket 流量，确保安全通信。

代码示例：回显服务器

import { serve } from "bun";

serve({
  websocket: (ws) => {
    ws.onmessage = (msg) => {
      ws.send(msg);
    };
  },
});

客户端连接

客户端可以使用 WebSockets API 连接到服务器：

const ws = new WebSocket("ws://localhost:3000");

ws.onopen = () => {
  console.log("WebSocket 连接已打开。");
};

ws.onmessage = (msg) => {
  console.log("收到服务器消息：", msg.data);
};

ws.onclose = () => {
  console.log("WebSocket 连接已关闭。");
};

ws.send("Hello, Bun!");