博客分类: 官方教程

返回目录索引
本文内容为官方文档多部分整合：
原文链接：

• Building Installation Package Bundles
• Create the Skeleton Bundle Authoring
• Author Bootstrapper Application for a Bundle
• Author a Bundle Package Manifest
• Burn Built-in Variables
• Define Searches Using Variables
• Chain Packages into a Bundle

译文链接：WiX Toolset入门——安装包捆版包基础元素介绍

在本节中，我们将介绍使用WiX Toolset创建简单的安装包捆绑包的基础知识。

捆绑包是将多个安装包的集合到一个安装包进行安装。捆绑包常用于安装一个.msi应用的先决条件，例如.NET Framework或Visual C++ Runtime。捆绑包还允许将大型应用或应用套件拆分为小型的逻辑安装包，但在给最终用户时，仍然可以是单个产品。

为了为多个安装包提供无缝的安装体验，WiX toolset提供了一个名为Burn的引擎（通常是一个bootstrapper或chainer）。Burn引擎是一个可执行文件，它托管了一个名为bootstrapper应用的dll。bootstrapper应用dll负责用最终用户呈现UI，以及控制Burn引擎何时进行下载、安装、修复和卸载操作。大部分开发者不许与Burn引擎打交道，因为WiX toolset提供了一个标准的bootstrapper应用以及其创建捆绑包所需的语言。

下面将会介绍WiX 捆绑包语言以及如何使用它来创建捆绑包。

创建捆绑包基础结构

本节元素索引：<Bundle>、<WiX>、<BootstrapperApplicationRef>、<Chain>、<Variable>。

捆绑包中的根元素是<Bundle>。<Bundle>元素是<WiX>元素的直接子节点。下面是一个空捆绑包示例：

<?xml version="1.0"?>
<Wix xmlns="http://schemas.microsoft.com/wix/2006/wi">
<Bundle>
    <!-- Contents of the bundle goes here -->
</Bundle>
</Wix>

在以下示例中，我们会为<Bundle>元素添加以下元素：

• <BootstrapperApplicationRef>
• <Chain>
• <Variable>

首先，为<Bundle>添加两个最常用的元素，示例如下：

<?xml version="1.0"?>
<Wix xmlns="http://schemas.microsoft.com/wix/2006/wi">
<Bundle>
    <BootstrapperApplicationRef />
    <Chain>
    </Chain>
</Bundle>
</Wix>

<BootstrapperApplicationRef>元素最终会指向WiX toolset提供的标准Bootstrapper应用，而<Chain>元素最终是包含要打包到一起的安装包列表。

现在你有一个基础的Bundle结构，参见下一节继续为<BootstrapperApplicationRef>元素添加信息。

为捆绑包添加Bootstrapper应用处理

本节元素索引：<BootstrapperApplication>、<BootstrapperApplicationRef>、<Framement>、<PayloadGroup>。

每一个捆绑包都需要一个bootstrapper应用来驱动Burn引擎。<BootstrapperApplication>元素用于定义一个新的bootstrapper应用。<BootstrapperApplicationRef>元素则用于指向已有的bootstrapper应用 —— 在<Framement>中定义或在WiX扩展里。

WiX标准Bootstrapper应用在WixBalExtension.dll中。下面展示如何使用捆绑包：

<?xml version="1.0"?>
<Wix xmlns="http://schemas.microsoft.com/wix/2006/wi">
    <Bundle>
    <BootstrapperApplicationRef Id="WixStandardBootstrapperApplication.RtfLicense" />
    <Chain>
    </Chain>
    </Bundle>
</Wix>

WiX标准Bootstrapper应用可能无法满足专业捆绑包所需的所有功能要求，所以这时需要开发自定义的bootstrapper应用dll。以下是如何使用自定义dll，假设我们创建了一个名为ba.dll的bootstrapper应用：

<?xml version="1.0"?>
<Wix xmlns="http://schemas.microsoft.com/wix/2006/wi">
    <Bundle>
    <BootstrapperApplication SourceFile="path\to\ba.dll" />
    <Chain>
    </Chain>
    </Bundle>
