refactor: 统一将 Nitro 相关命名更新为 Sidecar
- 将文档中所有关于 Nitro Server 的表述统一更新为 Sidecar Server,以准确反映当前架构中后端服务的命名和职责。 - 更新进程管理名称与相关函数调用,将 Nitro 相关的组件和操作统一替换为 Sidecar,以反映当前模块的正确命名和功能。 - 将 Nitro 相关的进程管理功能重命名为 Sidecar,更新结构体、函数和日志信息以反映新的命名和功能,确保进程启动、状态管理和清理逻辑正确指向新的 Sidecar 进程。
This commit is contained in:
30
AGENTS.md
30
AGENTS.md
@@ -6,8 +6,8 @@
|
||||
|
||||
- **项目类型**: Tauri v2 桌面应用(轻量级壳子)
|
||||
- **后端**: Rust (Edition 2021)
|
||||
- **架构**: Sidecar 模式 - Nitro Server 承载主要业务逻辑
|
||||
- **设计理念**: Tauri 仅提供原生桌面能力(文件对话框、系统通知等),Web 逻辑全部由 Nitro 处理
|
||||
- **架构**: Sidecar 模式 - Sidecar Server 承载主要业务逻辑
|
||||
- **设计理念**: Tauri 仅提供原生桌面能力(文件对话框、系统通知等),Web 逻辑全部由 Sidecar Server 处理
|
||||
- **异步运行时**: Tokio
|
||||
- **Rust 版本**: 1.92.0+
|
||||
|
||||
@@ -18,7 +18,7 @@
|
||||
# 开发模式运行 (带 hot-reload)
|
||||
cargo tauri dev
|
||||
|
||||
# 仅运行 Rust 二进制 (不推荐,需要手动启动 Nitro)
|
||||
# 仅运行 Rust 二进制 (不推荐,需要手动启动 Sidecar Server)
|
||||
cargo run
|
||||
```
|
||||
|
||||
@@ -85,9 +85,9 @@ tauri-shell/
|
||||
│ ├── lib.rs # 核心应用逻辑 (注册插件、命令、状态)
|
||||
│ ├── commands/
|
||||
│ │ └── mod.rs # 原生桌面功能命令 (文件对话框、通知等)
|
||||
│ └── sidecar.rs # Nitro 进程管理 (启动、端口扫描、清理)
|
||||
│ └── sidecar.rs # Sidecar Server 进程管理 (启动、端口扫描、清理)
|
||||
├── binaries/ # Sidecar 二进制文件
|
||||
│ └── nitro-server-* # Nitro Server 可执行文件
|
||||
│ └── nitro-server-* # Sidecar Server 可执行文件 (示例: nitro-server)
|
||||
├── capabilities/ # Tauri v2 权限配置
|
||||
│ └── default.json
|
||||
├── icons/ # 应用图标资源
|
||||
@@ -128,12 +128,12 @@ use tauri::*;
|
||||
|
||||
```rust
|
||||
// ✅ 推荐
|
||||
struct NitroProcess(Mutex<Option<CommandChild>>);
|
||||
struct SidecarProcess(Mutex<Option<CommandChild>>);
|
||||
const DEFAULT_PORT: u16 = 3000;
|
||||
async fn find_available_port(start: u16) -> u16 { }
|
||||
|
||||
// ❌ 避免
|
||||
struct nitro_process { }
|
||||
struct sidecar_process { }
|
||||
const defaultPort: u16 = 3000;
|
||||
```
|
||||
|
||||
@@ -176,8 +176,8 @@ let sidecar = app_handle
|
||||
let (mut rx, child) = sidecar.spawn().expect("启动 sidecar 失败");
|
||||
|
||||
// 日志记录
|
||||
eprintln!("✗ Nitro 服务器启动失败");
|
||||
println!("✓ Nitro 服务器启动成功!");
|
||||
eprintln!("✗ Sidecar Server 启动失败");
|
||||
println!("✓ Sidecar Server 启动成功!");
|
||||
|
||||
// ❌ 避免
|
||||
let data = read_file().unwrap(); // 无上下文信息
|
||||
@@ -214,8 +214,8 @@ tauri::async_runtime::spawn(async move {
|
||||
|
||||
```rust
|
||||
// ✅ 推荐
|
||||
// 全局状态:存储 Nitro 进程句柄
|
||||
struct NitroProcess(Mutex<Option<CommandChild>>);
|
||||
// 全局状态:存储 Sidecar Server 进程句柄
|
||||
struct SidecarProcess(Mutex<Option<CommandChild>>);
|
||||
|
||||
// 检查端口是否可用
|
||||
async fn is_port_available(port: u16) -> bool { }
|
||||
@@ -234,7 +234,7 @@ async fn is_port_available(port: u16) -> bool { }
|
||||
mod commands;
|
||||
mod sidecar;
|
||||
|
||||
use sidecar::NitroProcess;
|
||||
use sidecar::SidecarProcess;
|
||||
|
||||
// 注册命令时使用模块路径
|
||||
.invoke_handler(tauri::generate_handler![commands::greet])
|
||||
@@ -264,13 +264,13 @@ fn greet(name: &str) -> String {
|
||||
- 使用 `Mutex` 或 `RwLock` 保证线程安全
|
||||
|
||||
```rust
|
||||
struct NitroProcess(Mutex<Option<CommandChild>>);
|
||||
struct SidecarProcess(Mutex<Option<CommandChild>>);
|
||||
|
||||
// 注册状态
|
||||
app.manage(NitroProcess(Mutex::new(None)));
|
||||
app.manage(SidecarProcess(Mutex::new(None)));
|
||||
|
||||
// 访问状态
|
||||
if let Some(state) = app_handle.try_state::<NitroProcess>() {
|
||||
if let Some(state) = app_handle.try_state::<SidecarProcess>() {
|
||||
*state.0.lock().unwrap() = Some(child);
|
||||
}
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user