原文:Wix学习整理(4)——关于WiX文件格式和案例HelloWorld的分析
关于WiX文件格式
.wxs是WiX的源文件扩展名。.wxs文件以类XML文件的格式来指定了要构造Windows Installer安装数据包.msi文件所需的信息。
.wxs的文件格式为:
<?xml version="1.0"?> <Wix xmlns="http://schemas.microsoft.com/wix/2006/wi"> … </Wix>
.wxs必须只有一个根元素,即<Wix>。在<Wix>下至多有一个下列的直接子元素:<Product>、<Module>或<Patch>;但是可以拥有不限个数的<Fragment>子元素。通过<Product>元素或<Fragment>元素的子元素即可指定Windows Installer安装包MSI文件的内容。
Wix是一个功能性的描述语言而非命令式规定性语言。各种元素可在不同地方进行描述,并且仅当它们之间存在依赖关系时,其中一个元素可以通过必须提供的唯一标识符来引用另一个元素。
HelloWorld的分析
下面我们对前面的案例HelloWorld的.wxs文件进行简单分析,这样就可以对.wxs有个基本的认识。为了方便,我们将该.wxs文件复制在下面。
Product.wxs
<?xml version="1.0" encoding="UTF-8"?> <Wix xmlns="http://schemas.microsoft.com/wix/2006/wi"> <Product Id="*" Name="HelloWorld" Language="1033" Version="1.0.0.0" Manufacturer="LEH" UpgradeCode="1de12ee7-2e94-42ac-979f-06245a0ade30"> <Package InstallerVersion="200" Compressed="yes" InstallScope="perMachine" /> <Media Id="1" Cabinet="media1.cab" EmbedCab="yes" /> <Directory Id="TARGETDIR" Name="SourceDir"> <Directory Id="ProgramFilesFolder"> <Directory Id="INSTALLFOLDER" Name="HelloWorld"> <Component Id="ProductComponent" Guid="B5F0C012-49D6-4C63-AFCA-0CE6C24C6D7D"> <File Id="HelloWorld" Source="HelloWorld.exe" /> </Component> </Directory> </Directory> </Directory> <Feature Id="ProductFeature" Title="HelloWorld" Level="1"> <ComponentRef Id="ProductComponent" /> </Feature> </Product> </Wix>
在<Product>属性中,指定了安装包的五个必需属性ProductCode、ProductName、Manufacturer、ProductLanguage和ProductVersion,其分别对应了<Product>元素的五个属性upgradeCode、Name、Manufacturer、Language和version。
定义目录结构
目录通过<Directory>元素来定义,其描述了我们要安装在目标计算机上的文件夹结构。案例HelloWorld中定义目录结构的语句如下:
<Directory Id="TARGETDIR" Name="SourceDir"> <Directory Id="ProgramFilesFolder"> <Directory Id="INSTALLFOLDER" Name="HelloWorld"> … </Directory> </Directory> </Directory>
Id为TARGETDIR的<Directory>元素是Windows Installer要求必须有的,并且其是我们安装目录结构的根目录。而Id为ProgramFilesFolder的<Directory>元素指定了目标计算机上的Program Files文件夹,ProgramFilesFolder是Windows Installer预定义的一个属性,通常其属性值为C:\Program Files\。第三个<Directory>元素则指定了我们安装的软件在Program Files文件夹下的子文件夹,这里该子文件夹命名为HelloWorld,而Id指定为INSTALLFOLDER,该标识符Id可以在.wxs文件中任意地方进行引用,另外该Id采用全大写字母,是为了能够在安装的命令行或者用户界面中对该值进行定义,这样也可以改变我们安装的产品在目标计算机上的路径(WiX中Id为全大写形式的属性值可称为全局属性,其值可以在命令行或者用户界面上进行改变)。
于是,我们的HelloWorld将被安装在路径C:\Program Files\HelloWorld\下。
添加文件HelloWorld.exe至安装包
上一篇随笔说过,Component是安装的基本单元,而Component则是由文件,或快捷方式,或注册表键值,或它们的组合来组成的。于是,要将一个文件添加到安装包中,则需要两个元素<Component>和<File>。下面是案例HelloWorld中将文件HelloWorld.exe文件添加到安装包中的语句。
<Component Id="ProductComponent" Guid="B5F0C012-49D6-4C63-AFCA-0CE6C24C6D7D"> <File Id="HelloWorld" Source="HelloWorld.exe" /> </Component>
<Component>元素在定义在Id为INSTALLFOLDER的<Directory>元素下的,这样我们的HelloWorld.exe文件将被安装在路径C:\Program Files\HelloWorld\下。每一个Component必须有且只有一个关联目录。<Component>元素的Id用于在.wxs文件的任意地方引用该<Component>元素,而Guid元素指定的GUID值则是用于Windows Installer对该Component进行跟踪的,<Component>元素的GUID值必须的全大写,并且是唯一的。
在<Component>元素下,<File>元素将指定我们要安装的HelloWorld.exe文件。属性Id的值HelloWorld用于标识该<File>元素,可在.wxs文件任意地方通过其来引用该<File>文件。而属性Source指定了文件HelloWorld.exe在我们机器上的路径,这样WiX就可以找到它并把它添加的安装包MSI文件中。
另外,<File>元素还有一个KeyPath属性和CheckSum属性。若我们将KeyPath属性设置为Yes,则Windows Installer将会根据这个<File>元素指定的文件来判断该Component是否已被安装。若我们没有设置KeyPath属性,则Windows Installer将会顺序地扫描该<Component>下的子元素,然后自动选择一个子元素作为该Component已被安装的判据。可执行文件头部通常有一个校验和,于是对可执行文件,我们通常将CheckSum属性设置为Yes,这样在我们进行安装修复时,就可以通过该校验和来判断该文件的有效性。
告诉Windows Installer安装文件HelloWorld.exe
要想安装HelloWorld.exe文件,需要将包含该文件的<Component>元素包含进一个<Feature>中。<Feature>将我们的产品划分为一些逻辑上的部件,这样用户可以独立地对它们分别进行安装。下面就是我们的HelloWorld案例中定义的<Feature>元素。
<Feature Id="ProductFeature" Title="HelloWorld" Level="1"> <ComponentRef Id="ProductComponent" /> </Feature>
在<Feature>元素的子元素中,通过一个<ComponentRef>元素来引用Id为ProductComponent的<Component>元素,也就是说该Feature是由Id为ProductComponent的Component组成的,该Component中包含我们的HelloWorld.exe文件,于是当我们选择安装该Feature时,即安装了我们的HelloWorld.exe文件。<Feature>元素的Title属性设置为HelloWorld,如果我们的安装过程有UI界面并且有Feature选择界面,则在Feature选择界面中将显示该Feature的标题HelloWorld。而<Feature>元素的Level属性设置为1,表明该Feature在默认情况下是有效的、可安装的。