转到主要内容
Version: 4.x

客户端初始化

安装Socket.IO客户端库后，您现在可以初始化客户端。可以在此处找到完整的选项列表。

提示

对于 TypeScript 用户，可以为事件提供类型提示。请检查这个。

在下面的示例中，io对象来自：

  • 使用 <script> 引入
<script src="/socket.io/socket.io.js"></script>
  • 使用 ESM 引入
<script type="module">
  import { io } from "https://cdn.socket.io/4.3.2/socket.io.esm.min.js";
</script>
  • NPM
const { io } = require("socket.io-client");

来自同一域​

如果您的前端与您的服务器在同一个域上提供服务，您可以简单地使用：

const socket = io();

服务器 URL 将从 window.location对象中推导出来。

来自不同的域​

如果您的前端不是来自与服务器相同的域，则必须传递服务器的 URL。

const socket = io("https://server-domain.com");

在这种情况下，请确保在服务器上启用 跨域资源共享 (CORS)。

信息

您可以使用https 或 wss (分别为, http 或 ws).

// the following forms are similar
const socket = io("https://server-domain.com");
const socket = io("wss://server-domain.com");
const socket = io("server-domain.com"); // only in the browser when the page is served over https (will not work in Node.js)

自定义命名空间​

在上面的示例中，客户端将连接到主命名空间。对于大多数用例来说，仅使用主命名空间就足够了，但您可以使用以下命令指定命名空间：

// same origin version
const socket = io("/admin");
// cross origin version
const socket = io("https://server-domain.com/admin");

您可以在此处找到有关名称空间的更多详细信息。

配置​

可在此处找到可用配置的完整列表。