Qt 设置软件的版本信息:QMake、CMake工程

 

本文借鉴了Qt 设置软件的版本信息 - 疯狂delphi - 博客园 (cnblogs.com)

 在原文基础增加了CMake工程实现的方法。

Qt设置软件的版本等信息
对于Qt开发的软件，我们如何去方便的查看其软件的版本信息。这里提供了几种方式。

在运行程序期间设置版本信息
大部分的程序在运行之后都会提供一个关于的按钮，通过点击该按钮并弹出一个关于界面，则可以查看相关的程序信息。此关于界面为用户自定义的一个界面。或者可以在主界面的右下角显示出当前软件的版本信息。两种方式之间并不冲突。

Qt的QCoreApplication类提供一些软件版本信息的静态公共接口，如下所示。

//设置相关信息
QCoreApplication::setApplicationName("APPNAME");
QCoreApplication::setApplicationVersion("1.0.0.0");
QCoreApplication::setOrganizationName("Qt");
QCoreApplication::setOrganizationDomain("www.qt.com");

//取出相关信息
QString appName = QCoreApplication::applicationName();
QString appVersion = QCoreApplication::applicationVersion();
QString orgDomain = QCoreApplication::organizationDomain();
QString orgName = QCoreApplication::organizationName();
如果用户需要设置更多的信息，则需要自己去实现，可以将所有的版本信息放置于一个version.h的头文件中。如下所示。

#ifndef VERSION_H
#define VERSION_H

#define PRODUCT_ICON "myapp.ico" // 图标

#define FILE_VERSION 4,0,2,666 // 文件版本
#define FILE_VERSION_STR "4.0.2.666"
#define PRODUCT_VERSION 4,0,2,666 // 产品版本
#define PRODUCT_VERSION_STR "4.0.2.666"
#define COMPANY_NAME "Digia"
#define INTERNAL_NAME "MyApp.exe"
#define FILE_DESCRIPTION "Qt Creator based on Qt 5.7.0 (MSVC 2013, 32 bit)" // 文件说明
#define LEGAL_COPYRIGHT "Copyright 2008-2016 The Qt Company Ltd. All rights reserved." // 版权
#define ORIGINAL_FILE_NAME "MyApp.exe" // 原始文件名
#define PRODUCT_NAME "Qt Creator" // 产品名称
#define ORGANIZATION_DOMAIN "https://www.qt.io/" // 域名

#endif // VERSION_H

在不运行程序期间设置版本信息，有的时候我们不想运行软件或者当前环境不支持软件正常运行，那么此时该如何设置软件版本信息。

对于Qt使用QMake来管理工程来说，可以直接在.pro文件中设置相关的软件信息。代码示例如下。

#app.pro

#程序版本
VERSION = 1.0.0.0
#程序图标
RC_ICONS = app.ico
#公司名称
QMAKE_TARGET_COMPANY ="company"
#程序说明
QMAKE_TARGET_DESCRIPTION = "test app"
#版权信息
QMAKE_TARGET_COPYRIGHT = "Copyright(C) 2017"
#程序名称
QMAKE_TARGET_PRODUCT = "app"
#程序语言
#0x0800代表和系统当前语言一致
RC_LANG = 0x0800

则对于生成程序我们可以右键属性面板的详细信息中查看到设置的软件信息。

当然Qt工程其实使用的windows平台下面的RC文件，那么我们也可以直接建立一个rc文件，在该文件中设置相关的软件信息。QMake和CMake实现的思路一样，都是调用rc文件。这里需要注意的一点是VC编译器使用的GBK编码，我们如果把rc文件编码改成非GBK编码，将会出现乱码的情况。

我们创建的rc文件：

#include "winres.h"
#include "version.h"

// 图标
IDI_ICON1 ICON PRODUCT_ICON

// 版本信息
VS_VERSION_INFO VERSIONINFO
FILEVERSION FILE_VERSION
PRODUCTVERSION PRODUCT_VERSION
FILEFLAGSMASK 0x3fL
#ifdef _DEBUG
FILEFLAGS 0x1L
#else
FILEFLAGS 0x0L
#endif
FILEOS 0x40004L
FILETYPE 0x1L
FILESUBTYPE 0x0L
BEGIN
BLOCK "StringFileInfo"
BEGIN
BLOCK "080404b0"
BEGIN
VALUE "CompanyName", COMPANY_NAME
VALUE "FileDescription", FILE_DESCRIPTION
VALUE "FileVersion", FILE_VERSION_STR
VALUE "InternalName", INTERNAL_NAME
VALUE "LegalCopyright", LEGAL_COPYRIGHT
VALUE "OriginalFilename", ORIGINAL_FILE_NAME
VALUE "ProductName", PRODUCT_NAME
VALUE "ProductVersion", PRODUCT_VERSION_STR
END
END
BLOCK "VarFileInfo"
BEGIN
VALUE "Translation", 0x804, 1200
END
END

QMake调用rc文件的方法，在pro文件添加如下语句：

# 设置输出APP文件名，这条语句和本文没啥关系。只是简单记录一下。
# SecurityHelperSOAP只是输出可执行程序的文件名，可随意改动。不推荐使用中文。会出现乱码。
TARGET = SecurityHelperSOAP

# qmake的rc文件调用
# APP信息、版本信息
RC_FILE += SecurityHelperSOAP.rc

CMake调用rc文件的方法，在CMakeLists.txt项目文件中添加如下代码：

#我们需要修改的地方：${CMAKE_CURRENT_SOURCE_DIR}/app.rc这是rc文件的路径

set(app_icon_resource_windows "${CMAKE_CURRENT_SOURCE_DIR}/app.rc")
if(${QT_VERSION_MAJOR} GREATER_EQUAL 6)
    qt_add_executable(KR-MACScanner
        MANUAL_FINALIZATION
        ${PROJECT_SOURCES}
        ${app_icon_resource_windows}
    )

linux 平台下设置软件信息
由于linux平台下面并没有RC文件，所以需要使用命令行来显示版本信息，即通过命令行执行 myApp -v 来显示版本信息。
相关相关代码如下：

int main(int argc, char *argv[])
{
QApplication a(argc, argv);

//显示版本信息
if (a.arguments().size() == 1 && a.arguments().at(0) == "-v")
{
QString appInfo = "appInfo";
std::cout << appInfo.toStdString();
return a.exec();
}
}
配置文件记录软件信息
对于大型的集成系统来说，可以通过一个统一的配置文件来读取软件的配置信息，该配置文件必须由集成系统提供，各个子模块软件提供信息。