HTML一键打包EXE工具最新版本扩展API参考

发表于 分类于

本篇文档汇总了 HTML 一键打包 EXE 工具对外暴露的 API 接口及用法说明。使用这些 API 之前，请在打包时的高级配置页面勾选「开启 API 支持」。如下图所示：

启用 API 支持

本文按功能模块整理，包含窗口控制、文件读写、剪切板、串口、请求头设置等常用接口示例，便于在打包后的页面中直接调用。

机器码相关

  • 获取机器码（用于实现自定义认证逻辑）：
1
window.HTMLPackHelper.machineCode;
  • 获取更稳定的唯一机器码：
1
window.HTMLPackHelper.getUniqueMachineCode();

窗口控制 API

  • 最大化窗口：
1
window.HTMLPackHelper.maximize();
  • 最小化窗口：
1
window.HTMLPackHelper.minimize();
  • 恢复窗口大小：
1
window.HTMLPackHelper.restore();
  • 关闭应用：
1
window.HTMLPackHelper.close();
  • 切换全屏状态：
1
window.HTMLPackHelper.toggleFullscreen();

导航与运行本地文件

  • 返回主页：
1
window.HTMLPackHelper.backToHomePage();
  • 打开本地可执行或文件（支持相对路径和绝对路径）：
1
window.HTMLPackHelper.open(path);

示例：

1
2
window.HTMLPackHelper.open('C:/Windows/notepad.exe'); // 打开记事本
window.HTMLPackHelper.open('my.docx'); // 打开 exe 所在目录下的 my.docx 文件

调试与闪烁

  • 打开调试窗口：
1
window.HTMLPackHelper.openDebug();
  • 开始窗口闪烁：
1
window.HTMLPackHelper.flashWindow();
  • 停止窗口闪烁：
1
window.HTMLPackHelper.stopFlashWindow();

本地存储 API

  • 获取当前存储数据的大小（字节）：
1
window.HTMLPackHelper.getStorageSize();
  • 读取数据：
1
window.HTMLPackHelper.get(key); // key 为字符串
  • 写入数据：
1
window.HTMLPackHelper.set(key, value); // key 为字符串, value 为要保存的字符串
  • 清除所有数据：
1
window.HTMLPackHelper.clear();

剪切板

  • 获取剪切板字符串：
1
window.HTMLPackHelper.getClipboardString();

缓存与系统控制

  • 清理缓存：
1
window.HTMLPackHelper.clearAllCache();
  • 关闭计算机（调用后可关闭电脑）：
1
window.HTMLPackHelper.shutdownSystem();

获取 Mac 地址

在打包时启用 API 后，可在页面中直接获取电脑的 Mac 地址信息，例如返回结果类似：0b:00:28:00:00:0c。

1
window.HTMLPackHelper.getMac();

串口通信（SerialPort）

  • 获取 SerialPort 类示例：
1
const SerialPort = HTMLPackHelper.getSerialPort().SerialPort;

命令行参数

  • 获取应用启动时的命令行参数：
1
HTMLPackerHelper.getArgv();

返回结果为数组，其中第一个值为当前 EXE 所在路径，后续值为启动 EXE 时传入的命令行参数。示例图：

读写文件 API

  • 读取用户目录下的文件（不存在时抛出异常）：
1
const content = HTMLPackHelper.getFileContent('dd.ini');
  • 读取文件并提供默认值（不存在时返回默认值）：
1
const content = HTMLPackHelper.getFileContent('dd.ini', 'default');
  • 向用户目录写入文件内容：
1
HTMLPackHelper.writeFileContent('dd.ini', 'ddd');

获取版本号

获取打包时配置的应用版本号，便于页面展示或用于版本比较、自动更新等场景。

1
2
// 返回打包时配置的版本号字符串，例如 "1.2.0.0"，未配置时默认返回 "1.0.0.0"
const version = window.HTMLPackHelper.getVersion();

设置与移除请求头

用于在发起网络请求时动态添加自定义 HTTP 请求头，例如携带身份 Token 或设置自定义来源标识。

  • 设置请求头：
1
2
3
4
5
6
// urlPattern 为匹配请求 URL 的字符串或通配符模式
// headers 为包含请求头键值对的对象
window.HTMLPackHelper.setRequestHeaders('https://api.example.com/*', {
    Authorization: 'Bearer your-token',
    'X-Custom-Header': 'value',
});
  • 移除请求头：
1
window.HTMLPackHelper.removeRequestHeaders('https://api.example.com/*');

退出回调

  • 在应用退出前可以注册回调以执行清理或确认逻辑：
1
2
3
4
5
6
window.HTMLPackHelper.onQuit = () => {
    // 你的业务逻辑
    // return false: 处理完成后不关闭程序
    // return true: 处理完成后关闭程序
    return false;
};

以上为工具所提供的主要 API 汇总。使用时请确保在打包配置中启用 API 支持，并根据需要在页面中捕获异常或做权限校验以保证运行安全。