開(kāi)篇

在《如何導(dǎo)入QML文檔目錄》一文中，描述了如何導(dǎo)入QML目錄。對(duì)于應(yīng)用程序內(nèi)組件集來(lái)說(shuō)，在實(shí)際開(kāi)發(fā)中，導(dǎo)入本地QML目錄非常方便。但是如果模塊目錄移動(dòng)到了另一個(gè)位置，那么所有與導(dǎo)入此模塊的代碼（與導(dǎo)入相關(guān)的語(yǔ)句）都必須更新，這將是一個(gè)非常麻煩且糟糕的事情。本文將繼續(xù)該文中留下的話題：如何以模塊的方式導(dǎo)入。

使用QML模塊的優(yōu)點(diǎn)如下：

（1）在一個(gè)項(xiàng)目中可以共享公共的QML類型。

（2）可用于發(fā)布基于QML的庫(kù)。

（3）可以模塊化開(kāi)發(fā)，使應(yīng)用程序只加載各自需要的庫(kù)。

（4）可以對(duì)QML類型和資源進(jìn)行版本控制，這樣可以很容易的更新模塊。

從0到1

創(chuàng)建一個(gè)工程

首先使用QtCreator創(chuàng)建一個(gè)工程，這里命名為：CusModule，工程目錄結(jié)構(gòu)如下圖所示：

上圖中，有一個(gè)描述qml應(yīng)用的main.qml文件，還有一個(gè)main.cpp文件用于描述一個(gè)Qt應(yīng)用，并創(chuàng)建QGuiApplication應(yīng)用和QQmlApplicationEngineqml解析引擎。

創(chuàng)建模塊

假如我們需要?jiǎng)?chuàng)建一個(gè)模塊，將該模塊命名為CusComponent，該模塊里包含一組qml文件：MyRect10.qml、MyRect20.qml、MyText10.qml、MyRect30.qml文件。

在文件中分別寫上以下簡(jiǎn)單的代碼：

//MyRect10.qml
importQtQuick2.0

Rectangle{
height:50
width:50
color:"blue"
}

//MyRect20.qml
importQtQuick2.0

Rectangle{
height:50
width:50
color:"red"
}

//MyRect30.qml
importQtQuick2.0

Rectangle{
height:50
width:50
color:"black"
}

//MyText10.qml
importQtQuick2.0
importQtQuick.Controls1.4

Label{
text:qsTr("iriczhao|自定義QML模塊");
}

接著在CusComponent目錄下添加一個(gè)qmldir文件，注意該文件名只能是qmldir，在該文件中放入以下代碼：

moduleCusComponent
CusMyRect1.0MyRect10.qml
CusMyText1.0MyText10.qml
CusMyRect2.0MyRect20.qml
CusMyRect3.0MyRect30.qml

qmldir文件是一個(gè)純文本文件，該文件內(nèi)容由命令組成，用于描述組成該模塊的文件和'資源。語(yǔ)法如下（此處只列出兩條命令）：

module

該命令用于聲明模塊的模塊標(biāo)識(shí)符，是模塊的標(biāo)識(shí)符，它必須與模塊的安裝路徑匹配。模塊標(biāo)識(shí)符指令必須位于qml文件的第一行。

[singleton]

該命令用于聲明模塊可用的QML對(duì)象類型。

『singleton』用于聲明單列類型，該參數(shù)可選。

『TypeName』可用的類型名稱。

『InitialVersion』可用類型對(duì)應(yīng)的模塊版本。

『File』是定義類型的QML文件的(相對(duì))文件名。

qmldir文件中可以存在零個(gè)或多個(gè)對(duì)象類型聲明，但是每個(gè)對(duì)象類型在模塊的特定版本中必須有一個(gè)唯一的類型名稱。

完成后目錄結(jié)構(gòu)如下：

在QtCreator中的目錄結(jié)構(gòu)如下圖所示：

注，qmldir文件也要添加到資源管理中。

導(dǎo)入模塊

在main.qml文件中使用import語(yǔ)言導(dǎo)入模塊，語(yǔ)法如下：

import模塊名版本號(hào)

