CMake简明实用教程 - 青浦海洋数码电脑城

[db:作者]

本文目录

CMake简介

CMake命令

CMake常见指令

常用环境变量

Qt应用示例

一个完整的Qt 5项目CMakeLists.txt

参考CMake是一个跨平台、开源的构建工具，在C/C++项目中有广泛应用。本文首先介绍CMake及常用指令，并结合工作时需要用到的Qt 5，给出一个完整的CMake项目配置。
CMake简介返回目录CMake如其名”Cross-platform Make”，是一个 跨平台、开源 的构建工具。与make不同，CMake并不直接构建软件，而是生成用于构建的Makefile、.sln等工程文件，相当于高阶构建工具。
与另一构建工具Automake相比，CMake使用上更方便，支持更多的编译套件(Ninja、VS等)。许多编辑器和IDE，如VS Code(宇宙第一编辑器/IDE)、Clion、Visual Studio等都内置了对CMake的支持。特别的，CMake已经是QT 6的默认构建工具，官方给出从qmake迁移的理由是CMake成熟稳定、用户基数大生态完善。因此，对于需要跨平台编译运行的C/C++项目，很推荐学习和使用CMake作为构建工具，能方便的转换成各种IDE项目，团队成员无需切换编辑器/IDE即可工作。
值得一提的是，CMake由Kitware公司开发和维护，VTK和ParaView等知名开源产品均出自该公司。从这方面看，CMake也算出身名门，因此能很快流行开来。
CMake命令返回目录CMake基于CMakeLists.txt文件来生成对应目标(generator)的构建文件，一个标准的CMake项目构建操作为(命令行方式)：
- T; Y9 h4 P* P  F# S4 s/ Q4 {cd PROJECT_DIR
cmake
2 R3 H6 \& k) s* B) x! jmake TARGET或者使用用CMake GUI：


