CMake中加入Qt模块的合理方法

引入

用CMake来组织的工程中要用Qt首先要设置、找到Qt相关模块。
主要是通过find_package这个CMake命令。
我在配置cmakelists的时候遇到了很坑，网上有很多教程讲的很不详细，这里我将我的方法分享给大家。

教程更新于2023年2月

---

添加QT模块

一、设置Qt库路径

Qt版本很多，我们的开发机上一般也装有多个不同版本的Qt。个人尝试性的项目一般用最新版的Qt，而真正发布的产品一般用的是LTS版本Qt（LTS：Long Term Support，长期支持版本）。

我们的方法是在系统中添加多个环境变量。例如电脑上装有4个版本：Qt 5.9.3和Qt5.10.1的32位和64位库。所以有4个环境变量：

环境变量名	值
QTDIR594MSVC2015	C:\Qt\Qt5.9.4\5.9.4\msvc2015
QTDIR594MSVC2015_64	C:\Qt\Qt5.9.4\5.9.4\msvc2015_64
QTDIR5101MSVC2015	C:\Qt\Qt5.10.1\5.10.1\msvc2015
QTDIR5101MSVC2015_64	C:\Qt\Qt5.10.1\5.10.1\msvc2015_64

然后在CMakeLists中添加：set(CMAKE_PREFIX_PATH $ENV{QTDIR594MSVC2015})
通过在$ENV{}里选择不同的环境变量就可以切换不同的Qt版本。

二、查找Qt模块

网上很多CMake查找Qt方法都是过时的Qt4的方法。现在正确的、最新的方法是：
find_package(Qt5 COMPONENTS Core Gui Qml Quick REQUIRED)
Components后面加的就是这个工程中会用到的Qt模块，例如上面就用到了Core、Gui、Qml、Quick这几个模块，也是一般一个Qt Quick程序必须用到的几个模块。

三、打开相关自动选项

Qt Quick程序中的QRC资源文件需要用rcc来进行预处理，生成相应.h和.cpp文件。QObject派生的C++类也需要通过moc进行处理。这些都是编译系统中所谓的Rules。CMake中通过打开下面两个选项可以自动对这些后缀的文件进行相应处理：

set(CMAKE_AUTOMOC ON)
set(CMAKE_AUTORCC ON)

由于生成的C++文件都是放在编译目录里的（在Shadow Building中有别于源码目录），所以还需要将编译目录包含到Include目录，否则编译器会找不到这些头文件：

set(CMAKE_INCLUDE_CURRENT_DIR ON)

四、链接时设置相应模块

最后一步是在链接的时候把用到的Qt库写上去：

target_link_libraries(${PROJECT_NAME}  Qt5::Core Qt5::Gui Qt5::Qml Qt5::Quick)

这样就能链接上用到的Qt库了。

完整的CMake例子

上面只是着重说明了CMake关于添加Qt模块的代码，一个完整的CMake例子肯定不止上面这些。下面就贴出一个完整的例子：

cmake_policy(VERSION 3.9)

# 设置项目名
set(PROJECT_NAME kdllVerification)
project (${PROJECT_NAME}) # 设置项目

cmake_minimum_required(VERSION 3.9)

set(CMAKE_CXX_STANDARD 11)
set(CMAKE_INCLUDE_CURRENT_DIR ON)
set(CMAKE_AUTOMOC ON)
set(CMAKE_AUTORCC ON)

# CMAKE_PREFIX_PATH 的值为告知此项目使用的 Qt 的版本；即 Qt 安装路径。
#A这里指定为自定义环境变量，为find_package指定搜索路径
set(CMAKE_PREFIX_PATH $ENV{QTDIR593MSVC2017_64})


#A找到Qt相关的模块包
find_package(Qt5 COMPONENTS Core Gui Qml Quick REQUIRED)

#A将源代码的路径定义变量，便于后面add_executable命令将代码文件加入工程
set(HEADERS 
    appglobal.h
)
set(SOURCES 
    main.cpp
    appglobal.cpp
)
set(RESOURCES 
    qml.qrc
)
set(QMLS
    main.qml
)

#A 将代码文件加入工程中
add_executable(${PROJECT_NAME} ${HEADERS} ${SOURCES} ${RESOURCES} ${QMLS})

target_link_libraries(${PROJECT_NAME}  Qt5::Core Qt5::Gui Qt5::Qml Qt5::Quick)

当需求复杂之后CMake中还会有很多命令，这个以后我们介绍具体技术的时候再讲。