Qt扫盲-Qt资源系统概述

一、概述

Qt资源系统是一种独立于平台的机制，用于在应用程序的可执行文件中存储二进制文件。如果您的应用程序总是需要一组特定的文件(图标、翻译文件等)，我们就可以用这个资源系统来把这些要用的资源给组织起来，然后再我们的应用程序调用，这个资源可以一起打包到应用程序内部，或者编译成一个二进制文件，动态的加载到应用程序里面，在换皮肤等方面用的比较多。

资源系统与 qmake、rcc (Qt的资源编译器) 和 QFile 都关系密切。

这种资源系统一般就是在 Qt Creator 里面以 .qrc 文件，当然这个文件也是文本的。

二、资源文件(.qrc)

与应用程序关联的资源在.qrc文件中指定，该文件是一种基于xml的文件格式，列出磁盘上的文件，并可选地为它们分配应用程序访问资源时必须使用的资源名称。这个还可以给每个资源去别名之类的。

下面是一个例子。qrc文件:

DOCTYPE RCC><RCC version="1.0">
  <qresource>
      <file>images/copy.pngfile>
      <file>images/cut.pngfile>
      <file>images/new.pngfile>
      <file>images/open.pngfile>
      <file>images/paste.pngfile>
      <file>images/save.pngfile>
  qresource>
RCC>

.qrc文件中列出的资源文件是应用程序源码的一部分。指定的路径是相对于包含.qrc文件的目录。注意，列出的资源文件必须位于与.qrc文件相同的目录中，或者它的子目录之一。

资源数据可以被编译成二进制，从而立即在应用程序代码中访问，也可以创建二进制资源，然后在稍后的应用程序代码中注册到资源系统。

默认情况下，应用程序中的资源可以在与源码相同的文件名下访问，使用 :/前缀 或使用 qrc方案的URL。

例如，文件路径 :/images/cut.png 或 URL qrc:///images/cut.png 将提供对cut.png文件的访问，该文件在应用程序的源码中的位置是 images/cut.png。这也可以使用文件标记的别名来更改，:

也可以理解 images/cut.png 是文件相对于 qrc 资源文件在操作系统里的路径的位置，cut-img.png就是别名

 <file alias="cut-img.png">images/cut.pngfile>

然后可以从应用程序中用 :/cut-img.png 别名的形式访问该文件。也可以使用qresource标签的prefix属性为.qrc文件中的所有文件指定路径前缀，在本例中，该文件可以通过 :/myresources/cut-img.png 访问。

  <qresource prefix="/myresources">
      <file alias="cut-img.png">images/cut.pngfile>
  qresource>

有些资源需要根据用户的语言环境进行更改，例如翻译文件或图标。这是通过向qresource标记添加lang属性，指定合适的语言环境字符串来实现的。例如:

<qresource>
      <file>cut.jpgfile>
  qresource>
  <qresource lang="fr">
      <file alias="cut.jpg">cut_fr.jpgfile>
qresource>

如果用户的语言环境是法语(即 QLocale::system().name() 返回“fr_FR”)，:/cut.jpg 将成为对 cut_fr.jpg 图像的引用。对于其他地区，使用 cut.jpg。

有关用于区域设置字符串的格式的描述，请参阅QLocale文档。

三、外部二进制资源

对于要创建的外部二进制资源，必须通过将-binary开关传递给rcc来创建资源数据(通常给出.rcc扩展名)。一旦创建了二进制资源，就可以用QResource API注册该资源。
例如，在.qrc文件中指定的一组资源数据可以通过以下方式编译:

rcc -binary myresource.qrc -o myresource.rcc

在应用程序中，这个资源将像这样用代码注册:

QResource::registerResource("/path/to/myresource.rcc");

注册之后我们就可以一样的在程序里正常的引用这个 资源文件里的内容, 就像下面这种

QAction *cutAct = new QAction(QIcon(":/images/cut.png"), tr("Cu&t"), this);

四、内嵌资源

要将资源编译成二进制文件，必须在应用程序的.pro文件中提到.qrc文件，以便qmake知道它。例如:

RESOURCES     = application.qrc

Qmake 将生成 make 规则来生成一个名为 qrc_application.cpp 的文件，该文件被链接到应用程序中。该文件包含图像和其他资源的所有数据，作为压缩二进制数据的静态 c++ 数组。当 .qrc 文件更改或它引用的某个文件更改时， qrc_application.cpp 文件将自动重新生成。如果您不使用.pro文件，您可以手动调用rcc或向构建系统添加构建规则。

目前，Qt总是将数据直接存储在可执行文件中，即使在Windows、macOS和iOS上，操作系统也为资源提供了本地支持。这可能会在未来的Qt发行版中改变。