</Wix>

在<BootstrapperApplication>元素和<BootstrapperApplicationRef>元素中，你可能需要附加payload文件，如：bootstrapper应用dll所需要的资源文件。

<?xml version="1.0"?>
<Wix xmlns="http://schemas.microsoft.com/wix/2006/wi">
    <Bundle>
    <BootstrapperApplication SourceFile="path\to\ba.dll">
        <Payload SourceFile="path\to\en-us\resources.dll" />
        <PayloadGroupRef Id="ResourceGroupforJapanese" />
    </BootstrapperApplication>
    <Chain>
    </Chain>
    </Bundle>
</Wix>

此示例中引用了一个名为resources.dll的本地payload文件，以及一个payload文件组 —— 使用<PayloadGroup>元素在其他位置的Framement中定义。

编辑捆绑包中的内容（安装包）清单

本节元素索引：<Chain>、<Fragment>、<PackageGroupRef>。

为了让Bundle可以使用任何包，则需要针对包写出描述包的定义。它可以直接写在Bundle中的<Chain>元素下面，也可以写在一个<Fragment>中，然后利用<PackageGroudRef>将它引用到Bundle的<Chain>中使用。其中后一种方法，可以用来在各个捆绑包之间共享同一个包定义。

WiX架构支持链接以下包类型：

• <MsiPackage>
• <ExePackage>
• <MspPackage>
• <MsuPackage>

以下是一个包含ExePackage的共享片段示例：

<?xml version="1.0"?>
<Wix xmlns="http://schemas.microsoft.com/wix/2006/wi">
<Fragment>
    <PackageGroup Id="MyPackage">
        <ExePackage 
        SourceFile="[sources]\packages\shared\MyPackage.exe"
        DetectCondition="ExeDetectedVariable"
        DownloadUrl="http://example.com/?mypackage.exe"
        InstallCommand="/q /ACTION=Install"
        RepairCommand="/q ACTION=Repair /hideconsole"
        UninstallCommand="/q ACTION=Uninstall /hideconsole" />
    </PackageGroup>
</Fragment>
</Wix>

现在你可以为安装包添加安装条件 —— 只能在x86 Windows XP及以上的系统中安装。WiX中含有一些内置变量，可以用来创建条件语句。下面示例中InstallCondition="NOT VersionNT64 AND VersionNT >= v5.1"即表示如何利用内置变量创建条件：

<?xml version="1.0"?>
<Wix xmlns="http://schemas.microsoft.com/wix/2006/wi">
    <Fragment>
    <PackageGroup Id="MyPackage">
        <ExePackage 
            SourceFile="[sources]\packages\shared\MyPackage.exe"
            DetectCondition="ExeDetectedVariable"
            DownloadUrl="http://example.com/?mypackage.exe"
            InstallCommand="/q /ACTION=Install"
            RepairCommand="/q ACTION=Repair /hideconsole"
            UninstallCommand="/q ACTION=Uninstall /hideconsole" 
            InstallCondition="NOT VersionNT64 AND VersionNT >= v5.1" />
    </PackageGroup>
    </Fragment>
</Wix>    

其中VersionNT属性支持4段的版本号（[Major].[Minor].[Build].[Revision]）。有关Windows操作系统的主要版本和次要版本列表见：Operating System Version。

另外，你也可以在里面定义自己的变量，并保存搜索结果。更多内容见本文的后续部分。

捆绑包内置变量

Burn引擎中提供了一组常用的变量，这样我们直接使用它们，而不用自定义变量。下面是内置变量列表：

利用变量定义/存储搜索

搜索功能是用于检测目标机器是否满足一定条件。搜索的结果存储在一个变量中。然后利用变量构建安装条件。搜索的架构位于WixUtilExtension中。以下为支持的搜索列表：

• <FileSearch>
• <RegistrySearch>
• <DirectorySearch>
• <ComponentSearch>
• <ProductSearch>

