wix - 从 WiX 设置项目引用在 WiX 库项目中定义的 WixVariable

Question

我正在尝试配置 WiX 设置和库，以便将库中文件之一的版本用作设置中的 Product/@Version。

背景

在本地定义文件的设置中，这相对简单，因为假设组件项目被 WiX 项目引用然后配置:

  <Component Id="Company.Assembly" Guid="[GUID]">
    <File Id="Company.AssemblyFile"
          Name="Company.Assembly.dll" KeyPath="yes"
          DiskId="1"
          Source="$(var.Company.Assembly.TargetPath)" />
  </Component>

那么产品版本可以设置为

  <Product Id="[GUID]"
           Name="Product Name"
           Language="1033"
           Version="!(bind.FileVersion.$(var.Company.AssemblyFile
                    .TargetFileName))"
           Manufacturer="Company Name"
           UpgradeCode="[GUID]">

问题

因此，将所有组件移至 WiX 库项目后，将无法再直接引用 !(bind.FileVersion.$(var.Company.AssemblyFile.TargetFileName))多变的。

我尝试在库中配置 WixVariable

WixVariable Id="BuildVersion" Value="!(bind.FileVersion.Company.AssemblyFile)"/>

然后从设置中引用它

  <Product Id="[GUID]"
           Name="Product Name"
           Language="1033"
           Version="!(wix.BuildVersion)"
           Manufacturer="Company Name"
           UpgradeCode="[GUID]">

没有成功。

库或设置中是否需要一些额外的步骤或语法才能使 WixVariable(或它的某些派生)可以从设置中访问？

Answer 1

我经常听到这个，我不认为 WiX 文档在解释情况方面做得特别好，所以在这里。简短的回答是您的语法是正确的；用 WixVariable 声明的变量使用语法 !(wix.VariableName) 引用元素并且您可以使用已在引用库中定义的变量，因此 !(wix.BuildVersion)对于您上面给出的示例是正确的。它不起作用的原因是因为该值需要在编译阶段进行验证，但直到链接阶段才生成。所以这是一个很长的答案:

您可以在 *.wxs 文件中引用两种不同类型的变量；预处理器变量和绑定(bind)器(或链接器)变量。前者用 $ 语法引用，例如$(var.VariableName)后者用 !语法，例如!(bind.FileVersion.FileId) .关键区别很简单:预处理器变量在编译阶段(通过candle.exe)进行解析，而binder 变量在链接阶段(通过light.exe)进行解析。编译器负责获取源 *.wxs 文件并将它们编译为 *.wixobj 文件；它不处理实际的有效负载，因此无法从链接文件中读取版本信息。然后将 *.wixobj 文件传递​​给链接器，该链接器处理有效负载并创建 MSI 数据库。链接器负责从有效负载中收集元数据，这就是为什么它可以为 !(bind.FileVersion.FileId) 等变量提供值的原因。 .

请注意，使用 WixVariable 声明的变量元素用 !语法，所以它是一个活页夹变量；它对 light.exe 可用，但对 candle.exe 不可用。这是一个问题，因为candle.exe 将验证应用于某些字段，例如Product/@Version。它不知道是什么!(wix.BuildVersion)将评估为，因此无法验证它是否会产生有效版本。相比之下，您可以使用 !(bind.FileVersion.FileId)因为蜡烛在编译时满足它将在链接时解析为有效版本(FileId 是对产品中文件的直接引用，因此蜡烛相信它将存在以在链接上产生版本号)。

所以你可以使用!(wix.BuildVersion) *.wxs 中的任何其他位置，但不能将其用作 Product/@Version 的值。据我所知，您可以在这里使用的唯一绑定(bind)变量是 !(bind.FileVersion.FileId)但显然，如果您想从引用的库中获取值，这并不好。否则，您只需从其他地方获取版本信息并将其传递给 WiX，以便在编译时可用。如果您使用的是 MSBuild，它可以使用 GetAssemblyIdentity 查询版本信息。任务，并可以通过 DefineConstants 属性将此传递给 WiX。 *.wi​​xproj 文件中的以下目标应该执行此操作:

<Target Name="BeforeBuild">
  <GetAssemblyIdentity AssemblyFiles="[Path.To.Target.File]">
    <Output TaskParameter="Assemblies" ItemName="AsmInfo" />
  </GetAssemblyIdentity>
  <CreateProperty Value="%(AsmInfo.Version)">
    <Output TaskParameter="Value" PropertyName="BuildVersion" />
  </CreateProperty>
  <CreateProperty Value="$(DefineConstants)">
    <Output TaskParameter="Value" PropertyName="DefineConstantsOriginal" />
  </CreateProperty>
  <CreateProperty Value="$(DefineConstants);BuildVersion=$(BuildVersion)">
    <Output TaskParameter="Value" PropertyName="DefineConstants" />
  </CreateProperty>
</Target>
<Target Name="AfterBuild">
  <CreateProperty Value="$(DefineConstantsOriginal)">
    <Output TaskParameter="Value" PropertyName="DefineConstants" />
  </CreateProperty>
</Target>

BuildVersion 属性将被传递给candle.exe，因此您可以使用预处理器变量$(var.BuildVersion) 来引用它。这当然不如将其全部保存在 *.wxs 文件中那么干净，但这是将版本信息获取到蜡烛中的一种方式，因此它可以用作 Product/@Version 中的变量。我当然想听听任何更好的方法。