30 Websocket

原文链接: https://tauri.app/plugin/websocket/

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

支持的平台

设置

自动

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

• npm
• yarn
• pnpm
• deno
• bun
• cargo

1

npm run tauri add websocket

1

yarn run tauri add websocket

1

pnpm tauri add websocket

1

deno task tauri add websocket

1

bun tauri add websocket

1

cargo tauri add websocket

手动

1. 在 src-tauri 文件夹中运行以下命令，把插件加入 Cargo.toml 里的项目依赖：

   1	cargo add tauri-plugin-websocket

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

   1 2 3 4 5 6 7

   #[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 端绑定：

• npm
• yarn
• pnpm
• deno
• bun

1

npm install @tauri-apps/plugin-websocket

1

yarn add @tauri-apps/plugin-websocket

1

pnpm add @tauri-apps/plugin-websocket

1

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

1

bun add @tauri-apps/plugin-websocket

用法

websocket 插件在 JavaScript 中可用。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15

// 使用 `"withGlobalTauri": true` 时，你可以这样写
// const WebSocket = window.__TAURI__.websocket;

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

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

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

// 可选：移除监听器
removeListener();

await ws.disconnect();

权限

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

更多信息请参阅能力概述，以及使用插件权限的分步指南。

1
2
3
4
5
6

{
  "permissions": [
    ...,
    "websocket:default"
  ]
}