Websocket

GitHub npm crates.io

API 参考

在 JavaScript 中使用 Rust 客户端打开 WebSocket 连接。

支持的平台

此插件需要至少 1.77.2 版本的 Rust

平台	级别	注意
windows
linux
macos
android
ios

设置

安装 websocket 插件以开始使用。

自动

使用项目的包管理器添加依赖项

npm

npm run tauri add websocket

yarn

yarn run tauri add websocket

pnpm

pnpm tauri add websocket

deno

deno task tauri add websocket

bun

bun tauri add websocket

cargo

cargo tauri add websocket

手动

1. 在 src-tauri 文件夹中运行以下命令，将插件添加到 Cargo.toml 项目的依赖项中

   cargo add tauri-plugin-websocket

2. 修改 lib.rs 以初始化插件

   src-tauri/src/lib.rs

   #[cfg_attr(mobile, tauri::mobile_entry_point)]
   pub fn run() {
       tauri::Builder::default()
           .plugin(tauri_plugin_websocket::init())
           .run(tauri::generate_context!())
           .expect("error while running tauri application");
   }

3. 使用您首选的 JavaScript 包管理器安装 JavaScript Guest 绑定

   npm

   npm install @tauri-apps/plugin-websocket

   yarn

   yarn add @tauri-apps/plugin-websocket

   pnpm

   pnpm add @tauri-apps/plugin-websocket

   deno

   deno add npm:@tauri-apps/plugin-websocket

   bun

   bun add @tauri-apps/plugin-websocket

用法

websocket 插件在 JavaScript 中可用。

import WebSocket from '@tauri-apps/plugin-websocket';
// when using `"withGlobalTauri": true`, you may use
// const WebSocket = window.__TAURI__.websocket;

const ws = await WebSocket.connect('ws://127.0.0.1:8080');

ws.addListener((msg) => {
  console.log('Received Message:', msg);
});

await ws.send('Hello World!');

await ws.disconnect();

权限

默认情况下，所有潜在危险的插件命令和作用域都被阻止且无法访问。您必须修改 capabilities 配置中的权限才能启用这些。

有关更多信息，请参阅功能概述和使用插件权限的分步指南。

src-tauri/capabilities/default.json

{
  "$schema": "../gen/schemas/desktop-schema.json",
  "identifier": "main-capability",
  "description": "Capability for the main window",
  "windows": ["main"],
  "permissions": ["websocket:default"]
}

默认权限

允许连接和发送数据到 WebSocket 服务器

此默认权限集包括以下内容

• allow-connect
• allow-send

权限表

标识符	描述
websocket:allow-connect	启用 connect 命令，无需任何预配置的作用域。
websocket:deny-connect	拒绝 connect 命令，无需任何预配置的作用域。
websocket:allow-send	启用 send 命令，无需任何预配置的作用域。
websocket:deny-send	拒绝 send 命令，无需任何预配置的作用域。