feat: 添加 Tauri 桌面应用支持及完整开发环境配置
- 添加 Rust、Tauri 和 Even Better TOML 语言支持扩展以增强开发环境功能。 - 修改构建配置中的输出目录为 src-tauri/binaries,以适配新的构建输出路径。 - 添加 Tauri CLI 及其各平台兼容的可执行文件依赖,以支持多平台应用开发。 - 添加最新版本的 Rust 工具支持并移除旧版本的 Bun。 - 添加 Tauri CLI 工具以支持桌面应用开发 - 添加 Tauri 项目生成文件和构建产物的忽略规则 - 新增项目开发指南文档,明确 Tauri 桌面应用的构建流程、代码风格、Tauri 特定规范及最佳实践。 - 添加 Tauri 构建脚本以支持应用打包和构建流程 - 添加主窗口权限配置,允许执行名为 binaries/server 的侧车二进制文件。 - 生成新的 Cargo.lock 文件以更新项目依赖项的版本和校验和 - 添加 Tauri 应用的 Cargo 项目配置,包含 shell 插件和异步运行时支持。 - 添加32x32像素图标文件以支持应用图标显示 - 添加128x128像素图标文件以支持应用图标显示 - 添加高分辨率图标文件以支持高清显示 - 添加应用图标文件以支持 macOS 平台的图标显示 - 添加图标文件以用于应用程序的视觉标识 - 添加应用图标文件 - 添加方形30x30像素的图标文件以支持应用启动画面和系统显示 - 添加方形44x44像素应用图标文件 - 添加方形71x71像素应用图标以支持不同平台显示需求 - 添加新的方形89x89像素应用图标文件 - 添加新的正方形107x107像素应用图标文件 - 添加方形142x142像素的图标文件以支持应用启动画面和系统显示 - 添加新的方形150x150像素图标文件以用于应用程序界面显示 - 添加新的方形284x284像素应用图标文件 - 添加新的方形310x310像素应用图标文件 - 添加应用商店图标文件 - 添加原生桌面功能命令模块,包含示例问候函数以支持从 Rust 向前端传递消息。 - 添加侧车进程管理功能并注册全局状态与生命周期事件处理 - 添加启动配置以在发布模式下防止Windows出现额外控制台窗口,并启动应用主函数。 - 添加 Sidecar 服务启动与管理功能,自动查找可用端口、启动后端服务并创建主窗口,同时支持超时检测和进程清理。 - 添加 Tauri 项目配置文件并设置应用基本信息、打包选项及图标路径
4
.vscode/extensions.json
vendored
@@ -5,6 +5,8 @@
|
|||||||
"mikestead.dotenv",
|
"mikestead.dotenv",
|
||||||
"oven.bun-vscode",
|
"oven.bun-vscode",
|
||||||
"redhat.vscode-yaml",
|
"redhat.vscode-yaml",
|
||||||
"tamasfe.even-better-toml"
|
"rust-lang.rust-analyzer",
|
||||||
|
"tamasfe.even-better-toml",
|
||||||
|
"tauri-apps.tauri-vscode"
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
|
|||||||
3
build.ts
@@ -94,7 +94,8 @@ class BuildConfigService extends Context.Tag('BuildConfigService')<
|
|||||||
BuildConfigService,
|
BuildConfigService,
|
||||||
BuildConfigService.fromRaw({
|
BuildConfigService.fromRaw({
|
||||||
entrypoint: './.output/server/index.mjs',
|
entrypoint: './.output/server/index.mjs',
|
||||||
outputDir: './out',
|
// outputDir: './out',
|
||||||
|
outputDir: './src-tauri/binaries',
|
||||||
targets: ['bun-windows-x64', 'bun-darwin-arm64', 'bun-linux-x64'],
|
targets: ['bun-windows-x64', 'bun-darwin-arm64', 'bun-linux-x64'],
|
||||||
}),
|
}),
|
||||||
)
|
)
|
||||||
|
|||||||
25
bun.lock
@@ -31,6 +31,7 @@
|
|||||||
"@tanstack/react-devtools": "^0.9.2",
|
"@tanstack/react-devtools": "^0.9.2",
|
||||||
"@tanstack/react-query-devtools": "^5.91.2",
|
"@tanstack/react-query-devtools": "^5.91.2",
|
||||||
"@tanstack/react-router-devtools": "^1.151.0",
|
"@tanstack/react-router-devtools": "^1.151.0",
|
||||||
|
"@tauri-apps/cli": "^2.9.6",
|
||||||
"@types/bun": "^1.3.6",
|
"@types/bun": "^1.3.6",
|
||||||
"@vitejs/plugin-react": "^5.1.2",
|
"@vitejs/plugin-react": "^5.1.2",
|
||||||
"babel-plugin-react-compiler": "^1.0.0",
|
"babel-plugin-react-compiler": "^1.0.0",
|
||||||
@@ -531,6 +532,30 @@
|
|||||||
|
|
||||||
"@tanstack/virtual-file-routes": ["@tanstack/virtual-file-routes@1.145.4", "", {}, "sha512-CI75JrfqSluhdGwLssgVeQBaCphgfkMQpi8MCY3UJX1hoGzXa8kHYJcUuIFMOLs1q7zqHy++EVVtMK03osR5wQ=="],
|
"@tanstack/virtual-file-routes": ["@tanstack/virtual-file-routes@1.145.4", "", {}, "sha512-CI75JrfqSluhdGwLssgVeQBaCphgfkMQpi8MCY3UJX1hoGzXa8kHYJcUuIFMOLs1q7zqHy++EVVtMK03osR5wQ=="],
|
||||||
|
|
||||||
|
"@tauri-apps/cli": ["@tauri-apps/cli@2.9.6", "", { "optionalDependencies": { "@tauri-apps/cli-darwin-arm64": "2.9.6", "@tauri-apps/cli-darwin-x64": "2.9.6", "@tauri-apps/cli-linux-arm-gnueabihf": "2.9.6", "@tauri-apps/cli-linux-arm64-gnu": "2.9.6", "@tauri-apps/cli-linux-arm64-musl": "2.9.6", "@tauri-apps/cli-linux-riscv64-gnu": "2.9.6", "@tauri-apps/cli-linux-x64-gnu": "2.9.6", "@tauri-apps/cli-linux-x64-musl": "2.9.6", "@tauri-apps/cli-win32-arm64-msvc": "2.9.6", "@tauri-apps/cli-win32-ia32-msvc": "2.9.6", "@tauri-apps/cli-win32-x64-msvc": "2.9.6" }, "bin": { "tauri": "tauri.js" } }, "sha512-3xDdXL5omQ3sPfBfdC8fCtDKcnyV7OqyzQgfyT5P3+zY6lcPqIYKQBvUasNvppi21RSdfhy44ttvJmftb0PCDw=="],
|
||||||
|
|
||||||
|
"@tauri-apps/cli-darwin-arm64": ["@tauri-apps/cli-darwin-arm64@2.9.6", "", { "os": "darwin", "cpu": "arm64" }, "sha512-gf5no6N9FCk1qMrti4lfwP77JHP5haASZgVbBgpZG7BUepB3fhiLCXGUK8LvuOjP36HivXewjg72LTnPDScnQQ=="],
|
||||||
|
|
||||||
|
"@tauri-apps/cli-darwin-x64": ["@tauri-apps/cli-darwin-x64@2.9.6", "", { "os": "darwin", "cpu": "x64" }, "sha512-oWh74WmqbERwwrwcueJyY6HYhgCksUc6NT7WKeXyrlY/FPmNgdyQAgcLuTSkhRFuQ6zh4Np1HZpOqCTpeZBDcw=="],
|
||||||
|
|
||||||
|
"@tauri-apps/cli-linux-arm-gnueabihf": ["@tauri-apps/cli-linux-arm-gnueabihf@2.9.6", "", { "os": "linux", "cpu": "arm" }, "sha512-/zde3bFroFsNXOHN204DC2qUxAcAanUjVXXSdEGmhwMUZeAQalNj5cz2Qli2elsRjKN/hVbZOJj0gQ5zaYUjSg=="],
|
||||||
|
|
||||||
|
"@tauri-apps/cli-linux-arm64-gnu": ["@tauri-apps/cli-linux-arm64-gnu@2.9.6", "", { "os": "linux", "cpu": "arm64" }, "sha512-pvbljdhp9VOo4RnID5ywSxgBs7qiylTPlK56cTk7InR3kYSTJKYMqv/4Q/4rGo/mG8cVppesKIeBMH42fw6wjg=="],
|
||||||
|
|
||||||
|
"@tauri-apps/cli-linux-arm64-musl": ["@tauri-apps/cli-linux-arm64-musl@2.9.6", "", { "os": "linux", "cpu": "arm64" }, "sha512-02TKUndpodXBCR0oP//6dZWGYcc22Upf2eP27NvC6z0DIqvkBBFziQUcvi2n6SrwTRL0yGgQjkm9K5NIn8s6jw=="],
|
||||||
|
|
||||||
|
"@tauri-apps/cli-linux-riscv64-gnu": ["@tauri-apps/cli-linux-riscv64-gnu@2.9.6", "", { "os": "linux", "cpu": "none" }, "sha512-fmp1hnulbqzl1GkXl4aTX9fV+ubHw2LqlLH1PE3BxZ11EQk+l/TmiEongjnxF0ie4kV8DQfDNJ1KGiIdWe1GvQ=="],
|
||||||
|
|
||||||
|
"@tauri-apps/cli-linux-x64-gnu": ["@tauri-apps/cli-linux-x64-gnu@2.9.6", "", { "os": "linux", "cpu": "x64" }, "sha512-vY0le8ad2KaV1PJr+jCd8fUF9VOjwwQP/uBuTJvhvKTloEwxYA/kAjKK9OpIslGA9m/zcnSo74czI6bBrm2sYA=="],
|
||||||
|
|
||||||
|
"@tauri-apps/cli-linux-x64-musl": ["@tauri-apps/cli-linux-x64-musl@2.9.6", "", { "os": "linux", "cpu": "x64" }, "sha512-TOEuB8YCFZTWVDzsO2yW0+zGcoMiPPwcUgdnW1ODnmgfwccpnihDRoks+ABT1e3fHb1ol8QQWsHSCovb3o2ENQ=="],
|
||||||
|
|
||||||
|
"@tauri-apps/cli-win32-arm64-msvc": ["@tauri-apps/cli-win32-arm64-msvc@2.9.6", "", { "os": "win32", "cpu": "arm64" }, "sha512-ujmDGMRc4qRLAnj8nNG26Rlz9klJ0I0jmZs2BPpmNNf0gM/rcVHhqbEkAaHPTBVIrtUdf7bGvQAD2pyIiUrBHQ=="],
|
||||||
|
|
||||||
|
"@tauri-apps/cli-win32-ia32-msvc": ["@tauri-apps/cli-win32-ia32-msvc@2.9.6", "", { "os": "win32", "cpu": "ia32" }, "sha512-S4pT0yAJgFX8QRCyKA1iKjZ9Q/oPjCZf66A/VlG5Yw54Nnr88J1uBpmenINbXxzyhduWrIXBaUbEY1K80ZbpMg=="],
|
||||||
|
|
||||||
|
"@tauri-apps/cli-win32-x64-msvc": ["@tauri-apps/cli-win32-x64-msvc@2.9.6", "", { "os": "win32", "cpu": "x64" }, "sha512-ldWuWSSkWbKOPjQMJoYVj9wLHcOniv7diyI5UAJ4XsBdtaFB0pKHQsqw/ItUma0VXGC7vB4E9fZjivmxur60aw=="],
|
||||||
|
|
||||||
"@tybys/wasm-util": ["@tybys/wasm-util@0.10.1", "", { "dependencies": { "tslib": "^2.4.0" } }, "sha512-9tTaPJLSiejZKx+Bmog4uSubteqTvFrVrURwkmHixBo0G4seD0zUxp98E1DzUBJxLQ3NPwXrGKDiVjwx/DpPsg=="],
|
"@tybys/wasm-util": ["@tybys/wasm-util@0.10.1", "", { "dependencies": { "tslib": "^2.4.0" } }, "sha512-9tTaPJLSiejZKx+Bmog4uSubteqTvFrVrURwkmHixBo0G4seD0zUxp98E1DzUBJxLQ3NPwXrGKDiVjwx/DpPsg=="],
|
||||||
|
|
||||||
"@types/babel__core": ["@types/babel__core@7.20.5", "", { "dependencies": { "@babel/parser": "^7.20.7", "@babel/types": "^7.20.7", "@types/babel__generator": "*", "@types/babel__template": "*", "@types/babel__traverse": "*" } }, "sha512-qoQprZvz5wQFJwMDqeseRXWv3rqMvhgpbXFfVyWhbx9X47POIA6i/+dXefEmZKoAgOaTdaIgNSMqMIU61yRyzA=="],
|
"@types/babel__core": ["@types/babel__core@7.20.5", "", { "dependencies": { "@babel/parser": "^7.20.7", "@babel/types": "^7.20.7", "@types/babel__generator": "*", "@types/babel__template": "*", "@types/babel__traverse": "*" } }, "sha512-qoQprZvz5wQFJwMDqeseRXWv3rqMvhgpbXFfVyWhbx9X47POIA6i/+dXefEmZKoAgOaTdaIgNSMqMIU61yRyzA=="],
|
||||||
|
|||||||
@@ -1,3 +1,4 @@
|
|||||||
[tools]
|
[tools]
|
||||||
node = "24"
|
node = "24"
|
||||||
bun = "1.3"
|
bun = "1"
|
||||||
|
rust = 'latest'
|
||||||
|
|||||||
@@ -41,6 +41,7 @@
|
|||||||
"@tanstack/react-devtools": "^0.9.2",
|
"@tanstack/react-devtools": "^0.9.2",
|
||||||
"@tanstack/react-query-devtools": "^5.91.2",
|
"@tanstack/react-query-devtools": "^5.91.2",
|
||||||
"@tanstack/react-router-devtools": "^1.151.0",
|
"@tanstack/react-router-devtools": "^1.151.0",
|
||||||
|
"@tauri-apps/cli": "^2.9.6",
|
||||||
"@types/bun": "^1.3.6",
|
"@types/bun": "^1.3.6",
|
||||||
"@vitejs/plugin-react": "^5.1.2",
|
"@vitejs/plugin-react": "^5.1.2",
|
||||||
"babel-plugin-react-compiler": "^1.0.0",
|
"babel-plugin-react-compiler": "^1.0.0",
|
||||||
|
|||||||
10
src-tauri/.gitignore
vendored
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# Generated by Cargo
|
||||||
|
# will have compiled files and executables
|
||||||
|
/target/
|
||||||
|
|
||||||
|
# Generated by Tauri
|
||||||
|
# will have schema files for capabilities auto-completion
|
||||||
|
/gen/schemas
|
||||||
|
|
||||||
|
# Tauri Sidecar
|
||||||
|
binaries/
|
||||||
341
src-tauri/AGENTS.md
Normal file
@@ -0,0 +1,341 @@
|
|||||||
|
# AGENTS.md - Tauri Shell 项目开发指南
|
||||||
|
|
||||||
|
本文档为 AI 编程助手和开发者提供项目规范、构建命令和代码风格指南。
|
||||||
|
|
||||||
|
## 项目概览
|
||||||
|
|
||||||
|
- **项目类型**: Tauri v2 桌面应用(轻量级壳子)
|
||||||
|
- **后端**: Rust (Edition 2021)
|
||||||
|
- **架构**: Sidecar 模式 - Sidecar Server 承载主要业务逻辑
|
||||||
|
- **设计理念**: Tauri 仅提供原生桌面能力(文件对话框、系统通知等),Web 逻辑全部由 Sidecar Server 处理
|
||||||
|
- **异步运行时**: Tokio
|
||||||
|
- **Rust 版本**: 1.92.0+
|
||||||
|
- **工具管理**: 使用 mise 管理 Rust 和 Tauri CLI 版本(见 `mise.toml`)
|
||||||
|
|
||||||
|
## 构建、测试、运行命令
|
||||||
|
|
||||||
|
### 开发运行
|
||||||
|
```bash
|
||||||
|
# 开发模式运行 (带 hot-reload)
|
||||||
|
tauri dev
|
||||||
|
|
||||||
|
# 仅运行 Rust 二进制 (不推荐,需要手动启动 Sidecar Server)
|
||||||
|
cargo run
|
||||||
|
```
|
||||||
|
|
||||||
|
### 构建
|
||||||
|
```bash
|
||||||
|
# 开发构建 (debug mode)
|
||||||
|
cargo build
|
||||||
|
|
||||||
|
# 生产构建
|
||||||
|
cargo build --release
|
||||||
|
|
||||||
|
# Tauri 应用打包 (生成安装程序)
|
||||||
|
tauri build
|
||||||
|
```
|
||||||
|
|
||||||
|
### 代码检查
|
||||||
|
```bash
|
||||||
|
# 编译检查 (不生成二进制)
|
||||||
|
cargo check
|
||||||
|
|
||||||
|
# Clippy 代码质量检查
|
||||||
|
cargo clippy
|
||||||
|
|
||||||
|
# Clippy 严格模式 (所有警告视为错误)
|
||||||
|
cargo clippy -- -D warnings
|
||||||
|
|
||||||
|
# 代码格式化检查
|
||||||
|
cargo fmt -- --check
|
||||||
|
|
||||||
|
# 自动格式化代码
|
||||||
|
cargo fmt
|
||||||
|
```
|
||||||
|
|
||||||
|
### 测试
|
||||||
|
```bash
|
||||||
|
# 运行所有测试
|
||||||
|
cargo test
|
||||||
|
|
||||||
|
# 运行单个测试 (按名称过滤)
|
||||||
|
cargo test test_function_name
|
||||||
|
|
||||||
|
# 运行特定模块的测试
|
||||||
|
cargo test module_name::
|
||||||
|
|
||||||
|
# 显示测试输出 (包括 println!)
|
||||||
|
cargo test -- --nocapture
|
||||||
|
|
||||||
|
# 运行单个测试并显示输出
|
||||||
|
cargo test test_name -- --nocapture
|
||||||
|
```
|
||||||
|
|
||||||
|
### 清理
|
||||||
|
```bash
|
||||||
|
# 清理构建产物
|
||||||
|
cargo clean
|
||||||
|
```
|
||||||
|
|
||||||
|
## 项目结构
|
||||||
|
|
||||||
|
```
|
||||||
|
tauri-shell/
|
||||||
|
├── src/
|
||||||
|
│ ├── main.rs # 入口文件 (仅调用 lib::run)
|
||||||
|
│ ├── lib.rs # 核心应用逻辑 (注册插件、命令、状态)
|
||||||
|
│ ├── commands/
|
||||||
|
│ │ └── mod.rs # 原生桌面功能命令 (文件对话框、通知等)
|
||||||
|
│ └── sidecar.rs # Sidecar 进程管理 (启动、端口扫描、清理)
|
||||||
|
├── binaries/ # Sidecar 二进制文件
|
||||||
|
│ └── server-* # Sidecar Server 可执行文件 (示例: server)
|
||||||
|
├── capabilities/ # Tauri v2 权限配置
|
||||||
|
│ └── default.json
|
||||||
|
├── icons/ # 应用图标资源
|
||||||
|
├── gen/schemas/ # 自动生成的 Schema (不要手动编辑)
|
||||||
|
├── Cargo.toml # Rust 项目配置
|
||||||
|
├── tauri.conf.json # Tauri 应用配置
|
||||||
|
├── build.rs # Rust 构建脚本
|
||||||
|
└── mise.toml # 开发工具版本管理
|
||||||
|
```
|
||||||
|
|
||||||
|
## Rust 代码风格指南
|
||||||
|
|
||||||
|
### 导入 (Imports)
|
||||||
|
|
||||||
|
- 使用标准库、外部 crate、当前 crate 的顺序,用空行分隔
|
||||||
|
- 按字母顺序排列
|
||||||
|
- 优先使用具体导入而非通配符 `*`
|
||||||
|
|
||||||
|
```rust
|
||||||
|
// ✅ 推荐
|
||||||
|
use std::sync::Mutex;
|
||||||
|
use std::time::Duration;
|
||||||
|
|
||||||
|
use tauri::Manager;
|
||||||
|
use tauri_plugin_shell::ShellExt;
|
||||||
|
use tauri_plugin_shell::process::{CommandEvent, CommandChild};
|
||||||
|
|
||||||
|
// ❌ 避免
|
||||||
|
use tauri::*;
|
||||||
|
```
|
||||||
|
|
||||||
|
### 命名规范
|
||||||
|
|
||||||
|
- **函数和变量**: `snake_case`
|
||||||
|
- **类型、结构体、枚举、Trait**: `PascalCase`
|
||||||
|
- **常量和静态变量**: `SCREAMING_SNAKE_CASE`
|
||||||
|
- **生命周期参数**: 简短小写字母,如 `'a`, `'b`
|
||||||
|
|
||||||
|
```rust
|
||||||
|
// ✅ 推荐
|
||||||
|
struct SidecarProcess(Mutex<Option<CommandChild>>);
|
||||||
|
const DEFAULT_PORT: u16 = 3000;
|
||||||
|
async fn find_available_port(start: u16) -> u16 { }
|
||||||
|
|
||||||
|
// ❌ 避免
|
||||||
|
struct sidecar_process { }
|
||||||
|
const defaultPort: u16 = 3000;
|
||||||
|
```
|
||||||
|
|
||||||
|
### 类型注解
|
||||||
|
|
||||||
|
- 函数参数必须有类型注解
|
||||||
|
- 函数返回值必须明确声明 (除非返回 `()`)
|
||||||
|
- 优先使用具体类型而非 `impl Trait` (除非必要)
|
||||||
|
- 使用 `&str` 而非 `String` 作为只读字符串参数
|
||||||
|
|
||||||
|
```rust
|
||||||
|
// ✅ 推荐
|
||||||
|
#[tauri::command]
|
||||||
|
fn greet(name: &str) -> String {
|
||||||
|
format!("Hello, {}!", name)
|
||||||
|
}
|
||||||
|
|
||||||
|
async fn is_port_available(port: u16) -> bool {
|
||||||
|
tokio::net::TcpListener::bind(format!("127.0.0.1:{}", port))
|
||||||
|
.await
|
||||||
|
.is_ok()
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### 错误处理
|
||||||
|
|
||||||
|
- 使用 `Result<T, E>` 返回可能失败的操作
|
||||||
|
- 使用 `expect()` 时提供有意义的错误消息 (中文)
|
||||||
|
- 避免 `unwrap()` 在生产代码中,除非逻辑上保证不会 panic
|
||||||
|
- 使用 `?` 操作符传播错误
|
||||||
|
- 记录关键错误信息到控制台
|
||||||
|
|
||||||
|
```rust
|
||||||
|
// ✅ 推荐
|
||||||
|
let sidecar = app_handle
|
||||||
|
.shell()
|
||||||
|
.sidecar("server")
|
||||||
|
.expect("无法找到 server sidecar");
|
||||||
|
|
||||||
|
let (mut rx, child) = sidecar.spawn().expect("启动 sidecar 失败");
|
||||||
|
|
||||||
|
// 日志记录
|
||||||
|
eprintln!("✗ Sidecar Server 启动失败");
|
||||||
|
println!("✓ Sidecar Server 启动成功!");
|
||||||
|
|
||||||
|
// ❌ 避免
|
||||||
|
let data = read_file().unwrap(); // 无上下文信息
|
||||||
|
```
|
||||||
|
|
||||||
|
### 异步代码
|
||||||
|
|
||||||
|
- 使用 `async/await` 而非手动创建 Future
|
||||||
|
- Tauri 内部使用 `tauri::async_runtime::spawn` 启动异步任务
|
||||||
|
- 使用 Tokio 的异步 API (如 `tokio::net::TcpListener`)
|
||||||
|
- 避免阻塞异步运行时 (使用 `tokio::task::spawn_blocking`)
|
||||||
|
|
||||||
|
```rust
|
||||||
|
// ✅ 推荐
|
||||||
|
tauri::async_runtime::spawn(async move {
|
||||||
|
let port = find_available_port(3000).await;
|
||||||
|
// ...
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
### 格式化
|
||||||
|
|
||||||
|
- 使用 `cargo fmt` 自动格式化
|
||||||
|
- 缩进: 4 空格
|
||||||
|
- 行宽: 100 字符 (rustfmt 默认)
|
||||||
|
- 结构体和枚举的字段每行一个 (如果超过一定长度)
|
||||||
|
- 链式调用适当换行提高可读性
|
||||||
|
|
||||||
|
### 注释
|
||||||
|
|
||||||
|
- 使用中文注释说明复杂逻辑
|
||||||
|
- 代码块前添加简短说明注释
|
||||||
|
- 避免显而易见的注释
|
||||||
|
|
||||||
|
```rust
|
||||||
|
// ✅ 推荐
|
||||||
|
// 全局状态:存储 Sidecar Server 进程句柄
|
||||||
|
struct SidecarProcess(Mutex<Option<CommandChild>>);
|
||||||
|
|
||||||
|
// 检查端口是否可用
|
||||||
|
async fn is_port_available(port: u16) -> bool { }
|
||||||
|
```
|
||||||
|
|
||||||
|
## Tauri 特定规范
|
||||||
|
|
||||||
|
### 模块组织
|
||||||
|
|
||||||
|
- **`lib.rs`**: 主入口,负责注册插件、命令、状态管理
|
||||||
|
- **`commands/mod.rs`**: 所有 Tauri 命令集中定义,命令必须是 `pub fn`
|
||||||
|
- **`sidecar.rs`**: Sidecar 进程管理逻辑,导出公共 API(`spawn_sidecar`, `cleanup_sidecar_process`)
|
||||||
|
|
||||||
|
```rust
|
||||||
|
// lib.rs - 模块声明
|
||||||
|
mod commands;
|
||||||
|
mod sidecar;
|
||||||
|
|
||||||
|
use sidecar::SidecarProcess;
|
||||||
|
|
||||||
|
// 注册命令时使用模块路径
|
||||||
|
.invoke_handler(tauri::generate_handler![commands::greet])
|
||||||
|
```
|
||||||
|
|
||||||
|
### 命令定义
|
||||||
|
|
||||||
|
- 使用 `#[tauri::command]` 宏标记命令
|
||||||
|
- 命令函数必须是公开的或在 `invoke_handler` 中注册
|
||||||
|
- 参数类型必须实现 `serde::Deserialize`
|
||||||
|
- 返回类型必须实现 `serde::Serialize`
|
||||||
|
|
||||||
|
```rust
|
||||||
|
#[tauri::command]
|
||||||
|
fn greet(name: &str) -> String {
|
||||||
|
format!("Hello, {}!", name)
|
||||||
|
}
|
||||||
|
|
||||||
|
// 在 Builder 中注册
|
||||||
|
.invoke_handler(tauri::generate_handler![greet])
|
||||||
|
```
|
||||||
|
|
||||||
|
### 状态管理
|
||||||
|
|
||||||
|
- 使用 `app.manage()` 注册全局状态
|
||||||
|
- 状态必须实现 `Send + Sync`
|
||||||
|
- 使用 `Mutex` 或 `RwLock` 保证线程安全
|
||||||
|
|
||||||
|
```rust
|
||||||
|
struct SidecarProcess(Mutex<Option<CommandChild>>);
|
||||||
|
|
||||||
|
// 注册状态
|
||||||
|
app.manage(SidecarProcess(Mutex::new(None)));
|
||||||
|
|
||||||
|
// 访问状态
|
||||||
|
if let Some(state) = app_handle.try_state::<SidecarProcess>() {
|
||||||
|
*state.0.lock().unwrap() = Some(child);
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Sidecar 进程管理
|
||||||
|
|
||||||
|
- Sidecar 二进制必须在 `tauri.conf.json` 的 `bundle.externalBin` 中声明
|
||||||
|
- 使用 `app.shell().sidecar()` 启动 sidecar
|
||||||
|
- 在应用退出时清理子进程 (监听 `RunEvent::ExitRequested`)
|
||||||
|
|
||||||
|
```rust
|
||||||
|
// 启动 sidecar
|
||||||
|
let sidecar = app_handle
|
||||||
|
.shell()
|
||||||
|
.sidecar("server")
|
||||||
|
.expect("无法找到 server sidecar")
|
||||||
|
.env("NITRO_PORT", port.to_string());
|
||||||
|
|
||||||
|
// 清理进程
|
||||||
|
match event {
|
||||||
|
tauri::RunEvent::ExitRequested { .. } | tauri::RunEvent::Exit => {
|
||||||
|
if let Some(child) = process.take() {
|
||||||
|
let _ = child.kill();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
_ => {}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## 依赖管理
|
||||||
|
|
||||||
|
- 在 `Cargo.toml` 中明确声明依赖版本
|
||||||
|
- 使用语义化版本 (如 `"2"` 表示兼容 2.x.x)
|
||||||
|
- 仅启用需要的 feature 以减少编译时间和二进制大小
|
||||||
|
|
||||||
|
```toml
|
||||||
|
tauri = { version = "2", features = [] }
|
||||||
|
tauri-plugin-opener = "2"
|
||||||
|
tauri-plugin-shell = "2"
|
||||||
|
serde = { version = "1", features = ["derive"] }
|
||||||
|
tokio = { version = "1", features = ["net"] }
|
||||||
|
```
|
||||||
|
|
||||||
|
## 开发工具
|
||||||
|
|
||||||
|
推荐安装以下 VSCode 扩展:
|
||||||
|
- `tauri-apps.tauri-vscode` - Tauri 官方支持
|
||||||
|
- `rust-lang.rust-analyzer` - Rust 语言服务器
|
||||||
|
|
||||||
|
## 最佳实践
|
||||||
|
|
||||||
|
1. **进程生命周期**: 始终在应用退出时清理子进程和资源
|
||||||
|
2. **端口管理**: 使用端口扫描避免硬编码端口冲突
|
||||||
|
3. **超时处理**: 异步操作设置合理的超时时间 (如 5 秒)
|
||||||
|
4. **日志**: 使用表情符号 (✓/✗) 和中文消息提供清晰的状态反馈
|
||||||
|
5. **错误退出**: 关键错误时调用 `std::process::exit(1)`
|
||||||
|
6. **窗口配置**: 使用 `WebviewWindowBuilder` 动态创建窗口
|
||||||
|
|
||||||
|
## 提交代码前检查清单
|
||||||
|
|
||||||
|
- [ ] `cargo fmt` 格式化通过
|
||||||
|
- [ ] `cargo clippy` 无警告
|
||||||
|
- [ ] `cargo check` 编译通过
|
||||||
|
- [ ] `cargo test` 测试通过
|
||||||
|
- [ ] 更新相关注释和文档
|
||||||
|
- [ ] 检查是否有 `unwrap()` 需要替换为 `expect()`
|
||||||
|
- [ ] 验证 Tauri 应用正常启动和退出
|
||||||
4773
src-tauri/Cargo.lock
generated
Normal file
24
src-tauri/Cargo.toml
Normal file
@@ -0,0 +1,24 @@
|
|||||||
|
[package]
|
||||||
|
name = "tauri-shell"
|
||||||
|
version = "0.1.0"
|
||||||
|
description = "A Tauri App"
|
||||||
|
authors = ["imbytecat"]
|
||||||
|
edition = "2021"
|
||||||
|
|
||||||
|
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
|
||||||
|
|
||||||
|
[lib]
|
||||||
|
# The `_lib` suffix may seem redundant but it is necessary
|
||||||
|
# to make the lib name unique and wouldn't conflict with the bin name.
|
||||||
|
# This seems to be only an issue on Windows, see https://github.com/rust-lang/cargo/issues/8519
|
||||||
|
name = "tauri_shell_lib"
|
||||||
|
crate-type = ["staticlib", "cdylib", "rlib"]
|
||||||
|
|
||||||
|
[build-dependencies]
|
||||||
|
tauri-build = { version = "2", features = [] }
|
||||||
|
|
||||||
|
[dependencies]
|
||||||
|
tauri = { version = "2", features = [] }
|
||||||
|
tauri-plugin-shell = "2"
|
||||||
|
serde = { version = "1", features = ["derive"] }
|
||||||
|
tokio = { version = "1", features = ["net"] }
|
||||||
3
src-tauri/build.rs
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
fn main() {
|
||||||
|
tauri_build::build()
|
||||||
|
}
|
||||||
18
src-tauri/capabilities/default.json
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
{
|
||||||
|
"$schema": "../gen/schemas/desktop-schema.json",
|
||||||
|
"identifier": "default",
|
||||||
|
"description": "Capability for the main window",
|
||||||
|
"windows": ["main"],
|
||||||
|
"permissions": [
|
||||||
|
"core:default",
|
||||||
|
{
|
||||||
|
"identifier": "shell:allow-execute",
|
||||||
|
"allow": [
|
||||||
|
{
|
||||||
|
"name": "binaries/server",
|
||||||
|
"sidecar": true
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
BIN
src-tauri/icons/128x128.png
Normal file
|
After Width: | Height: | Size: 3.4 KiB |
BIN
src-tauri/icons/128x128@2x.png
Normal file
|
After Width: | Height: | Size: 6.8 KiB |
BIN
src-tauri/icons/32x32.png
Normal file
|
After Width: | Height: | Size: 974 B |
BIN
src-tauri/icons/Square107x107Logo.png
Normal file
|
After Width: | Height: | Size: 2.8 KiB |
BIN
src-tauri/icons/Square142x142Logo.png
Normal file
|
After Width: | Height: | Size: 3.8 KiB |
BIN
src-tauri/icons/Square150x150Logo.png
Normal file
|
After Width: | Height: | Size: 3.9 KiB |
BIN
src-tauri/icons/Square284x284Logo.png
Normal file
|
After Width: | Height: | Size: 7.6 KiB |
BIN
src-tauri/icons/Square30x30Logo.png
Normal file
|
After Width: | Height: | Size: 903 B |
BIN
src-tauri/icons/Square310x310Logo.png
Normal file
|
After Width: | Height: | Size: 8.4 KiB |
BIN
src-tauri/icons/Square44x44Logo.png
Normal file
|
After Width: | Height: | Size: 1.3 KiB |
BIN
src-tauri/icons/Square71x71Logo.png
Normal file
|
After Width: | Height: | Size: 2.0 KiB |
BIN
src-tauri/icons/Square89x89Logo.png
Normal file
|
After Width: | Height: | Size: 2.4 KiB |
BIN
src-tauri/icons/StoreLogo.png
Normal file
|
After Width: | Height: | Size: 1.5 KiB |
BIN
src-tauri/icons/icon.icns
Normal file
BIN
src-tauri/icons/icon.ico
Normal file
|
After Width: | Height: | Size: 85 KiB |
BIN
src-tauri/icons/icon.png
Normal file
|
After Width: | Height: | Size: 14 KiB |
8
src-tauri/src/commands/mod.rs
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
// 原生桌面功能命令
|
||||||
|
// 未来可能包含: 文件对话框、系统通知、剪贴板等
|
||||||
|
|
||||||
|
// 示例命令 (可根据需要删除或替换)
|
||||||
|
#[tauri::command]
|
||||||
|
pub fn greet(name: &str) -> String {
|
||||||
|
format!("Hello, {}! You've been greeted from Rust!", name)
|
||||||
|
}
|
||||||
35
src-tauri/src/lib.rs
Normal file
@@ -0,0 +1,35 @@
|
|||||||
|
use tauri::Manager;
|
||||||
|
|
||||||
|
// 模块声明
|
||||||
|
mod commands;
|
||||||
|
mod sidecar;
|
||||||
|
|
||||||
|
use sidecar::SidecarProcess;
|
||||||
|
|
||||||
|
#[cfg_attr(mobile, tauri::mobile_entry_point)]
|
||||||
|
pub fn run() {
|
||||||
|
tauri::Builder::default()
|
||||||
|
.plugin(tauri_plugin_shell::init())
|
||||||
|
.setup(|app| {
|
||||||
|
// 注册全局状态
|
||||||
|
app.manage(SidecarProcess(std::sync::Mutex::new(None)));
|
||||||
|
|
||||||
|
// 启动 Sidecar 进程
|
||||||
|
let app_handle = app.handle().clone();
|
||||||
|
sidecar::spawn_sidecar(app_handle);
|
||||||
|
|
||||||
|
Ok(())
|
||||||
|
})
|
||||||
|
.invoke_handler(tauri::generate_handler![commands::greet])
|
||||||
|
.build(tauri::generate_context!())
|
||||||
|
.expect("error while building tauri application")
|
||||||
|
.run(|app_handle, event| {
|
||||||
|
// 监听应用退出事件,清理 Sidecar 进程
|
||||||
|
match event {
|
||||||
|
tauri::RunEvent::ExitRequested { .. } | tauri::RunEvent::Exit => {
|
||||||
|
sidecar::cleanup_sidecar_process(app_handle);
|
||||||
|
}
|
||||||
|
_ => {}
|
||||||
|
}
|
||||||
|
});
|
||||||
|
}
|
||||||
6
src-tauri/src/main.rs
Normal file
@@ -0,0 +1,6 @@
|
|||||||
|
// Prevents additional console window on Windows in release, DO NOT REMOVE!!
|
||||||
|
#![cfg_attr(not(debug_assertions), windows_subsystem = "windows")]
|
||||||
|
|
||||||
|
fn main() {
|
||||||
|
tauri_shell_lib::run()
|
||||||
|
}
|
||||||
131
src-tauri/src/sidecar.rs
Normal file
@@ -0,0 +1,131 @@
|
|||||||
|
use std::sync::Mutex;
|
||||||
|
use std::time::Duration;
|
||||||
|
|
||||||
|
use tauri::Manager;
|
||||||
|
use tauri_plugin_shell::process::{CommandChild, CommandEvent};
|
||||||
|
use tauri_plugin_shell::ShellExt;
|
||||||
|
|
||||||
|
// ===== 配置常量 =====
|
||||||
|
|
||||||
|
/// Sidecar Server 启动超时时间(秒)
|
||||||
|
const STARTUP_TIMEOUT_SECS: u64 = 5;
|
||||||
|
|
||||||
|
/// 默认起始端口
|
||||||
|
const DEFAULT_PORT: u16 = 3000;
|
||||||
|
|
||||||
|
/// 端口扫描范围(从起始端口开始扫描的端口数量)
|
||||||
|
const PORT_SCAN_RANGE: u16 = 100;
|
||||||
|
|
||||||
|
/// 窗口默认宽度
|
||||||
|
const DEFAULT_WINDOW_WIDTH: f64 = 1200.0;
|
||||||
|
|
||||||
|
/// 窗口默认高度
|
||||||
|
const DEFAULT_WINDOW_HEIGHT: f64 = 800.0;
|
||||||
|
|
||||||
|
/// 窗口标题
|
||||||
|
const WINDOW_TITLE: &str = "Tauri App";
|
||||||
|
|
||||||
|
// ===== 数据结构 =====
|
||||||
|
|
||||||
|
/// 全局状态:存储 Sidecar 进程句柄
|
||||||
|
pub struct SidecarProcess(pub Mutex<Option<CommandChild>>);
|
||||||
|
|
||||||
|
// 检查端口是否可用
|
||||||
|
async fn is_port_available(port: u16) -> bool {
|
||||||
|
tokio::net::TcpListener::bind(format!("127.0.0.1:{}", port))
|
||||||
|
.await
|
||||||
|
.is_ok()
|
||||||
|
}
|
||||||
|
|
||||||
|
// 查找可用端口
|
||||||
|
async fn find_available_port(start: u16) -> u16 {
|
||||||
|
for port in start..start + PORT_SCAN_RANGE {
|
||||||
|
if is_port_available(port).await {
|
||||||
|
return port;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
start // 回退到起始端口
|
||||||
|
}
|
||||||
|
|
||||||
|
/// 启动 Sidecar 进程并创建主窗口
|
||||||
|
pub fn spawn_sidecar(app_handle: tauri::AppHandle) {
|
||||||
|
tauri::async_runtime::spawn(async move {
|
||||||
|
// 查找可用端口
|
||||||
|
let port = find_available_port(DEFAULT_PORT).await;
|
||||||
|
println!("使用端口: {}", port);
|
||||||
|
|
||||||
|
// 启动 sidecar
|
||||||
|
let sidecar = app_handle
|
||||||
|
.shell()
|
||||||
|
.sidecar("server")
|
||||||
|
.expect("无法找到 server")
|
||||||
|
.env("NITRO_PORT", port.to_string());
|
||||||
|
|
||||||
|
let (mut rx, child) = sidecar.spawn().expect("启动 sidecar 失败");
|
||||||
|
|
||||||
|
// 保存进程句柄到全局状态
|
||||||
|
if let Some(state) = app_handle.try_state::<SidecarProcess>() {
|
||||||
|
*state.0.lock().unwrap() = Some(child);
|
||||||
|
}
|
||||||
|
|
||||||
|
// 监听 stdout,等待服务器就绪信号
|
||||||
|
let start_time = std::time::Instant::now();
|
||||||
|
let timeout = Duration::from_secs(STARTUP_TIMEOUT_SECS);
|
||||||
|
let mut server_ready = false;
|
||||||
|
|
||||||
|
while let Some(event) = rx.recv().await {
|
||||||
|
if let CommandEvent::Stdout(line) = event {
|
||||||
|
let output = String::from_utf8_lossy(&line);
|
||||||
|
println!("Server: {}", output);
|
||||||
|
|
||||||
|
// 检测服务器启动成功的标志
|
||||||
|
if output.contains("Listening on:") || output.contains("localhost") {
|
||||||
|
server_ready = true;
|
||||||
|
println!("✓ Server 启动成功!");
|
||||||
|
|
||||||
|
// 创建主窗口
|
||||||
|
let url = format!("http://localhost:{}", port);
|
||||||
|
tauri::WebviewWindowBuilder::new(
|
||||||
|
&app_handle,
|
||||||
|
"main",
|
||||||
|
tauri::WebviewUrl::External(url.parse().unwrap()),
|
||||||
|
)
|
||||||
|
.title(WINDOW_TITLE)
|
||||||
|
.inner_size(DEFAULT_WINDOW_WIDTH, DEFAULT_WINDOW_HEIGHT)
|
||||||
|
.center()
|
||||||
|
.build()
|
||||||
|
.expect("创建窗口失败");
|
||||||
|
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// 超时检查
|
||||||
|
if start_time.elapsed() > timeout {
|
||||||
|
eprintln!(
|
||||||
|
"✗ 启动超时: Server 未能在 {} 秒内启动",
|
||||||
|
STARTUP_TIMEOUT_SECS
|
||||||
|
);
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if !server_ready {
|
||||||
|
eprintln!("✗ Server 启动失败");
|
||||||
|
std::process::exit(1);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
/// 清理 Sidecar 进程 (在应用退出时调用)
|
||||||
|
pub fn cleanup_sidecar_process(app_handle: &tauri::AppHandle) {
|
||||||
|
println!("应用退出,正在清理 Sidecar 进程...");
|
||||||
|
if let Some(state) = app_handle.try_state::<SidecarProcess>() {
|
||||||
|
if let Ok(mut process) = state.0.lock() {
|
||||||
|
if let Some(child) = process.take() {
|
||||||
|
let _ = child.kill();
|
||||||
|
println!("✓ Sidecar 进程已终止");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
27
src-tauri/tauri.conf.json
Normal file
@@ -0,0 +1,27 @@
|
|||||||
|
{
|
||||||
|
"$schema": "https://schema.tauri.app/config/2",
|
||||||
|
"productName": "tauri-shell",
|
||||||
|
"version": "0.1.0",
|
||||||
|
"identifier": "com.imbytecat.tauri-shell",
|
||||||
|
"app": {
|
||||||
|
"withGlobalTauri": true,
|
||||||
|
"windows": [],
|
||||||
|
"security": {
|
||||||
|
"csp": null
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"bundle": {
|
||||||
|
"active": true,
|
||||||
|
"targets": "all",
|
||||||
|
"icon": [
|
||||||
|
"icons/32x32.png",
|
||||||
|
"icons/128x128.png",
|
||||||
|
"icons/128x128@2x.png",
|
||||||
|
"icons/icon.icns",
|
||||||
|
"icons/icon.ico"
|
||||||
|
],
|
||||||
|
"externalBin": [
|
||||||
|
"binaries/server"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||