Qt Installer Framework 打包带简单安装脚本演示

Qt Installer Framework国内镜像站 

获取后找个版本部署

dll补全

编译好的动态链接程序移动到任意一个非中文路径下

使用windeployqt补全要用到的dll

windeployqt去到编译所使用的qt路径下面找 例如C:\Qt\Qt5.14.2\5.14.2\msvc2017_64\bin

如果有其它的环境干扰可以进入

例如C:\Windows\System32\cmd.exe /A /Q /K C:\Qt\Qt5.14.2\5.14.2\msvc2017_64\bin\qtenv2.bat

这样确保没有conda之类的里面有干扰

cd过去后使用windeployqt .\你编译的程序.exe

然后我们稍微瘦身（

把程序执行起来后删除一遍，把没用到的dll删除

目录构建

然后到Qt Installer Framework部署目录下

C:\Qt\Qt Installer Framework-4.8.1\examples

有示例，以里面的startmenu为模板，也找个非中文路径移出来

把前面补全的全部文件 对应的目录全部转移到

packages\org.qtproject.ifw.xxx\data下面

这里xxx自己命名

config.xml配置

详细的跳转到文后看官方文档对照

先看到config\config.xml的配置

我这里要注意的就

InstallerApplicationIcon使用的ico要为多尺寸windows ico

以及管理工具MaintenanceToolName的命名我改为了Uninstall

这是我的配置

config\config.xml

<?xml version="1.0" encoding="UTF-8"?>
<Installer>
    <Name>Audio Control</Name>
    <Version>1.0.0</Version>
    <Title>Audio Control安装向导</Title>
    <Publisher>Ranfey</Publisher>
    <!-- Directory name is used in component.xml -->
    <StartMenuDir>Audio Control</StartMenuDir>
    <TargetDir>@ApplicationsDir@/Audio Control</TargetDir>
    <InstallerApplicationIcon>favicon</InstallerApplicationIcon>
    <MaintenanceToolName>Uninstall</MaintenanceToolName>
</Installer>

组件package.xml

然后是package.xml的配置

在结构packages\org.qtproject.ifw.xxxx\meta\package.xml

简单修改了以下

主要就是指定了Script

packages\org.qtproject.ifw.xxxx\meta\package.xml

<?xml version="1.0" encoding="UTF-8"?>
<Package>
    <DisplayName>Audio Control</DisplayName>
    <Description>Audio Control</Description>
    <Version>1.0.0-1</Version>
    <ReleaseDate>2026-02-03</ReleaseDate>
    <Default>true</Default>
    <Script>installscript.qs</Script>
</Package>

其中Script也是meta\里面

下面是我使用的脚本

packages\org.qtproject.ifw.xxxx\meta\installscript.qs

function Component()
{
    // 默认构造函数：
}
 
