ZTools 插件开发实战：详解 ztools API 对象，剪贴板、模拟输入与持久化存储一网打尽

ZTools 插件开发实战详解 ztools API 对象剪贴板、模拟输入与持久化存储一网打尽【免费下载链接】ZToolsAn open-source implementation of uTools, a high-performance, scalable application launcher and plugin platform | Supports macOS and Windows, 一个高性能、可扩展的应用启动器和插件平台 uTools 的开源实现 | 支持 macOS 和 Windows项目地址: https://gitcode.com/gh_mirrors/ztool/ZToolsZTools 是一个高性能、可扩展的开源应用启动器和插件平台uTools 的开源实现支持 macOS 与 Windows。本文带你实战 ZTools 插件开发详解全局ztoolsAPI 对象中的三大核心能力剪贴板操作、模拟输入、持久化存储帮助新手快速上手写出第一个功能完整的插件。为什么选择 ZTools 插件开发ZTools 插件系统支持UI 插件和无界面headless插件两种形态通过一个全局ztools对象即可访问系统能力通知、剪贴板、模拟输入、持久化存储、窗口控制等。它的开发体验对新手非常友好简单配置一个 plugin.json 定义插件元信息无需复杂构建丰富 API完整的 TypeScript 类型支持调用ztools对象即可跨平台一次开发Windows / macOS 一致体验主进程中所有插件 API 通过统一的分发器 pluginApiDispatcher.ts 注册与路由同步 API 走ipcMain.on异步 API 走ipcMain.handle这就是你在插件代码里ztools.xxx()调用的底层通道。插件骨架一个最小可运行的插件长什么样一个 ZTools 插件的核心就是两个文件plugin.json—— 声明插件名称、logo、命令keyword、钩子等preload.js—— 插件逻辑入口在这里使用ztools对象仓库里提供了一个最小可参考的插件骨架直接照着改就能跑起来示例插件配置plugin.json示例插件逻辑preload.js示例说明文档README.md{ main: preload.js, name: my-first-plugin, description: 我的第一个 ZTools 插件 }在 preload 里命令触发时ztools对象会自动注入作用域你只需要写业务逻辑。剪贴板 API复制、读取一网打尽剪贴板是效率插件最常用的能力。ZTools 的插件剪贴板 API 实现在 src/main/api/plugin/clipboard.ts提供四类基础操作能力说明复制文本将字符串写入系统剪贴板复制图片支持 Data URL、文件路径、二进制 Buffer复制文件将本地文件写入剪贴板Windows / macOS读取剪贴板文件获取剪贴板中的文件列表及路径典型场景搜索结果一键复制、截图后把图片复制到目标应用、批量复制文件路径。 注意区分这里的剪贴板 API 是基础读写操作而 ZTools 主程序自带的剪贴板历史管理截图、文本历史是独立模块见 src/shared/clipboard.ts。模拟输入让插件替用户操作这是ztools对象中最强大的部分实现在 src/main/api/plugin/input.ts。插件不仅能读写剪贴板还能模拟真实的键盘与鼠标⌨️模拟键盘按键simulateKeyboardTap(key, modifiers)支持组合键如 ShiftEnter️模拟鼠标移动、单击、双击、右键发送输入事件向活动插件页面注入键盘/鼠标/滚轮事件页面内查找findInPage在当前插件页面中搜索文本更实用的还有粘贴到外部应用系列 API它们会自动完成隐藏主窗口 → 暂停剪贴板监听 → 写入剪贴板 → 模拟 Ctrl/CmdV 粘贴的完整流程hideMainWindowPasteText—— 粘贴文本到外部应用hideMainWindowPasteImage—— 粘贴图片支持 base64 / 路径 / 二进制hideMainWindowTypeString—— 逐字符键入字符串正确处理 emoji 等多码点字符换行自动转为 ShiftEnter这类 API 是密码填充、快捷短语展开、一键填写表单类插件的核心。持久化存储插件数据的安全归宿插件的状态、用户配置、运行记录都需要持久化存储。ZTools 底层采用高性能的LMDB 嵌入式数据库src/core/lmdb/index.ts插件通过ztools的存储 API 以键值key-value方式读写数据✅数据隔离每个插件拥有独立的存储命名空间互不干扰⚡高性能LMDB 提供极快的读写速度安全卸载插件时其数据可被独立清理插件侧通常以ztools.dbGet(key)/ztools.dbSet(key, value)这类形式操作底层由主进程的数据库 API 分发处理相关实现可参考 src/main/api/plugin/internal.ts 与 src/main/api/shared/database.ts。把三块能力组合起来一个完整示例思路以快捷复制插件为例把本文能力串起来用户在搜索框输入关键词触发插件命令插件用存储 API 读取上次保存的常用短语列表用户选择一条短语调用剪贴板 API 写入系统剪贴板调用模拟粘贴 API把短语粘贴到之前激活的外部应用用存储 API 更新最近使用记录下次优先展示整个流程无需用户离开当前工作这就是启动器插件平台的核心价值。调试与进阶调试插件插件页面点击Open DevTools按钮即可查看控制台热重载开发模式下修改 preload 逻辑即时生效配合pnpm dev启动更多 API窗口控制window.ts、UI 交互ui.ts、通知toast.ts等能力扩展想给 ZTools 增加翻译 / OCR 能力参考 Provider 接入指南 docs/provider-development-guide.md用ztools.registerProvider注册你的实现示例见 docs/examples/provider-example/小结能力核心模块适用场景剪贴板读写clipboard.ts复制文本/图片/文件、读取剪贴板模拟输入input.ts键盘鼠标自动化、粘贴到外部应用持久化存储lmdb/保存插件配置与用户数据掌握ztools对象的这三大能力你已经可以开发出覆盖绝大多数效率场景的 ZTools 插件。从 docs/examples/provider-example/ 的示例骨架起步动手写出你的第一个插件吧【免费下载链接】ZToolsAn open-source implementation of uTools, a high-performance, scalable application launcher and plugin platform | Supports macOS and Windows, 一个高性能、可扩展的应用启动器和插件平台 uTools 的开源实现 | 支持 macOS 和 Windows项目地址: https://gitcode.com/gh_mirrors/ztool/ZTools创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考