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

[db:作者]

本文目录

CMake简介

CMake命令

CMake常见指令

常用环境变量

Qt应用示例

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

参考CMake是一个跨平台、开源的构建工具，在C/C++项目中有广泛应用。本文首先介绍CMake及常用指令，并结合工作时需要用到的Qt 5，给出一个完整的CMake项目配置。
+ N* e% P' h+ ^0 C8 [9 s0 D) u& M3 |; s 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也算出身名门，因此能很快流行开来。
# Z/ I, S0 {) R CMake命令返回目录CMake基于CMakeLists.txt文件来生成对应目标(generator)的构建文件，一个标准的CMake项目构建操作为(命令行方式)：
cd PROJECT_DIR
cmake
  N4 k: t- @& J& N4 \make TARGET或者使用用CMake GUI：
# H% R7 Q4 ^* ]# K. i9 F
$ J4 S" J# ~3 S9 W2 j
; Z6 z! \6 @% lCMake-GUI操作示意图然后使用VS打开生成的.sln项目，即可编译、运行和调试项目。
Linux/Unix/MacOS平台上，CMake默认生成标准的makefile；Windows平台上则会检测Visual Studio版本，生成对应的VS .sln项目工程文件(在MSYS/Cygwin/WSL环境下执行除外)。可以使用 -G 选项切换生成目标，例如生成Ninja构建文件：
cmake . -G Ninja
- ^1 k' K& F+ zninja TARGETCMake一个非常棒的特性是“外部构建”(out-of-source build)，即支持在源码目录外构建。由于这个特性，以及CMake生成的makefile没有clean命令，一般来说都推荐在单独的build目录中构建：
$ o+ ?9 N9 U1 T8 |5 N& h8 B# wmkdir -p build
9 v6 J: R& j9 J6 mcd $_
cmake ..
% h7 V& C& D. c  C" ^make TARGET -j4如果使用CMake GUI，Browse Build时请选择单独的构建目录。
命令行方式下编译Debug/Release版本、传递C++编译参数，请使用 -D 选项，例如：
7 B# c$ L0 D8 c: acmake .. -DCMAKE_BUILD_TYPE=Release
4 r3 L3 H! z' ~- ^2 j$ K8 Gmake TARGET -j4一些内置的宏定义参数可参考下文的环境变量。
如果是生成VS项目，则只需在VS中选择构建版本、设置编译和链接参数即可。
4 I) ^7 A% F2 M" \  K CMake常见指令返回目录CMake基于CMakeLists.txt文件生成项目构建文件，因此编写CMakeLists.txt文件是CMake项目的核心。本小节介绍一些用在CMakeLists.txt文件中的常用指令。
, Y- K  l& M" _0 O' cCMakeLists.txt 使用  # 作为注释，# 所在行后续字符均作为注释被忽略

cmake_minimum_required一般这条指令出现在文件的最前面，用来指定项目支持的最低版本。对于Qt 5项目，建议为：cmake_minimum_required(VERSION 3.7)。
1 b3 R4 \& O. M: `4 C9 W

project指定项目名称及属性。C/C++项目的建议值为：project(项目名称 C CXX)。
; O7 j& d- I. Q2 j' Y

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

if…else[if]…endif条件控制语句，注意指令后的括号不可省略：
if (WIN32)
$ p) W% d+ x( u+ ~4 A+ [xxxx
else() # 括号不可省略
0 D# G( S8 [0 exxxx
; F4 Q7 K6 P, \! oendif()

find_package查找指定模块，例如OpenMP。Qt 5项目一般需要：find_package(Qt5 COMPONENTS Widgets REQUIRED)。
% G- Q- c: A+ {/ S

include_directories添加头文件include路径，一个更推荐使用的指令是 target_include_directories，其不污染后续目标的include路径，且能精细控制是否暴露依赖的包含路径。但是 target_include_directories 需要CMake 3.13 版本才支持，在Visual Studio 2017中使用会有问题。
- t- T% A5 y3 l# k: I

link_directories设置链接库的路径，更推荐的指令是 target_link_directories，理由见 include_directories。
- S$ v4 X7 s: H+ \4 b$ Z- K1 o8 [

aux_source_directory将指定目录下的源文件添加到变量中，例如：aux_source_directory(./src SRC)。注意该命令不会递归包含子目录源文件。
" G) P; S3 A+ Z+ w# t

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

find_library查找指定库的路径并保存到变量中。

add_custom_command添加自定义命令，可用于构建前进行moc，构建后拷贝文件等用途。
1 g+ p1 P+ u2 m- W: `