Component.prototype.createOperations = function()
{
    /*
     *  调用默认实现（非常重要）
     */
    component.createOperations();
 
    /*
     *  判断操作系统
     */
    if (systemInfo.productType === "windows") {
 
        /*
         *  创建开始菜单快捷方式：主程序 Audio_control.exe
         *
         * component.addOperation(opName, arg1, arg2, ...)
         * 用于向操作队列追加一条操作。
         * 
         * 这里使用了预定义变量（@...@），会在运行时展开为实际路径：
         *   - @TargetDir@   : 用户选择的安装目标目录（最终安装位置）
         *   - @StartMenuDir@: 开始菜单目录（由 config.xml 的 StartMenuDir 等决定）
         *
         */
        component.addOperation(
            "CreateShortcut",
            "@TargetDir@/Audio_control.exe",              // 快捷方式指向的可执行文件
            "@StartMenuDir@/Audio Control.lnk",           // 生成的 .lnk 快捷方式位置
            "workingDirectory=@TargetDir@",               // 快捷方式“起始位置/工作目录”
            "iconPath=@TargetDir@/Audio_control.exe",     // 图标来源文件（这里直接取 exe 内嵌图标）
            "iconId=0",                                   // exe 内图标索引（通常 0 是主图标）
            "description=Start Audio Control"             // 快捷方式描述
        );
 
        /*
         *  创建开始菜单快捷方式：卸载入口 Uninstall.exe
         *
         *  把卸载器也放进开始菜单，方便用户从开始菜单卸载。
         *
         * 注意：iconPath 仍然使用 Audio_control.exe 的图标，
         * 这样 Uninstall.lnk 的图标更美观/统一；否则卸载器可能是默认图标。
         */
        component.addOperation(
            "CreateShortcut",
            "@TargetDir@/Uninstall.exe",                  // 卸载程序注意是在前面的MaintenanceToolName
            "@StartMenuDir@/Uninstall.lnk",               // 卸载快捷方式
            "workingDirectory=@TargetDir@",               // 工作目录同安装目录
            "iconPath=@TargetDir@/Audio_control.exe",     // 我使用主程序的图标作为卸载快捷方式图标
            "iconId=0",
            "description=Uninstall"
        );
 
        /*
         *  弹窗询问：是否创建桌面快捷方式
         *
         * QMessageBox.question(...) 会弹出一个“是/否”对话框。
         *
         * 参数含义：
         *   - "AskDesktop"                     : 对话框内部标识（可用于一些自动化/翻译系统）
         *   - "桌面快捷方式"                   : 标题
         *   - "是否在桌面创建快捷方式？"       : 文本
         *   - QMessageBox.Yes | QMessageBox.No : 按钮组合
         *   - QMessageBox.Yes                  : 默认选中的按钮
         *
         * 返回值：用户点了哪个按钮（Yes/No）。
         */
        if (QMessageBox.question(
                "AskDesktop",
                "桌面快捷方式",
                "是否在桌面创建快捷方式？",
                QMessageBox.Yes | QMessageBox.No,
                QMessageBox.Yes
            ) == QMessageBox.Yes)
        {
            /*
             * 6) 如果用户选择“是”：创建桌面快捷方式
             *
             * @DesktopDir@ 是预定义变量，代表当前用户的桌面目录。
             *
             * 说明：
             * - 你创建的是 “Audio Control.lnk” 在桌面上。
             * - 参数与开始菜单那个一致（工作目录/图标/描述）。
             */
            component.addOperation(
                "CreateShortcut",
                "@TargetDir@/Audio_control.exe",
                "@DesktopDir@/Audio Control.lnk",
                "workingDirectory=@TargetDir@",
                "iconPath=@TargetDir@/Audio_control.exe",
                "iconId=0",
                "description=Start Audio Control"
            );
        }
    }
};

到这里配置完成

生成

使用C:\Qt\Qt Installer Framework-4.8.1\bin下的binarycreator打包

binarycreator -c config\config.xml -p packages Installer -v

懒得添加C:\Qt\Qt Installer Framework-4.8.1\bin到环境就直接用

& "C:\Qt\QtIFW-4.8.1\bin\binarycreator.exe"  -c config\config.xml -p packages Installer -v

打包完成

效果展示

官方文档对照

config.xml语法示例

https://doc.qt.io/qtinstallerframework/ifw-globalconfig.html

<?xml version="1.0"?>
<Installer>
    <Name>Some Application</Name>
    <Version>1.0.0</Version>
    <Title>Some Application Setup</Title>
    <Publisher>Your Company</Publisher>
    <ProductUrl>http://www.your-fantastic-company.com</ProductUrl>
    <InstallerWindowIcon>installericon</InstallerWindowIcon>
    <InstallerApplicationIcon>installericon</InstallerApplicationIcon>
    <Logo>logo.png</Logo>
    <Watermark>watermark.png</Watermark>
    <RunProgram>@TargetDir@/YourAppToRun</RunProgram>
    <RunProgramArguments>
        <Argument>Argument 1</Argument>
        <Argument>Argument 2</Argument>
    </RunProgramArguments>
    <RunProgramDescription>My nice application</RunProgramDescription>
    <StartMenuDir>Some Application Entry Dir</StartMenuDir>
    <MaintenanceToolName>SDKMaintenanceTool</MaintenanceToolName>
    <AllowNonAsciiCharacters>true</AllowNonAsciiCharacters>
    <Background>background.png</Background>
 
    <TargetDir>@HomeDir@/testinstall</TargetDir>
    <AdminTargetDir>@RootDir@/testinstall</AdminTargetDir>
    <RemoteRepositories>
        <Repository>
            <Url>http://www.your-repo-location/packages/</Url>
        </Repository>
    </RemoteRepositories>
    <AliasDefinitionsFile>aliases.xml</AliasDefinitionsFile>
</Installer>

• 建议：将所有在配置文件中引用到的文件（图片、样式表、脚本等）放在同一个目录下。也可以使用相对路径；工具会以 config.xml 所在位置为基准解析相对路径。
• 文件名必须唯一：被引用的文件名不能重名。比如你想让 <Logo> 和 <Watermark> 用同一张图片，也需要准备两份文件，但文件名必须不同（例如 logo.png 与 watermark.png）。

配置项的值中可以使用用 @...@ 包裹的预定义变量（例如 @TargetDir@、@HomeDir@）。

Package Directory（包目录）