- I' H. {1 r, y7 o5 H6 Q$ [CMake-GUI操作示意图然后使用VS打开生成的.sln项目，即可编译、运行和调试项目。
Linux/Unix/MacOS平台上，CMake默认生成标准的makefile；Windows平台上则会检测Visual Studio版本，生成对应的VS .sln项目工程文件(在MSYS/Cygwin/WSL环境下执行除外)。可以使用 -G 选项切换生成目标，例如生成Ninja构建文件：
cmake . -G Ninja
ninja TARGETCMake一个非常棒的特性是“外部构建”(out-of-source build)，即支持在源码目录外构建。由于这个特性，以及CMake生成的makefile没有clean命令，一般来说都推荐在单独的build目录中构建：
mkdir -p build
+ f* ]. V# d3 L0 s4 H! [/ t& j! Qcd $_
: {7 j7 i4 p5 H  A1 ecmake ..
make TARGET -j4如果使用CMake GUI，Browse Build时请选择单独的构建目录。
5 P( N( k" w% W命令行方式下编译Debug/Release版本、传递C++编译参数，请使用 -D 选项，例如：
+ Z; K6 T& V( u: ^8 D  F8 _/ w+ wcmake .. -DCMAKE_BUILD_TYPE=Release
0 R% V6 s/ z2 _make TARGET -j4一些内置的宏定义参数可参考下文的环境变量。
  q( R. m: _4 F/ S- J. Z* C如果是生成VS项目，则只需在VS中选择构建版本、设置编译和链接参数即可。
CMake常见指令返回目录CMake基于CMakeLists.txt文件生成项目构建文件，因此编写CMakeLists.txt文件是CMake项目的核心。本小节介绍一些用在CMakeLists.txt文件中的常用指令。
$ \& \, O6 d1 e) J5 ZCMakeLists.txt 使用  # 作为注释，# 所在行后续字符均作为注释被忽略
4 o) V/ O3 N8 Z) P! U6 m  y* I

cmake_minimum_required一般这条指令出现在文件的最前面，用来指定项目支持的最低版本。对于Qt 5项目，建议为：cmake_minimum_required(VERSION 3.7)。

project指定项目名称及属性。C/C++项目的建议值为：project(项目名称 C CXX)。
: k; ~5 X+ `1 i6 t

set定义一些变量、宏的值。该指令一般会出现多次，例如设置C++语法标准：set(CMAKE_CXX_STANDARD 11)。相反的指令是unset。

if…else[if]…endif条件控制语句，注意指令后的括号不可省略：
if (WIN32)
2 {: P  Z4 p$ _  G9 ]xxxx
- ^4 C" m+ u" s% _0 Oelse() # 括号不可省略
/ P2 h$ Z; Q* wxxxx
endif()

find_package查找指定模块，例如OpenMP。Qt 5项目一般需要：find_package(Qt5 COMPONENTS Widgets REQUIRED)。
  R* R  W) M5 ?& z6 q6 f

include_directories添加头文件include路径，一个更推荐使用的指令是 target_include_directories，其不污染后续目标的include路径，且能精细控制是否暴露依赖的包含路径。但是 target_include_directories 需要CMake 3.13 版本才支持，在Visual Studio 2017中使用会有问题。
! Q9 j; t5 I0 u$ B( J: t( K

link_directories设置链接库的路径，更推荐的指令是 target_link_directories，理由见 include_directories。
/ `& H3 D0 A  |; H- k9 `

aux_source_directory将指定目录下的源文件添加到变量中，例如：aux_source_directory(./src SRC)。注意该命令不会递归包含子目录源文件。

filefile命令是一个功能丰富的目录和文件操作指令，例如递归找出目录下的所有源文件保存到SRC变量中：file(GLOB_RECURSE SRC "src/*.cpp" "src/*/*.cpp")。
相对于把每个需要编译的文件添加到CMakeLists.txt中，aux_source_directory 和 file 等指令可方便的引入多个文件，但其弊端之一是CMake不能感知文件变化。当新增文件、文件被删除、重命名时需刷新CMake缓存才能被应用到项目中。

find_library查找指定库的路径并保存到变量中。
9 Y* V( P3 \# v

add_custom_command添加自定义命令，可用于构建前进行moc，构建后拷贝文件等用途。
4 g! _% n: t  M2 _

add_subdirectory添加一个需要构建的子目录，子目录下有CMakeLists.txt文件设定好构建规则。
+ q7 C, u' e8 z9 e

add_executable构建可执行程序，一般项目的主CMakeLists.txt中会有这条指令。
' Z+ I2 r0 u- N% S, x, n

add_library构建动态或静态库，一般存在于子目录或者库的CMakeLists.txt文件中。

message可在cmake构建时输出信息。
3 F, p, Y" v) |( D% _CMakeLists.txt文件中指令不区分大小写，但一般来说同一个文件中指令应保持大小写风格一致。
4 q2 S8 f# o# K* Q& U$ v更多指令可参考 CMake官方文档。
( b1 F$ y: K, b' | 常用环境变量返回目录本小节介绍几个常用的环境变量(编译宏)。
- l* I9 }& l7 c+ W( R

CMAKE_BUILD_TYPE:  指定构建类型，常用值为 Debug、Release、RelWithDebInfo 和 MinSizeRel；

CMAKE_C(XX)_FLAGS：传递给C/C++编译器的编译选项，例如输出所有警告： -DCMAKE_CXX_FLAGS="-Wall"；

– CMAKE_EXE/MODULE/_LINKER_FLAGS：传递给C/C++链接器的编译选项，例如指定链接数学库：-DCMAKE_LINKER_FLAGS="-lmath"。 Qt应用示例返回目录本节结合工作时需要用到的Qt 5，介绍Qt 5工程中CMake的使用方式。
- h5 ^, p' U$ S  J! A新建Qt项目时，可以选择CMake作为构建工具：

; j3 o* K8 s9 p$ S
/ t  d: _4 S: T, u3 t# BQt新建项目使用CMake生成项目后，项目文件夹将出现CMakeLists.txt和CMakeLists.txt.user两个文件，熟悉的.pro文件没有了(CMakeLists.txt.user充当了Qt Creator工程文件的角色，其他IDE用不到，可删除)。
但需要注意的是，此时Qt Creator中编译项目是没问题的，但是在CLion/VS Code中打开，或者生成Visual Studio用的.sln文件会有问题，因为CMake无法检测到Qt是否安装及其安装路径。
解决办法便是在 project 指令后增加如下指令告知Qt的安装位置：
# 具体路径请根据自身情况替换
set(QT_MSVC_PATH "C:\\Qt\\Qt5.12.8\\5.12.8\\msvc2017_64")
1 b+ N  B0 ^, ]7 Qset(CMAKE_PREFIX_PATH "${QT_MSVC_PATH}/lib/cmake")
3 v$ n- U: [( h9 j9 z/ Q, f然后再次运行 cmake 指令或者使用CMake GUI重新运行，构建文件夹下便能正常生成.sln项目文件。
+ b9 t4 U: D7 `. R, t( \VS中编译好后，运行时会提示无法找到Qt相关的dll导致程序不能正常运行。解决办法包括：
1. 设置VS选项，将Qt的dll路径包含进去；
0 P, X" L# j+ q 2. 将Qt相关dll拷贝到编译输出文件夹；
3. 设置CMake，使其能自动复制所需要的dll。
这里介绍第三种方式，原理是借助Qt自带的windeployqt.exe程序自动部署程序所需dll到目标文件夹。具体操作为，在项目根目录的CMakeLists.txt最后添加部署dll的指令：
set(QT_BIN_PATH "${QT_MSVC_PATH}/bin")
6 P3 H' j. P/ K0 [function(windeployqt target)
8 f$ o8 f3 P" y  X# POST_BUILD step
# \! n# \  t8 W6 @# - after build, we have a bin/lib for analyzing qt dependencies
1 {* H1 Z" m' \0 N! h; q) B& I# - we run windeployqt on target and deploy Qt libs
add_custom_command(TARGET ${target} POST_BUILD
' c( [1 }! H9 o% |4 j6 I6 q/ P" {COMMAND "${QT_BIN_PATH}/windeployqt.exe"
# V3 i8 ]0 ^* v--verbose 1
#--release # uncomment this line if built with Release
2 S3 Z/ N/ }3 X# [6 O5 g  j, @, o5 H#--no-svg
#--no-angle
* n& ]% U- n2 p9 Q* s5 e#--no-opengl
#--no-opengl-sw
#--no-compiler-runtime
#--no-system-d3d-compiler
\"$\"
: L' _* n( m. Y1 ~9 k/ x* nCOMMENT "Deploying Qt libraries using windeployqt for compilation target '${target}' ..."
)
# Y+ f0 x# V# Xendfunction()
if (WIN32)
/ l' y# x- G; g$ s2 W  windeployqt(${PROJECT_NAME})
endif()最后，转换成VS项目时，默认是Console项目，运行时会有cmd窗口。一个解决办法是在生成可执行文件时设置目标为 WIN32：
add_executable(${PROJECT_NAME} WIN32 xxxx)
' w* r' n3 W: p! ^' }( x$ t 一个完整的Qt 5项目CMakeLists.txt返回目录以下是一个适用于Windows平台的Qt 5项目完整CMakeLists.txt，实际使用时请替换名字和Qt 5安装路径等：
/ K6 a% |) X2 a4 p/ Kcmake_minimum_required(VERSION 3.7)
# 请将myproject改成实际的应用名字
project(myproject LANGUAGES CXX)
set(CMAKE_INCLUDE_CURRENT_DIR ON)
1 k" T( v8 W, [- l  s- m& q# 请更改为实际的Qt安装目录
6 x/ `/ _2 n# xset(QT_MSVC_PATH "C:\\Qt\\Qt5.12.8\\5.12.8\\msvc2017_64")
6 {. |+ y7 \# Bset(CMAKE_PREFIX_PATH "${QT_MSVC_PATH}/lib/cmake")
4 }* v3 ~0 Z4 F; \. V# ^! Wset(QT_BIN_PATH "${QT_MSVC_PATH}/bin")
set(CMAKE_AUTOUIC ON)
# R, T7 U$ o' r! Q$ K- vset(CMAKE_AUTOMOC ON)
" U* _- D: _; O/ p7 z/ Rset(CMAKE_AUTORCC ON)
9 \* Y5 ]2 A! |' V7 zset(CMAKE_CXX_STANDARD 11)
7 {0 w/ w6 i. ?set(CMAKE_CXX_STANDARD_REQUIRED ON)
find_package(Qt5 COMPONENTS Widgets REQUIRED)
# 默认Release构建
if (NOT CMAKE_BUILD_TYPE)
6 V& c" w* u) E+ u" k5 i7 f    set( CMAKE_BUILD_TYPE "Release" )
endif()
  m3 i1 e  r6 Z& b; ~- D- `3 z+ gmessage("build type: ${CMAKE_BUILD_TYPE}")
# 按照自己的项目结构添加文件
+ c& x6 H" i, A# 也可使用file/aux_source_directory批量引入，注意不要引入自动生成的文件！
0 l+ q7 I3 H) C' vadd_executable(${PROJECT_NAME} WIN32
  main.cpp