搜索可以依赖于其他搜索的结果。注意，所有的搜索都在WiXUtilExtension中。因此，你需要在代码中添加WiXUtilExtension的命名空间。下面为示例代码：

<?xml version="1.0"?>
<Wix xmlns="http://schemas.microsoft.com/wix/2006/wi"
    xmlns:util="http://schemas.microsoft.com/wix/UtilExtension">
<Fragment>
    <util:RegistrySearch Id="Path"
        Variable="UniqueId"
        Root="HKLM,SOFTWARE\Microsoft\MyProduct\Unique Id\"
        Key="Product"
        Result="Value" />
    <util:RegistrySearch 
        Variable="patchLevel"
        Root="HKLM,SOFTWARE\Microsoft\MyProduct\[UniqueId]\Setup"
        Key="PatchLevel"
        Result="Exists" 
        After="Path" />
</Fragment>
</Wix>

在将搜索定义好后，并将其存储到变量中，就可以将变量用于安装条件了。例如，你可以为你的安装包添加搜索和安装条件来使用安装条件中的注册表搜索结果。下面示例包含了条件和搜索定义的完整的代码片段：

<?xml version="1.0"?>
<Wix xmlns="http://schemas.microsoft.com/wix/2006/wi"
        xmlns:util="http://schemas.microsoft.com/wix/UtilExtension">
    <Fragment>
    <util:RegistrySearch Id="Path"
        Variable="UniqueId"
        Root="HKLM,SOFTWARE\Microsoft\MyProduct\Unique Id\"
        Key="Product"
        Result="Value" />
    <util:RegistrySearch 
        Variable="patchLevel"
        Root="HKLM,SOFTWARE\Microsoft\MyProduct\[UniqueId]\Setup"
        Key="PatchLevel"
        Result="Exists" 
        After="Path" />

    <PackageGroup Id="MyPackage">
        <ExePackage 
        SourceFile="[sources]\packages\shared\MyPackage.exe"
        DownloadURL="http://mywebdomain.com/?mypackage.exe"
        InstallCommand="/q /ACTION=Install"
        RepairCommand="/q ACTION=Repair /hideconsole"
        UninstallCommand="/q ACTION=Uninstall /hideconsole"
        InstallCondition="x86 = 1 AND OSVersion >= v5.0.5121.0 AND patchLevel = 0" />
    </PackageGroup>
    </Fragment>
</Wix>  

现在，你有一个完全定义的代码片段，且它可以共享给其他包使用。关于更多链接包内容见下节。

在捆绑包中链接包

要链接一个包，可以直接写在Bundle中的<Chain>元素下面，也可以写在一个<Fragment>中，然后利用<PackageGroudRef>将它引用到Bundle的<Chain>中使用。其中后一种方法，可以用来在各个捆绑包之间共享同一个包定义。

以下为直接定义到<Chain>中的代码示例：

<?xml version="1.0"?>
<Wix xmlns="http://schemas.microsoft.com/wix/2006/wi">
    <Bundle>
    <BootstrapperApplicationRef Id="WixStandardBootstrapperApplication.RtfLicense" />

    <Chain>
        <ExePackage
            SourceFile="path\to\MyPackage.exe"
            DownloadUrl="http://example.com/?mypackage.exe"
            InstallCommand="/q /ACTION=Install"
            RepairCommand="/q ACTION=Repair /hideconsole" />
    </Chain>
    </Bundle>
</Wix>

以下为引用共享包定义的示例：

<?xml version="1.0"?>
<Wix xmlns="http://schemas.microsoft.com/wix/2006/wi">
    <Bundle>
    <BootstrapperApplicationRef Id="WixStandardBootstrapperApplication.RtfLicense" />

    <Chain>
        <PackageGroupRef Id="MyPackage" />
    </Chain>
    </Bundle>
</Wix>

至此，捆绑包的基础元素就讲完了。后面将会是捆绑包的使用内容。

译：奇葩史

没有评论