The Qt Resource System Qt资源体系(qrc rcc)

The Qt Resource System

Qt资源体系采用平台独立机制来存储应用程序执行时的二进制文件。这种机制在应用程序需要一些确定的文件(图标、翻译文件等等)而且又不想冒丢失文件的风险时是有用的。

资源体系依赖于 qmake, rcc (Qt's resource compiler), 和 QFile 的紧密协作。Qt 3 的 qembed 工具和 image collection 机制被废除。

 

Resource Collection Files (.qrc)

与应用程序关联的应用程序由 .qrc 文件来指定，它用XML记录硬盘上的文件和对应的随意指定的资源名称，应用程序通过资源名称来访问资源。

一个.qrc 文件的例子：

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

 .qrc 文件中列出的资源文件是程序的源码树的一部分。指定的路径是 .qrc 文件所在目录的相对路径。注意，列出的资源文件必须位于 .qrc 文件所在目录或者其子目录下。

资源数据也能被编译进二进制文件中，因此应用程序代码可以立即访问；也可以创建一个二进制资源，稍后在程序中登记了资源体系的代码中指定。

缺省时，程序可以用资源在源码树中的名称加一个 :/ 前缀来访问它。例如，在程序的源码树中是 images/cut.png 的文件可以通过 :/images/cut.png 来访问。但也可以用 file 标签中的 alias 属性来指定：

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

这时该文件可以通过 :/cut-img.png 来访问。也可以在 .qrc 文件中用 qresource 标签的 prefix 属性：它可以为 .qrc 文件中所有文件指定一个前缀：

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

这时该文件可以用 :/myresources/cut-img.png 访问。

有些资源，像翻译文件和图标，需要随着用户的本地配置而变化。这可以在 qresource 标签的 lang 属性中指定一个合适的本地化字串来实现。例如：

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

如果用户的本地化设置是 French (也就是说，QLocale::system().name() returns "fr_FR")，:/cut.jpg 就会引用 cut_fr.jpg 图像。对于其他本地化设置，仍然用 cut.jpg 。

本地化字串的使用格式参见 QLocale 文档。

 

External Binary Resources

为创建一个外部二进制资源，需要通过向 rcc 传递 -binary 开关来生成资源数据(一般是.rcc扩展名)。然后可以用 QResource API 来注册资源。

例如，一个 .qrc 文件指定的资源数据集可以用下面方法编译：

 rcc -binary myresource.qrc -o myresource.rcc

应用程序中，用下面的代码注册资源：

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

 

Compiled-In Resources

必须在应用程序的 .pro 文件中指定.qrc 文件， qmake 才能知道并将资源编译进二进制文件。例如：

 RESOURCES     = application.qrc

qmake 将产生make规则来生成一个叫做 qrc_application.cpp 的文件并把它链接到应用程序中。该文件中，图像和其他资源的所有数据被以压缩二进制数据存进静态C++数组中。 .qrc 文件被改变或者它引用的文件中的某一个被改变时， qrc_application.cpp 自动重新生成。若你没有使用 .pro 文件，你也可以手动调用 rcc 或者在你的编译系统中添加创建规则。

通常，Qt直接将数据存储在可执行文件中，甚至在Windows和Mac OS X这些提供资源本地支持的操作系统中也是这样。这可能会在未来的Qt版本中改变。

 

Using Resources in the Application

应用程序中，绝大多数地方都可以用资源路径代替原始文件系统路径。尤其是在 QIcon, QImage, or QPixmap 构造器中可以传递资源路径来代替文件名称：

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

参见示例Application，它用Qt资源体系存储图标。

在内存中，资源被用资源对象树来描述。该树在启动时自动构建并用QFile来解析资源路径。可以用":/" 初始化的 QDir 来从资源树的根部开始浏览。

Qt资源支持搜索路径列表概念。若用 ":"代替":/"做前缀来引用一个资源，资源将被用搜索路径列表查询。启动时搜索路径列表是空的，调用 QDir::addResourceSearchPath() 可以添加路径。

If you have resources in a static library，必须用.qrc 文件的base name作参数调用 Q_INIT_RESOURCE() 来强制初始化资源。例如：

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

同样地，若你需要显式卸载一个资源集(因插件被卸载或资源失效)，需要用与前面相同的base name为参数调用Q_CLEANUP_RESOURCE() 来强制移除资源。