编写一个简单的 .wxs 文件

.wxs 文件是 WiX 工具集中用来描述安装包内容和行为的核心文件，使用 XML 语言定义安装程序的结构和逻辑。本文将带你了解 .wxs 文件的主要标签及其功能，并通过示例演示如何创建一个功能简单的安装包。

---

什么是 .wxs 文件？

.wxs 文件是 WiX 工具集的源文件，用于定义安装程序的所有细节，如安装的文件、注册表项、快捷方式、用户界面等。通过 WiX 编译器（candle.exe）和链接器（light.exe），可以将 .wxs 文件转换为 MSI 或 EXE 安装包。

---

核心标签及其功能

以下是 .wxs 文件中常用的核心标签及其用途：

1. <Wix> 标签

• 作用：顶层标签，定义整个 .wxs 文件的 XML 命名空间。
• 示例：

<Wix xmlns="http://wixtoolset.org/schemas/v4/wxs">
  <!-- 其他内容 -->
</Wix>

2. <Product> 标签

• 作用：定义安装包的基本信息，如名称、版本号和制造商。
• 常用属性：
  • Id: 产品的唯一标识符（通常使用 * 自动生成）。
  • Name: 安装包的名称。
  • Version: 产品的版本号。
  • UpgradeCode: 用于识别同一产品的不同版本。
• 示例：

<Product Id="*" Name="MyApp" Language="1033" Version="1.0.0.0" Manufacturer="MyCompany" UpgradeCode="12345678-1234-1234-1234-123456789012">
  <!-- 其他内容 -->
</Product>

3. <Package> 标签

• 作用：定义安装包的行为和安装范围。
• 常用属性：
  • InstallerVersion: 安装程序的最低版本要求。
  • Compressed: 是否压缩安装文件。
  • InstallScope: 安装范围（perMachine 或 perUser）。
• 示例：

<Package InstallerVersion="500" Compressed="yes" InstallScope="perMachine" />

4. <Directory> 标签

• 作用：定义安装程序的目录结构。
• 常用属性：
  • Id: 目录的唯一标识符。
  • Name: 目录的名称。
• 示例：

<Directory Id="TARGETDIR" Name="SourceDir">
  <Directory Id="ProgramFilesFolder">
    <Directory Id="INSTALLFOLDER" Name="MyApp" />
  </Directory>
</Directory>

5. <Component> 标签

• 作用：组织安装资源（文件、注册表等）的基本单元。
• 注意：每个 <Component> 都需要一个唯一的 GUID。
• 示例：

<Component Id="MainComponent" Guid="*">
  <File Id="MyAppExe" Source="bin\MyApp.exe" KeyPath="yes" />
</Component>

6. <File> 标签

• 作用：定义要安装的文件。
• 常用属性：
  • Id: 文件的唯一标识符。
  • Source: 文件的源路径。
  • KeyPath: 指定文件是否为组件的关键路径。
• 示例：

<File Id="MyAppExe" Source="bin\MyApp.exe" KeyPath="yes" />

7. <Feature> 标签

• 作用：定义安装包中的功能模块，并将组件分配到功能中。
• 常用属性：
  • Id: 功能的唯一标识符。
  • Title: 功能的显示名称。
  • Level: 安装级别（1 表示默认安装）。
• 示例：

<Feature Id="MainFeature" Title="Main Application" Level="1">
  <ComponentRef Id="MainComponent" />
</Feature>

---

完整示例：创建一个简单的安装包

以下是一个完整的 .wxs 文件示例，展示如何创建一个安装 MyApp.exe 的安装包：

<?xml version="1.0" encoding="UTF-8"?>
<Wix xmlns="http://wixtoolset.org/schemas/v4/wxs">
	<Package Name="SetupProjectTest" Language="1033" Version="1.0.0.0" Manufacturer="MyCompany" UpgradeCode="65c47cb8-c116-4b88-b6e6-8d496c0a1440" InstallerVersion="200">
		<MajorUpgrade DowngradeErrorMessage="A newer version of [ProductName] is already installed." />
		<Feature Id="ProductFeature" Title="SetupProjectTest" Level="1">
			<ComponentGroupRef Id="ProductComponents" />
		</Feature>
	</Package>

	<Fragment>
		<StandardDirectory Id="ProgramFilesFolder">
			<Directory Id="INSTALLFOLDER" Name="SetupProjectTest" />
		</StandardDirectory>
	</Fragment>

	<Fragment>
		<ComponentGroup Id="ProductComponents" Directory="INSTALLFOLDER">
			<Component Id="WebSocketClientComponent" Guid="*">
				<File Id="WebSocketClient.exe" Source="D:\Workstation\Demo\SetupProjectTest\SetupProjectTest\WebSocketClient.exe" KeyPath="yes" />
			</Component>
			<Component Id="WebSocketServerComponent" Guid="*">
				<File Id="WebSocketServer.exe" Source="D:\Workstation\Demo\SetupProjectTest\SetupProjectTest\WebSocketServer.exe" KeyPath="yes" />
			</Component>
		</ComponentGroup>
	</Fragment>
</Wix>

---

最佳实践

1. 使用唯一的 GUID：

   • 对每个 <Component> 使用 Guid="*"，以确保安装包的组件具有唯一性。

2. 模块化设计：

   • 使用 <Fragment> 将复杂的 .wxs 文件拆分为多个文件，便于管理。

3. 添加本地化支持：

   • 使用 .wxl 文件定义本地化字符串，提高安装程序的多语言支持能力。

4. 调试与验证：

   • 使用 candle.exe 和 light.exe 编译 .wxs 文件，确保文件无语法错误。

---

总结

.wxs 文件是 WiX 工具集的核心，灵活使用这些标签可以帮助你构建功能强大且专业的安装包。从定义产品信息到配置文件和目录结构，每个标签都扮演着重要角色。通过实践和不断优化，你将能够轻松驾驭 .wxs 文件的编写，为用户提供高质量的安装体验。