跳至主要内容

如何在 Nuxt 中使用

本指南介绍如何在 Nuxt 应用程序中使用 Socket.IO。

服务器​

在幕后，Nuxt 使用 Nitro 处理 HTTP 请求。

将 Socket.IO 服务器附加到 Nitro 服务器有两个步骤

启用 WebSockets​

Nitro 中的 WebSockets 支持目前处于 实验阶段，因此需要手动启用

nuxt.config.js
// https://nuxtjs.org.cn/docs/api/configuration/nuxt-config

export default defineNuxtConfig({
  devtools: {
    enabled: true
  },
+ nitro: {
+   experimental: {
+     websocket: true
+   },
+ }
})

参考: https://nitro.unjs.io/guide/websocket

挂钩 Socket.IO 服务器​

我们的 Socket.IO 服务器是在 Nitro 插件 中创建的

server/plugins/socket.io.ts
import type { NitroApp } from "nitropack";
import { Server as Engine } from "engine.io";
import { Server } from "socket.io";
import { defineEventHandler } from "h3";

export default defineNitroPlugin((nitroApp: NitroApp) => {
  const engine = new Engine();
  const io = new Server();

  io.bind(engine);

  io.on("connection", (socket) => {
    // ...
  });

  nitroApp.router.use("/socket.io/", defineEventHandler({
    handler(event) {
      engine.handleRequest(event.node.req, event.node.res);
      event._handled = true;
    },
    websocket: {
      open(peer) {
        const nodeContext = peer.ctx.node;
        const req = nodeContext.req;

        // @ts-expect-error private method
        engine.prepare(req);

        const rawSocket = nodeContext.req.socket;
        const websocket = nodeContext.ws;

        // @ts-expect-error private method
        engine.onWebSocket(req, rawSocket, websocket);
      }
    }
  }));
});

瞧！

客户端​

在客户端，我们 Vue 3 指南 中的所有提示都适用。

唯一的区别是您需要将 Socket.IO 客户端从服务器端渲染 (SSR) 中排除

结构

├── components
│ ├── Connection.client.vue
│ └── socket.ts
...
components/socket.ts
import { io } from "socket.io-client";

export const socket = io();
components/Connection.client.vue
<script setup>
import { socket } from "./socket";

const isConnected = ref(false);
const transport = ref("N/A");

if (socket.connected) {
  onConnect();
}

function onConnect() {
  isConnected.value = true;
  transport.value = socket.io.engine.transport.name;

  socket.io.engine.on("upgrade", (rawTransport) => {
    transport.value = rawTransport.name;
  });
}

function onDisconnect() {
  isConnected.value = false;
  transport.value = "N/A";
}

socket.on("connect", onConnect);
socket.on("disconnect", onDisconnect);

onBeforeUnmount(() => {
  socket.off("connect", onConnect);
  socket.off("disconnect", onDisconnect);
});

</script>

<template>
<div>
  <p>Status: {{ isConnected ? "connected" : "disconnected" }}</p>
  <p>Transport: {{ transport }}</p>
</div>
</template>

注意

Connection.client.vue 中的 .client 后缀表示该组件仅用于客户端渲染（无 SSR）。

参考: https://nuxtjs.org.cn/docs/guide/directory-structure/components#client-components

在上面的示例中，transport 变量是用于建立 Socket.IO 连接的低级传输，它可以是

如果一切顺利，您应该看到

Status: connected
Transport: websocket

然后，您可以使用以下方法在 Socket.IO 服务器和客户端之间交换消息

  • socket.emit() 发送消息
socket.emit("hello", "world");
  • socket.on() 接收消息
socket.on("hello", (value) => {
  // ...
});

就是这样，感谢您的阅读！

返回示例列表