五、压缩资源文件

RCC尝试压缩内容以优化最终二进制文件中的磁盘空间使用。默认情况下，它将执行启发式检查，以确定压缩是否值得，如果压缩不够，则存储未压缩的内容。要控制阈值，可以使用-threshold选项，该选项告诉rcc必须获得原始文件大小的百分比，以便以压缩形式存储文件。

rcc -threshold 25 myresources.qrc

默认值为70，即压缩后的文件大小必须小于原始文件大小的70%(不超过原始文件大小的30%)。

如果需要，可以关闭压缩。如果您的资源已经包含压缩格式，例如.png文件，并且您不想在构建时因确认它不能压缩而招致CPU成本，那么这可能很有用。另一个原因是，如果磁盘使用不是问题，应用程序希望在运行时将内容保持为干净的内存页。可以通过命令行参数-no-compress来实现。

rcc -no-compress myresources.qrc

RCC还允许用户对压缩级别和压缩算法进行一些控制，例如:

rcc -compress 2 -compress-algo zlib myresources.qrc

RCC支持以下压缩算法和压缩级别:

• best：使用以下算法中最好的算法，以最高的压缩级别实现最高的压缩效果，但代价是在编译期间使用大量CPU时间。这个值在XML文件中很有用，它表明一个文件应该被压缩得最多，而不管rcc支持哪种算法。
• zstd：使用Zstandard库压缩内容。有效的压缩级别从1到19,1是最少压缩(最少CPU时间)，19是最多压缩(最多CPU时间)。默认级别为14。一个特殊的值0告诉zstd库选择一个实现定义的默认值。
• zlib：使用Zlib库压缩内容。有效的压缩级别从1到9,1是最少压缩(最少CPU时间)，9是最多压缩(最多CPU时间)。特殊值0表示“不压缩”，不应该使用。默认是实现定义的级别，但通常是6级。
• none：不压缩。这与 -no-compress 选项的作用相同。

Zstandard 和 zlib 的支持是可选的。如果在编译时没有检测到给定的库，尝试为该库传递 -compress- algorithm 将导致错误。如果启用，默认压缩算法为zstd，否则为zlib。

六、在应用中使用资源

在应用程序中，大多数地方都可以使用资源路径而不是普通的文件系统路径。特别地，您可以将资源路径而不是文件名传递给QIcon、QImage或QPixmap构造函数:

cutAct = new QAction(QIcon(":/images/cut.png"), tr("Cu&t"), this);

请参阅应用程序示例，了解使用Qt资源系统存储图标的实际应用程序。
在内存中，资源由资源对象组成的树表示。该树在启动时自动构建，QFile使用它来解析资源的路径。你可以使用一个用“: /” 初始化的QDir来从根目录导航到资源码。

Qt的资源支持搜索路径列表的概念。如果你使用 : 而不是 作为前缀来引用资源，则会使用搜索路径列表来查找资源。搜索路径列表在启动时是空的；调用QDir::addSearchPath()来添加路径。

七、使用Library 库中的资源

如果库中有资源，则需要使用 .qrc 文件的 文件名 调用 Q_INIT_RESOURCE() 来强制初始化资源。例如:
// resources.qrc

MyClass::MyClass() : BaseClass()
{
      Q_INIT_RESOURCE(resources);

      QFile file(":/myfile.dat");
      ...
}

在静态链接的情况下，这可以确保将资源链接到最终的应用程序二进制文件中。你应该把初始化代码放在库中使用资源的地方，这样库的客户端只有在使用依赖这些资源的库的特性时才会链接这些资源。

注意：由于rcc生成的资源初始化程序是在全局命名空间中声明的，因此对 Q_INIT_RESOURCE() 的调用也需要在任何命名空间之外进行。

如果库包含内部不使用的资源，而是暴露给库的客户端，则需要在应用程序代码中进行初始化。例如:

int main(int argc, char *argv[])
{
      QApplication app(argc, argv);
      Q_INIT_RESOURCE(graphlib);

      QFile file(":/graph.png");
      ...
      return app.exec();
}

和之前一样，在静态链接的情况下，这确保了资源被链接到最终的应用程序二进制文件中，但在动态链接的情况下，也会触发库的加载。

类似地，如果必须显式卸载一组资源(因为正在卸载插件或资源不再有效)，可以调用与上面相同的基本名称Q_CLEANUP_RESOURCE() 强制删除资源。

注意：当资源作为应用程序的一部分构建时，不需要使用Q_INIT_RESOURCE() 和 Q_CLEANUP_RESOURCE()。