跳到主要内容

HTML打包EXE新增API说明：版本号获取与请求头注入

HTML打包EXE工具近期新增了两个实用API，分别用于版本信息读取和网络请求头动态注入。本文会用最常见的业务场景来说明如何使用它们。

新增API一览​

  1. window.HTMLPackHelper.getVersion()
  2. window.HTMLPackHelper.setRequestHeaders(urlPattern, headers)
  3. window.HTMLPackHelper.removeRequestHeaders(urlPattern)

一、获取版本号API：getVersion​

作用​

读取打包时配置的应用版本号。

典型使用场景​

  1. 在软件“关于页面”展示当前版本。
  2. 启动时对比服务端版本，提示用户升级。
  3. 上报日志时带上本地版本，便于问题排查。

示例代码​

const currentVersion = window.HTMLPackHelper.getVersion();
console.log('当前版本:', currentVersion);

// 未配置版本时，默认返回 "1.0.0.0"

二、请求头注入API：setRequestHeaders​

作用​

对匹配的URL请求动态附加自定义HTTP Header。

典型使用场景​

  1. 给接口统一携带 Authorization Token。
  2. 给指定域名附加渠道标识（如 X-Channel）。
  3. 对接旧系统时补充接口要求的固定请求头。

示例代码：添加请求头​

window.HTMLPackHelper.setRequestHeaders('https://api.example.com/*', {
    Authorization: 'Bearer your-token',
    'X-Channel': 'html2exe-client',
    'X-App-Version': window.HTMLPackHelper.getVersion(),
});

示例代码：移除请求头​

window.HTMLPackHelper.removeRequestHeaders('https://api.example.com/*');

三、组合使用建议​

你可以在应用启动后先读取版本号，再统一注入到请求头中，方便后端快速识别客户端版本：

const version = window.HTMLPackHelper.getVersion();

window.HTMLPackHelper.setRequestHeaders('https://api.example.com/*', {
    'X-App-Version': version,
});

四、注意事项​

  1. 仅在打包时启用API支持后可调用 window.HTMLPackHelper。
  2. urlPattern 建议按业务域名精确匹配，避免误影响其他请求。
  3. 若某些接口不再需要自定义请求头，请及时调用 removeRequestHeaders 清理规则。

五、相关文档​