Electron应用（electron-builder打包）卸载时删除Windows注册表项的最佳方法

针对electron-builder打包的两种Windows安装包（.exe和.appx/MSIX），需要分别采用对应机制实现卸载时的注册表清理，以下是具体方案：

一、针对.exe安装包（NSIS/WiX） #

electron-builder默认用NSIS打包.exe，也支持WiX，两者都可以通过自定义脚本实现卸载时的注册表删除。

1. NSIS打包方案 #

• 明确注册表路径
  先确定应用创建的注册表项路径，比如HKCU\Software\YourAppID（当前用户）或HKLM\Software\YourAppID（本地机器，需管理员权限）。
• 配置自定义卸载脚本
  在electron-builder配置文件（如package.json或electron-builder.yml）中指定卸载脚本路径：

  {
    "build": {
      "nsis": {
        "uninstallScript": "./scripts/uninstall.nsh"
      }
    }
  }
  

• 编写NSIS卸载脚本
  在uninstall.nsh中添加删除注册表的命令，示例：

  ; 删除当前用户下的应用注册表项
  DeleteRegKey HKCU "Software\YourAppID"
  ; 若有子项，可按需删除（/ifempty表示仅当子项为空时删除）
  DeleteRegKey /ifempty HKCU "Software\YourAppID\SubKey"
  ; 删除本地机器下的项（需安装时以管理员权限运行）
  DeleteRegKey HKLM "Software\YourAppID"
  

  NSIS脚本会自动在卸载流程中执行这段逻辑，无需额外触发。

2. WiX打包方案 #

如果使用WiX作为.exe打包工具，可通过自定义WiX模板实现：

• 创建自定义WiX模板
  在.wxs模板文件中添加RemoveRegistryKey元素，指定卸载时要删除的注册表路径：

  <DirectoryRef Id="TARGETDIR">
    <Component Id="CleanupRegistry" Guid="YOUR-UNIQUE-GUID">
      <!-- 卸载时删除当前用户下的注册表项 -->
      <RemoveRegistryKey Action="removeOnUninstall" Root="HKCU" Key="Software\YourAppID" />
      <!-- 卸载时删除本地机器下的注册表项 -->
      <RemoveRegistryKey Action="removeOnUninstall" Root="HKLM" Key="Software\YourAppID" />
    </Component>
  </DirectoryRef>
  

• 关联模板到electron-builder
  在配置文件中指定WiX模板路径：

  {
    "build": {
      "wix": {
        "template": "./scripts/installer-template.wxs"
      }
    }
  }
  

  WiX会在卸载流程中自动执行注册表清理操作。

二、针对Windows Store的.appx/MSIX包 #

.appx/MSIX采用沙箱机制，注册表处理逻辑和.exe有本质区别，分两种场景处理：

1. 应用专属注册表路径（推荐） #

如果应用将注册表项写入沙箱内的专属路径（如HKCU\Software\YourPublisherName\YourAppName，或通过WinRT API存储的设置），Windows Store应用卸载时，系统会自动清理这些沙箱内的所有数据，无需额外代码。

2. 非沙箱注册表路径（需特殊处理） #

若必须写入系统级注册表（如与其他桌面应用交互），需通过以下方式实现卸载清理：

• 声明权限
  在Package.appxmanifest中添加所需的注册表访问权限（如registryWrite），提交到Windows Store时需说明权限用途。
• 监听卸载事件
  编写后台任务监听PackageUninstalling系统事件，在触发时执行注册表删除逻辑。可以用C#/C++编写后台任务，也可通过Electron调用WinRT API实现：

  // 在Electron主进程中监听卸载事件（需借助winrt-api库）
  const { Windows } = require('winrt-api');
  const packageManager = Windows.Management.Deployment.PackageManager();
  // 注册卸载事件监听（简化示例，实际需处理后台任务逻辑）
  packageManager.addEventListener('packageUninstalling', (args) => {
    if (args.package.id.name === 'YourAppPackageName') {
      // 执行删除注册表逻辑，如删除HKLM\Software\YourAppID
      // 需注意权限，可能需要管理员权限
    }
  });
  

• 备选方案：启动时检查卸载状态
  在应用启动时，检查当前是否处于卸载流程中，若为是则执行注册表清理。这种方式可靠性略低，但实现简单：

  // Electron主进程
  app.on('ready', () => {
    const isUninstalling = process.argv.some(arg => arg.includes('uninstall'));
    if (isUninstalling) {
      // 执行注册表删除逻辑
      // 完成后退出应用
      app.quit();
    }
  });
  

通用注意事项 #

• 注册表路径要精准，避免误删系统或其他应用的注册表项；
• 针对HKLM路径的操作，.exe安装包需以管理员权限运行，卸载时也需管理员权限；
• 测试时需分别验证.exe和.appx的卸载流程，确保注册表项被正确清理。

内容的提问来源于stack exchange，提问作者Davide Briscese