需按六步开发utools插件:一、创建含manifest.json和main.html的项目结构;二、配置manifest关键字段;三、在main.html中接入utools sdk并监听事件;四、实现ipc通信与本地数据库操作;五、配置调试与热更新;六、校验打包后发布。

如果您希望为uTools平台构建专属功能插件,并利用前端技术实现高度定制化交互,则需要基于其插件开发规范完成环境搭建、入口配置与UI集成。以下是使用HTML/CSS/JS技术栈开发uTools自定义插件的进阶操作步骤:
一、创建插件项目结构
uTools插件依赖标准的JSON描述文件与静态资源目录,所有前端代码需置于同一插件根目录下,由uTools主进程加载渲染。插件必须包含manifest.json作为元信息载体,并指定main.html为默认UI入口。
1、在本地新建文件夹,命名为my-plugin;
2、在该文件夹内创建manifest.json文件,写入插件名称、图标路径、触发关键词及主页面路径;
3、在同级目录下创建main.html文件,作为插件运行时唯一渲染页面;
4、确保manifest.json中"main"字段值为"main.html",且"platform"字段包含"win"或"mac"以匹配目标系统。
二、配置manifest.json关键字段
manifest.json是uTools识别插件能力的核心配置文件,其字段直接影响插件能否被正确加载、是否支持快捷唤起、能否响应上下文菜单等行为。缺失必要字段将导致插件无法注册成功。
1、设置"name"为插件显示名称,不可为空;
2、指定"icon"为相对路径下的PNG图标文件,尺寸建议128×128像素;
3、填写"keywords"数组,至少包含一个中文或英文关键词,用于全局搜索唤起;
4、启用"shell"字段并设为true,允许插件接收命令行参数;
5、添加"description"字段说明插件用途,长度不超过200字符;
6、确认"engine"字段值为"uTools",版本号与当前uTools客户端兼容。
三、在main.html中接入uTools SDK
uTools提供window.utools对象作为宿主通信桥梁,所有插件逻辑必须通过该对象调用API实现数据交换、窗口控制与事件监听。未引入SDK或未等待ready事件即调用方法会导致API不可用。
1、在main.html的<script></script>标签内声明window.utools存在性检测;
2、使用window.utools.onPluginReady监听插件初始化完成事件;
3、在回调函数中调用window.utools.hideMainWindow()隐藏主窗口(如需独立弹窗);
4、通过window.utools.setSubInput绑定子输入框事件,实现动态过滤;
5、使用window.utools.showNotification触发桌面通知,参数为title与content对象;
6、调用window.utools.db访问本地键值数据库,支持异步get/set操作。
四、实现跨进程通信与数据持久化
插件运行于独立渲染进程中,需借助uTools提供的IPC机制与主进程交换数据。本地存储默认使用SQLite封装的键值对数据库,不支持直接执行SQL语句,仅开放基础CRUD接口。
1、调用window.utools.db.set("config", {theme: "dark", fontSize: 14})保存用户配置;
2、使用window.utools.db.get("config")读取已存对象,返回Promise实例;
3、在main.html中监听utools-on-plugin-exit自定义事件,执行清理逻辑;
4、通过window.utools.copyText("复制内容")向系统剪贴板写入文本;
5、调用window.utools.openUrl("https://example.com")在默认浏览器中打开链接;
6、使用window.utools.showOpenDialog弹出文件选择器,返回选中路径数组。
五、调试与热更新配置
uTools支持插件热重载,但需满足特定条件才能生效。调试阶段若未触发自动刷新,需检查路径映射与watch机制是否激活。错误日志统一输出至uTools开发者工具控制台,而非浏览器F12面板。
1、启动uTools后,按下Ctrl+Shift+I(Windows)或Cmd+Option+I(Mac)打开插件调试窗口;
2、将插件文件夹拖入uTools插件管理页的“本地插件”区域完成加载;
3、修改main.html或JS文件后,按Ctrl+R(Win)或Cmd+R(Mac)强制重载当前插件;
4、在manifest.json中添加"dev"字段并设为true,启用开发模式增强日志;
5、使用window.utools.log("调试信息")输出带时间戳的日志条目;
6、确认插件目录无中文路径或空格,否则可能导致热更新失败。
六、打包与发布前校验
正式发布插件前必须通过uTools官方校验工具验证结构完整性与安全性策略。压缩包内禁止包含node_modules、.git目录及可执行二进制文件,否则会被拒绝上架。
1、删除插件目录下所有非必要文件,仅保留manifest.json、main.html及相关静态资源;
2、将图标文件统一转为PNG格式,命名保持小写,路径在manifest中准确引用;
3、检查main.html中所有外部脚本是否采用相对路径引入,禁用HTTP/HTTPS远程地址;
4、运行utools-cli verify ./my-plugin命令执行本地合规性扫描;
5、使用utools-cli pack ./my-plugin生成.zip分发包;
6、登录uTools插件市场后台,上传ZIP包并填写分类、截图与更新日志。
前端入门到VUE实战笔记:立即使用
在学习笔记中,你将探索 前端 的入门与实战技巧!