本文則使用import CusComponent 1.0導(dǎo)入，然后我們?cè)O(shè)計(jì)一個(gè)簡(jiǎn)單的界面顯示，完整代碼如下：

importQtQuick2.15
importQtQuick.Window2.15
importQtQuick.Controls2.15

importCusComponent1.0

Window{
width:640
height:480
visible:true
color:"#89c3f6"
title:qsTr("HelloWorld")

//MyRect10.qml
CusMyRect{}

//MyText10.qml
CusMyText{
x:200
y:10
}
}

這時(shí)候，在QtCreator代碼編輯器中，我們可以看見(jiàn)幾個(gè)錯(cuò)誤的地方：

接著，我們運(yùn)行一下程序，將會(huì)報(bào)錯(cuò)：module "CusComponent" is not installed

出現(xiàn)這三個(gè)問(wèn)題的原因提示已經(jīng)很明顯啦：那就是模塊沒(méi)有安裝，接下來(lái)讓我們來(lái)安裝模塊啦。

安裝模塊

當(dāng)我們的模塊設(shè)計(jì)好后，需要安裝。安裝的本質(zhì)就是將QML的解析路徑告訴QtCreator和QML解析引擎。

（1）將QML的解析路徑告訴QML解析引擎 這一點(diǎn)，使用qputenv(模塊路徑)或addImportPath(模塊路徑)函數(shù)實(shí)現(xiàn)，在本文中，如果使用qputenv，則需要在main()函數(shù)的開(kāi)始處添加如下代碼：

qputenv("QML2_IMPORT_PATH",":/");

如果使用addImportPath()，則需要在QML解析引擎下添加如下代碼：

注，上述路徑是相對(duì)于資源系統(tǒng)的，

我們可以使用QQmlApplicationEngine的importPathList()函數(shù)查看當(dāng)前QML解析引擎導(dǎo)入的路徑都包含了哪些，是否包含了我們需要的模塊路徑。

好啦，至此，我們已經(jīng)將QML的解析路徑告訴了QML解析引擎。這時(shí)候，應(yīng)用軟件是可以啟動(dòng)運(yùn)行了，如下圖所示：

但是，QtCreator代碼編輯器中的問(wèn)題依然存在：QML module not found(CusComponent)和對(duì)象類型不高亮顯示。這時(shí)候，還需要我們將QML的解析路徑告訴QtCreator：在.pro工程描述文件中，添加如下代碼：

即可解決。

注意：路徑與在QML的解析路徑告訴QML解析引擎時(shí)設(shè)置的路徑相同

備注

（1）在設(shè)置導(dǎo)入模塊路徑時(shí)需要注意路徑的寫法，例如，如果本例寫成/CusComponet是無(wú)法正確安裝模塊的。這一點(diǎn)，我們可以理解成：QML模塊是需要一個(gè)模塊名的，在寫模塊導(dǎo)入路徑時(shí)，寫到模塊名上一級(jí)目錄就可以了，不能寫到模塊名，本文模塊名則是：CusComponet。

（2）編寫模塊描述文件qmldir時(shí)，是可以指定qml組件類型的版本號(hào)的，這一點(diǎn)則是創(chuàng)建QML模塊的一個(gè)重要優(yōu)點(diǎn)，例如，如果將本文的模塊導(dǎo)入語(yǔ)句改成：import CusComponent 2.0，就會(huì)報(bào)：CusMyText is not a type信息了且應(yīng)用無(wú)法啟動(dòng)運(yùn)行。（模塊的版本控制將在后續(xù)文章中寫到啦）

（3）在QtCreator中，如果導(dǎo)入語(yǔ)句語(yǔ)法和用法都正常，且能正常啟動(dòng)運(yùn)行qml程序，但是在代碼編輯器中依然會(huì)報(bào)：QT Unknown component（M300）錯(cuò)誤。

這是因?yàn)镼tCreator的代碼模型沒(méi)有重置更新。可按照下列步驟解決：

依次點(diǎn)擊：工具 --> QML/JS --> 重置代碼模型，重置更新一下代碼模型即可解決。

審核編輯：劉清