add_subdirectory添加一个需要构建的子目录，子目录下有CMakeLists.txt文件设定好构建规则。

add_executable构建可执行程序，一般项目的主CMakeLists.txt中会有这条指令。

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

message可在cmake构建时输出信息。
* P5 Q& S) R. ?% TCMakeLists.txt文件中指令不区分大小写，但一般来说同一个文件中指令应保持大小写风格一致。
更多指令可参考 CMake官方文档。
常用环境变量返回目录本小节介绍几个常用的环境变量(编译宏)。
" {  A4 t2 G, j3 F  W* r8 M

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的使用方式。
新建Qt项目时，可以选择CMake作为构建工具：
( C) ]# T4 P/ D( n0 m  X- q) {
5 c1 w2 d- ]  O* B: H
Qt新建项目使用CMake生成项目后，项目文件夹将出现CMakeLists.txt和CMakeLists.txt.user两个文件，熟悉的.pro文件没有了(CMakeLists.txt.user充当了Qt Creator工程文件的角色，其他IDE用不到，可删除)。
- i: S1 X  V1 i) j9 M但需要注意的是，此时Qt Creator中编译项目是没问题的，但是在CLion/VS Code中打开，或者生成Visual Studio用的.sln文件会有问题，因为CMake无法检测到Qt是否安装及其安装路径。
. S3 V% s" t2 |; |, I2 f9 Q& H解决办法便是在 project 指令后增加如下指令告知Qt的安装位置：
9 H: A- g; e6 [/ T# 具体路径请根据自身情况替换
/ |) h  [& p7 i6 [: \set(QT_MSVC_PATH "C:\\Qt\\Qt5.12.8\\5.12.8\\msvc2017_64")
set(CMAKE_PREFIX_PATH "${QT_MSVC_PATH}/lib/cmake")
然后再次运行 cmake 指令或者使用CMake GUI重新运行，构建文件夹下便能正常生成.sln项目文件。
2 ~* d! g: B3 Q: S( |VS中编译好后，运行时会提示无法找到Qt相关的dll导致程序不能正常运行。解决办法包括：
1. 设置VS选项，将Qt的dll路径包含进去；
2. 将Qt相关dll拷贝到编译输出文件夹；
; z) [9 C: w2 m* b: H0 B- P0 f! u 3. 设置CMake，使其能自动复制所需要的dll。
这里介绍第三种方式，原理是借助Qt自带的windeployqt.exe程序自动部署程序所需dll到目标文件夹。具体操作为，在项目根目录的CMakeLists.txt最后添加部署dll的指令：
set(QT_BIN_PATH "${QT_MSVC_PATH}/bin")
function(windeployqt target)
. y7 t% ]9 D8 H) V' d# POST_BUILD step
# - after build, we have a bin/lib for analyzing qt dependencies
( S4 q1 p- K) G$ K# - we run windeployqt on target and deploy Qt libs
add_custom_command(TARGET ${target} POST_BUILD
( q: ?, f$ D# @/ SCOMMAND "${QT_BIN_PATH}/windeployqt.exe"
--verbose 1
#--release # uncomment this line if built with Release
#--no-svg
2 m9 d$ e4 v  f$ _" ^, ~#--no-angle
! r" w4 H7 ^% d- C& S#--no-opengl
: W6 i; x. P6 ?1 {#--no-opengl-sw
: v4 X# d% u) t: j* u/ \7 j, B#--no-compiler-runtime
#--no-system-d3d-compiler
! V; i/ B: }3 b# c. ?\"$\"
COMMENT "Deploying Qt libraries using windeployqt for compilation target '${target}' ..."
)
endfunction()
3 [, }6 o9 A! z7 D$ W0 v  mif (WIN32)
6 r9 |' i5 ~) }. n( K4 n: D5 e  windeployqt(${PROJECT_NAME})
9 T, A# o  ^5 t, V# E! Jendif()最后，转换成VS项目时，默认是Console项目，运行时会有cmd窗口。一个解决办法是在生成可执行文件时设置目标为 WIN32：
add_executable(${PROJECT_NAME} WIN32 xxxx)
一个完整的Qt 5项目CMakeLists.txt返回目录以下是一个适用于Windows平台的Qt 5项目完整CMakeLists.txt，实际使用时请替换名字和Qt 5安装路径等：
9 j6 @7 J; y) A4 j9 m* W( I6 wcmake_minimum_required(VERSION 3.7)
: u2 T+ Z4 I& M: m$ |# 请将myproject改成实际的应用名字
+ O" X# ~: n' o% tproject(myproject LANGUAGES CXX)
: g/ d' N* i9 L* |3 w  T" iset(CMAKE_INCLUDE_CURRENT_DIR ON)
% [+ }* j, H$ y1 P4 Y& ]# 请更改为实际的Qt安装目录
set(QT_MSVC_PATH "C:\\Qt\\Qt5.12.8\\5.12.8\\msvc2017_64")
set(CMAKE_PREFIX_PATH "${QT_MSVC_PATH}/lib/cmake")
: T, K3 n, J& l) S6 |8 e+ Q( g/ Aset(QT_BIN_PATH "${QT_MSVC_PATH}/bin")
& F' N( N* F$ r2 @% I7 Bset(CMAKE_AUTOUIC ON)
& n- `/ u, a- a# v( }, m# `! aset(CMAKE_AUTOMOC ON)
set(CMAKE_AUTORCC ON)
set(CMAKE_CXX_STANDARD 11)
set(CMAKE_CXX_STANDARD_REQUIRED ON)
7 {8 {. I5 E# b4 N" afind_package(Qt5 COMPONENTS Widgets REQUIRED)
& _9 ?" u- U0 {# R. ?# 默认Release构建
if (NOT CMAKE_BUILD_TYPE)
    set( CMAKE_BUILD_TYPE "Release" )
endif()
message("build type: ${CMAKE_BUILD_TYPE}")
# 按照自己的项目结构添加文件
# 也可使用file/aux_source_directory批量引入，注意不要引入自动生成的文件！
  ^4 r! s1 j1 a( Qadd_executable(${PROJECT_NAME} WIN32
8 |5 e9 z4 B. [7 _, z" W  main.cpp
  mainwindow.cpp
  ?6 P4 u- p7 p) E  mainwindow.h
" e2 E  T. ?$ N+ {% G8 t* I% h2 L)
% z# ~& j9 a2 b$ q" `  B* atarget_link_libraries(${PROJECT_NAME} PRIVATE Qt5::Widgets)
function(windeployqt target)
# POST_BUILD step
7 j4 ]9 T2 W+ }8 ?add_custom_command(TARGET ${target} POST_BUILD
; @' ^1 ]% }( d6 @) }COMMAND "${QT_BIN_PATH}/windeployqt.exe"
6 v" V: \' O  t$ D, u) ?--verbose 1
  K/ R: n2 w: u" Q# G9 Z- Q#--release
#--no-svg
" E9 L8 m5 P4 U# h) O9 f" ?#--no-angle
#--no-opengl
#--no-opengl-sw
. m( j, `) ?2 e2 v4 d#--no-compiler-runtime
#--no-system-d3d-compiler
3 J! k8 Y& L! a0 V! h\"$\"
6 h: a: O* u4 @- ~/ h( ZCOMMENT "Deploying Qt libraries using windeployqt for compilation target '${target}' ..."
)
endfunction()
if (WIN32)
/ j0 B4 _6 e9 [2 E4 @  windeployqt(${PROJECT_NAME})
0 j4 z8 c) `( uendif()
" w1 Q+ t4 n" O, j3 ?3 ]( \; o% L````通过上面的配置，我们的Qt项目既可在Qt Creator中正常编译运行，也可在CLion/Visual Studio中正常编译运行而 无需安装Qt插件。
0 T: }7 m. N+ ^+ ]! k 参考返回目录1. CMake官网
' N  `# I& F  l5 P* ?2. CMake教程
) F1 l% l! Q; k# B/ ]3. CMake FAQ
% o! I7 ?0 n- X4. CMake指定编译器
" L5 h- V/ p( N4 C- i' HAD：【国外VPS推荐】 搬瓦工三网回程CN2 GIA VPS，季付46.87$打赏赞(3)