Back to Lobehub

@lobechat/electron-server-ipc

packages/electron-server-ipc/README.zh-CN.md

2.1.562.5 KB
Original Source

@lobechat/electron-server-ipc

LobeHub 的 Electron 应用与服务端之间的 IPC(进程间通信)模块,提供可靠的跨进程通信能力。

📝 简介

@lobechat/electron-server-ipc 是 LobeHub 桌面应用的核心组件,负责处理 Electron 主进程与 nextjs 服务端之间的通信。它提供了一套简单而健壮的 API,用于在不同进程间传递数据和执行远程方法调用。

🛠️ 核心功能

  • 可靠的 IPC 通信: 基于 Socket 的通信机制,确保跨进程通信的稳定性和可靠性
  • 自动重连机制: 客户端具备断线重连功能,提高应用稳定性
  • 类型安全: 使用 TypeScript 提供完整的类型定义,确保 API 调用的类型安全
  • 跨平台支持: 同时支持 Windows、macOS 和 Linux 平台

🧩 核心组件

IPC 服务端 (ElectronIPCServer)

负责监听客户端请求并响应,通常运行在 Electron 的主进程中:

typescript
import { ElectronIPCEventHandler, ElectronIPCServer } from '@lobechat/electron-server-ipc';

// 定义处理函数
const eventHandler: ElectronIPCEventHandler = {
  getDatabasePath: async () => {
    return '/path/to/database';
  },
  // 其他处理函数...
};

// 创建并启动服务器
const server = new ElectronIPCServer(eventHandler);
server.start();

IPC 客户端 (ElectronIpcClient)

负责连接到服务端并发送请求,通常在服务端(如 Next.js 服务)中使用:

typescript
import { ElectronIPCMethods, ElectronIpcClient } from '@lobechat/electron-server-ipc';

// 创建客户端
const client = new ElectronIpcClient();

// 发送请求
const dbPath = await client.sendRequest(ElectronIPCMethods.getDatabasePath);

🤝 参与贡献

IPC 服务端实现需要处理各种通信场景和边缘情况。我们欢迎社区贡献来增强可靠性和功能性。您可以通过以下方式参与改进:

如何贡献

  1. 性能优化:提高 IPC 通信速度和可靠性
  2. 错误处理:增强错误恢复和重连机制
  3. 新功能:添加新的 IPC 方法或通信模式支持
  4. 文档改进:改进代码文档和使用示例

贡献流程

  1. Fork LobeHub 仓库
  2. 对 IPC 服务端包实施改进
  3. 提交 Pull Request 并描述:
  • 性能改进或新功能
  • 测试方法和结果
  • 兼容性考虑
  • 使用示例

📌 说明

这是 LobeHub 的内部模块 ("private": true),专为 LobeHub 桌面应用设计,不作为独立包发布。