1 W& F0 c4 E& H  mainwindow.cpp
; d; E2 M- Z) n  p1 f' f1 Q3 [  mainwindow.h
+ p: f* \7 }: U' l, o4 h)
7 j6 k; B; \1 u7 ftarget_link_libraries(${PROJECT_NAME} PRIVATE Qt5::Widgets)
5 ^( A5 i4 m& _3 N  ^function(windeployqt target)
# POST_BUILD step
add_custom_command(TARGET ${target} POST_BUILD
COMMAND "${QT_BIN_PATH}/windeployqt.exe"
--verbose 1
+ m0 v3 k1 T. z7 E4 I#--release
3 X# X5 d9 y+ P0 O9 P#--no-svg
#--no-angle
# e  G& s, Y" A" W#--no-opengl
#--no-opengl-sw
# G2 l9 O$ P5 Y  t) N#--no-compiler-runtime
#--no-system-d3d-compiler
\"$\"
8 w  a) b! l- q1 C' jCOMMENT "Deploying Qt libraries using windeployqt for compilation target '${target}' ..."
3 V3 \% w! q) N7 u% q! u- b)
endfunction()
if (WIN32)
  windeployqt(${PROJECT_NAME})
endif()
+ o4 [" X1 J& w! {' T````通过上面的配置，我们的Qt项目既可在Qt Creator中正常编译运行，也可在CLion/Visual Studio中正常编译运行而 无需安装Qt插件。
参考返回目录1. CMake官网
8 b! |- H* g5 E. X1 ?+ s; Z0 `) f2. CMake教程
2 J! p5 \" E6 H3. CMake FAQ
4. CMake指定编译器
AD：【国外VPS推荐】 搬瓦工三网回程CN2 GIA VPS，季付46.87$打赏赞(3)