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 命令，無需任何預先設定的作用域。