You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
2.7 KiB
2.7 KiB
新增与移除模块
一条命令创建示例
pnpm module:new greeting
pnpm format
命令创建 src/main/modules/greeting.ts,声明 greeting.echo 的共享契约,并加入组合入口。已有文件或契约不会被覆盖。主窗口会获得新接口权限;其他窗口需显式配置。
Renderer 调用:
import { desktop } from '@/lib/desktop'
const message = await desktop.call('greeting.echo', 'Hello')
手动添加业务能力
- 在
packages/contracts/src/index.ts的routes中声明输入和输出 schema。 - 建立纯业务服务,通过构造参数传入数据、日志等依赖;不要在文件 import 时打开数据库或注册全局事件。
- 在
src/main/modules建立AppModule,用ipc.register注册路由,将返回的注销函数传给scope.add。 - 在
src/main/modules/index.ts中添加模块,并声明需要的模块依赖。 - 如需 settings/about 窗口调用,在
windowPermissions中显式授予方法;必要时缩小 main 权限列表。 - 在 renderer 调用 API,异步失败要反馈给用户。给安全边界与持久化行为加测试。
import type { AppModule } from '../context'
export const greetingModule: AppModule = {
id: 'greeting',
dependsOn: ['preferences'],
setup({ ipc }, scope) {
scope.add(ipc.register('greeting.echo', (message) => message))
const timer = setInterval(() => {
/* background work */
}, 60_000)
scope.add(() => clearInterval(timer))
}
}
不要把 secrets 的明文读取接口注册到 IPC。AI 或其他需要凭据的请求应在主进程执行,renderer 只收到允许展示的业务结果。
事件
在 eventSchemas 声明载荷,在 windowEvents 授予接收角色,使用 ipc.emit 推送;敏感或资源专属事件应传 owner。Renderer 的 desktop.on 返回退订函数,必须在组件卸载时调用。
const stop = desktop.on('files.changed', (event) => console.log(event.name))
onUnmounted(stop)
没有每次订阅就新增主进程全局监听的机制;preload 的本地监听集合负责订阅管理。
数据库迁移
在 src/main/migrations/index.ts 的 migrations 数组追加连续版本。每个迁移包含 SQL 字符串,不接受 renderer SQL。框架在事务中更新结构与 user_version,失败回滚。业务 repository 在对应的应用模块中;迁移通过构造参数交给通用 SQLite 适配器。
移除能力
从组合入口移除模块注册即可使路由返回 UNAVAILABLE。同时删掉对应示例 UI。要彻底删除能力的依赖,继续从 AppContext、bootstrap 和 desktop exports 中删除服务,并重新运行检查。不应仅靠隐藏按钮作为权限撤销。