https://doc.qt.io/qtinstallerframework/ifw-component-description.html

部署器由多个 Component（组件）组成。组件可以：

• 嵌入（embedded）在部署器里；或
• 从 远程仓库（remote repository）按需获取。

无论哪种方式，你都需要把组件组织为部署器能识别的固定目录结构与元数据格式。

包目录结构（Package Directory Structure）

把所有组件放在同一个根目录下，这个根目录称为 package directory（包目录）。

• 包目录下的第一层子目录名充当一种“域名式标识符（domain-like identifier）”，用于识别组件，例如：com.vendor.root
• 该目录名不能包含 : 或 -
  因为这些字符被保留用于把“版本号”和“标识符”分隔开（即标识符与版本的解析会冲突）。

在每个组件目录内，必须包含两个子目录：

• data/：部署时会被解包/释放的内容
• meta/：组件元信息（不会被解包）

-packages
    - com.vendor.root
        - data
        - meta
    - com.vendor.root.component1
        - data
        - meta
    - com.vendor.root.component1.subcomponent1
        - data
        - meta
    - com.vendor.root.component2
        - data
        - meta

Meta Directory（meta 目录）

meta/ 目录包含“部署与部署流程配置”相关文件：

• 这些文件 不会被部署器解压到目标目录；
• meta/ 至少必须包含：
  1. package 信息文件（通常是 package.xml）
  2. package.xml 引用到的所有文件（例如脚本、UI 文件、翻译文件等）

package.xml语法示例

https://doc.qt.io/qtinstallerframework/ifw-component-description.html

<?xml version="1.0"?>
<Package>
    <DisplayName>QtGui</DisplayName>
    <Description>Qt gui libraries</Description>
    <Description xml:lang="de_de">Qt GUI Bibliotheken</Description>
    <Version>1.2.3</Version>
    <ReleaseDate>2009-04-23</ReleaseDate>
    <Name>com.vendor.root.component2</Name>
    <Dependencies>com.vendor.root.component1</Dependencies>
    <Virtual>false</Virtual>
    <Licenses>
        <License name="License Agreement" file="license.txt" />
    </Licenses>
    <Script>installscript.qs</Script>
    <UserInterfaces>
        <UserInterface>specialpage.ui</UserInterface>
        <UserInterface>errorpage.ui</UserInterface>
    </UserInterfaces>
    <Translations>
        <Translation>sv_se.qm</Translation>
        <Translation>de_de.qm</Translation>
    </Translations>
    <DownloadableArchives>component2.7z, component2a.7z</DownloadableArchives>
    <AutoDependOn>com.vendor.root.component3</AutoDependOn>
    <SortingPriority>123</SortingPriority>
    <UpdateText>This changed compared to the last release</UpdateText>
    <Default>false</Default>
    <ForcedInstallation>false</ForcedInstallation>
    <ForcedUpdate>false</ForcedUpdate>
    <Essential>false</Essential>
    <Replaces>com.vendor.root.component2old</Replaces>
 
    <Operations>
        <Operation name="AppendFile">
            <Argument>@TargetDir@/A.txt</Argument>
            <Argument>lorem ipsum</Argument>
        </Operation>
        <Operation name="Extract">
            <Argument>@TargetDir@/Folder1</Argument>
            <Argument>content.7z</Argument>
        </Operation>
        <Operation name="Extract">
            <Argument>@TargetDir@/Folder2</Argument>
        </Operation>
    </Operations>
 
    <TreeName moveChildren="true">com.vendor.subcomponent</TreeName>
</Package>

Component Dependencies（组件依赖）

组件可以依赖一个或多个真实组件或虚拟组件。依赖通过：

• 组件标识符（如 com.vendor.root.component1）
• 可选 组件版本号约束

来定义。

写法规则

• 用连字符 - 将版本号与标识符分隔：identifier-version
• 版本号前可以带比较运算符：=, >, <, >=, <=
• 若不写运算符，默认是 =（等于）

XML 转义注意

因为 < 是 XML 特殊字符，必须写成实体引用：

• < 用 <
• <= 用 <=

Data Directory（data 目录）

data/ 目录包含部署时会被解压到目标机器的内容。

关键点：

• data 必须被打包为 归档文件（archives）
• 归档创建方式：
  1. 使用 binarycreator（创建部署器）和 repogen（创建仓库）时自动打包；或
  2. 你也可以手动预先打包，以获得更强的控制

可用归档工具与格式

手动打包时可使用：

• Qt Installer Framework 自带的 archivegen
• 或任何能生成以下格式的工具：

支持格式：

• 7z
• zip
• tar.gz
• tar.bz2
• tar.xz