Wix Toolset：自定义扩展中如何像File元素一样将文件存入MSI表？

嘿，刚好有过自定义Wix扩展的实战经验，给你捋捋怎么实现类似原生File元素的简洁效果，几步就能搞定！

1. 先定义自定义元素的Schema（XSD） #

首先得让Wix识别你的自定义元素，所以要写一个XSD文件，定义好元素的结构——就像原生File那样，包含Id、Source、KeyPath这些关键属性。

示例XSD片段：

<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
           xmlns:custom="http://schemas.yourdomain.com/wix/CustomFileExtension"
           targetNamespace="http://schemas.yourdomain.com/wix/CustomFileExtension"
           elementFormDefault="qualified">
  <xs:element name="CustomFile">
    <xs:complexType>
      <xs:attribute name="Id" type="xs:string" use="required"/>
      <xs:attribute name="Source" type="xs:string" use="required"/>
      <xs:attribute name="KeyPath" type="xs:boolean" default="false"/>
    </xs:complexType>
  </xs:element>
</xs:schema>

2. 实现编译器逻辑（核心部分） #

接下来要写C#代码，继承Wix的CompilerExtension类，重写元素处理方法。核心目标就是：读取Source路径的文件，自动把它的信息写入MSI的File表，同时处理KeyPath和打包逻辑。

关键步骤拆解：

• 解析元素的属性值，把Source路径转换成绝对路径（Wix提供了现成的路径解析方法）
• 获取文件的大小、版本、哈希值这些必须存入MSI表的信息（用Wix内置的FileVer、HashUtilities工具类就行）
• 创建File表的行，填充所有必填字段
• 把文件添加到MSI的cab包中（关联到Media表）

示例代码片段：

public class CustomFileCompilerExtension : CompilerExtension
{
    public override void ProcessElement(XmlElement element, Context context)
    {
        if (element.LocalName != "CustomFile") return;

        // 读取元素属性
        var fileId = element.GetAttribute("Id");
        var sourcePath = context.ResolvePath(element.GetAttribute("Source"));
        bool isKeyPath = string.Equals(element.GetAttribute("KeyPath"), "yes", StringComparison.OrdinalIgnoreCase);

        // 获取文件核心信息
        var fileInfo = new FileInfo(sourcePath);
        var fileVersionInfo = FileVer.GetFileVersion(sourcePath);
        var fileHash = HashUtilities.ComputeFileHash(sourcePath);

        // 向File表插入数据
        var fileRow = context.TableManager.CreateRow("File", fileId);
        fileRow.SetString("File", fileId);
        fileRow.SetString("Component_", context.CurrentComponentId); // 绑定到当前Component，和原生File逻辑一致
        fileRow.SetString("FileName", fileInfo.Name);
        fileRow.SetInteger("FileSize", (int)fileInfo.Length);
        fileRow.SetString("Version", fileVersionInfo?.FileVersion);
        fileRow.SetInteger("Language", fileVersionInfo?.Language ?? 0);
        fileRow.SetBinary("Hash", fileHash);
        fileRow.SetInteger("KeyPath", isKeyPath ? 1 : 0);

        // 将文件添加到cab包（关联Media表）
        var mediaRow = context.TableManager.GetRow("Media", "1"); // 默认使用第一个Media条目
        var cabinetPath = context.GetCabinetPath(mediaRow);
        context.CabinetBuilder.AddFile(sourcePath, fileId, cabinetPath);
    }
}

3. 注册并使用扩展 #

• 在你的扩展项目中，添加程序集特性来注册扩展：

  [assembly: AssemblyDefaultWixExtension(typeof(CustomFileCompilerExtension))]
  

• 编译成DLL后，在Wix项目中引用这个DLL，然后在WXS文件中添加命名空间：

  <Wix xmlns="http://schemas.microsoft.com/wix/2006/wi"
       xmlns:custom="http://schemas.yourdomain.com/wix/CustomFileExtension">
    <!-- 像用原生File一样用自定义元素 -->
    <Component Id="MyComponent" Guid="*">
      <custom:CustomFile Id="Some.dll" Source="files\Some.dll" KeyPath="yes" />
    </Component>
  </Wix>
  

几个注意点 #

• 要确保你的扩展和Wix Toolset版本兼容，不同版本的Wix API可能有细微变化
• 路径解析时，Wix的变量（比如$(var.SourceDir)）可以用context.ResolvePath自动处理
• 编译时要保证有读取源文件、写入cab包的权限

这样实现后，你的自定义元素就能和原生File一样简洁优雅——只需要指定Source等属性，就自动完成文件存入MSI表的流程啦！

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