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

[db:作者]

本文目录

CMake简介

CMake命令

CMake常见指令

常用环境变量

Qt应用示例

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

参考CMake是一个跨平台、开源的构建工具，在C/C++项目中有广泛应用。本文首先介绍CMake及常用指令，并结合工作时需要用到的Qt 5，给出一个完整的CMake项目配置。
! w  I2 G2 o/ R7 p2 a5 I7 j- ^ 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也算出身名门，因此能很快流行开来。
1 r) X( m/ ^# L* \ CMake命令返回目录CMake基于CMakeLists.txt文件来生成对应目标(generator)的构建文件，一个标准的CMake项目构建操作为(命令行方式)：
. ~8 e# |- i: t1 r( l7 h$ Icd PROJECT_DIR
cmake
make TARGET或者使用用CMake GUI：
) [& x1 E4 B7 u/ O, ], p
+ p; g. g% ~* c* Z) C- n
CMake-GUI操作示意图然后使用VS打开生成的.sln项目，即可编译、运行和调试项目。
* L1 A9 [6 @6 h  p3 [Linux/Unix/MacOS平台上，CMake默认生成标准的makefile；Windows平台上则会检测Visual Studio版本，生成对应的VS .sln项目工程文件(在MSYS/Cygwin/WSL环境下执行除外)。可以使用 -G 选项切换生成目标，例如生成Ninja构建文件：
cmake . -G Ninja
9 \& h% ^2 i" k: `8 {. v- u6 O( E, J. nninja TARGETCMake一个非常棒的特性是“外部构建”(out-of-source build)，即支持在源码目录外构建。由于这个特性，以及CMake生成的makefile没有clean命令，一般来说都推荐在单独的build目录中构建：
mkdir -p build
cd $_
cmake ..
make TARGET -j4如果使用CMake GUI，Browse Build时请选择单独的构建目录。
' m) q; E' B% f' X7 j+ h命令行方式下编译Debug/Release版本、传递C++编译参数，请使用 -D 选项，例如：
cmake .. -DCMAKE_BUILD_TYPE=Release
make TARGET -j4一些内置的宏定义参数可参考下文的环境变量。
5 `; i3 H) O8 K1 N( h- r- E如果是生成VS项目，则只需在VS中选择构建版本、设置编译和链接参数即可。
+ C! a) j1 {7 V& D  c; d3 G/ r1 p CMake常见指令返回目录CMake基于CMakeLists.txt文件生成项目构建文件，因此编写CMakeLists.txt文件是CMake项目的核心。本小节介绍一些用在CMakeLists.txt文件中的常用指令。
CMakeLists.txt 使用  # 作为注释，# 所在行后续字符均作为注释被忽略
. O( t/ p  @- A9 Y  [

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

project指定项目名称及属性。C/C++项目的建议值为：project(项目名称 C CXX)。

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

if…else[if]…endif条件控制语句，注意指令后的括号不可省略：
if (WIN32)
xxxx
) o( n" O4 q, j+ a0 _else() # 括号不可省略
6 t3 H0 r. G5 R8 c# Yxxxx
endif()

find_package查找指定模块，例如OpenMP。Qt 5项目一般需要：find_package(Qt5 COMPONENTS Widgets REQUIRED)。

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

link_directories设置链接库的路径，更推荐的指令是 target_link_directories，理由见 include_directories。
0 l3 i; K* W* \/ G# f% w% [1 }. r

aux_source_directory将指定目录下的源文件添加到变量中，例如：aux_source_directory(./src SRC)。注意该命令不会递归包含子目录源文件。
: |* s% t5 d) `: y& k. G

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

find_library查找指定库的路径并保存到变量中。
5 O" }  \$ B( ~# y7 f

add_custom_command添加自定义命令，可用于构建前进行moc，构建后拷贝文件等用途。

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

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

add_library构建动态或静态库，一般存在于子目录或者库的CMakeLists.txt文件中。
: q8 `6 q- I4 q/ u' f7 {" J% j

message可在cmake构建时输出信息。
CMakeLists.txt文件中指令不区分大小写，但一般来说同一个文件中指令应保持大小写风格一致。
& ~* x2 d. a! F5 V, X" ?; _' T更多指令可参考 CMake官方文档。
) }! }! n# j4 `& c 常用环境变量返回目录本小节介绍几个常用的环境变量(编译宏)。
: R, F7 K5 ?% k5 _! T% T6 ?* L+ W% c

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作为构建工具：


6 X  Z9 E% e  K  FQt新建项目使用CMake生成项目后，项目文件夹将出现CMakeLists.txt和CMakeLists.txt.user两个文件，熟悉的.pro文件没有了(CMakeLists.txt.user充当了Qt Creator工程文件的角色，其他IDE用不到，可删除)。
9 |) i7 L6 [' ?0 G0 F但需要注意的是，此时Qt Creator中编译项目是没问题的，但是在CLion/VS Code中打开，或者生成Visual Studio用的.sln文件会有问题，因为CMake无法检测到Qt是否安装及其安装路径。
. I% C8 R3 U. z3 I: R解决办法便是在 project 指令后增加如下指令告知Qt的安装位置：
! b1 f/ A' ^' T! O) `8 E# s  c# 具体路径请根据自身情况替换
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项目文件。
VS中编译好后，运行时会提示无法找到Qt相关的dll导致程序不能正常运行。解决办法包括：
& }; Z. m6 }9 B! ^* ?& s) y1. 设置VS选项，将Qt的dll路径包含进去；
2. 将Qt相关dll拷贝到编译输出文件夹；
3. 设置CMake，使其能自动复制所需要的dll。
这里介绍第三种方式，原理是借助Qt自带的windeployqt.exe程序自动部署程序所需dll到目标文件夹。具体操作为，在项目根目录的CMakeLists.txt最后添加部署dll的指令：
; U9 a- o0 o- |- _) P" s, p& Lset(QT_BIN_PATH "${QT_MSVC_PATH}/bin")
function(windeployqt target)
# POST_BUILD step
2 N1 }% v$ y# h2 x9 r0 W+ ]5 g$ l# - after build, we have a bin/lib for analyzing qt dependencies
! `, o' K5 m. o- T3 {# - we run windeployqt on target and deploy Qt libs
$ F1 D( Y7 K2 Y3 _3 g9 `add_custom_command(TARGET ${target} POST_BUILD
COMMAND "${QT_BIN_PATH}/windeployqt.exe"
--verbose 1
#--release # uncomment this line if built with Release
; ~! d( {% ]% w#--no-svg
#--no-angle
#--no-opengl
' z0 U5 `2 m/ n& _4 _#--no-opengl-sw
#--no-compiler-runtime
#--no-system-d3d-compiler
& ~. G5 C( M4 @3 K( ]9 n\"$\"
COMMENT "Deploying Qt libraries using windeployqt for compilation target '${target}' ..."
# O  f7 s2 T6 d7 W)
endfunction()
8 W! d$ O' k5 ~; K% K4 d( \; f0 j, dif (WIN32)
5 t& d% Q& s( m2 G! C  windeployqt(${PROJECT_NAME})
endif()最后，转换成VS项目时，默认是Console项目，运行时会有cmd窗口。一个解决办法是在生成可执行文件时设置目标为 WIN32：
# h, E% I1 n8 k, |$ Oadd_executable(${PROJECT_NAME} WIN32 xxxx)
9 ]" {7 C4 z+ Q& i+ d1 X* \ 一个完整的Qt 5项目CMakeLists.txt返回目录以下是一个适用于Windows平台的Qt 5项目完整CMakeLists.txt，实际使用时请替换名字和Qt 5安装路径等：
. r  n5 Q2 P' R7 o6 N) H# Kcmake_minimum_required(VERSION 3.7)
0 O+ a" N5 g8 |0 v* X# 请将myproject改成实际的应用名字
( @8 G2 |; k/ ^8 ^9 K; Gproject(myproject LANGUAGES CXX)
4 M: N5 r8 ~6 u  ^, A2 ?! S7 pset(CMAKE_INCLUDE_CURRENT_DIR ON)
1 t  q( \: J8 b. |/ F8 E* \' ~# 请更改为实际的Qt安装目录
9 s  r% t# O6 n. @- F9 Y: R4 lset(QT_MSVC_PATH "C:\\Qt\\Qt5.12.8\\5.12.8\\msvc2017_64")
0 `( ~. ?( a* N8 T/ c( K) a! a, yset(CMAKE_PREFIX_PATH "${QT_MSVC_PATH}/lib/cmake")
set(QT_BIN_PATH "${QT_MSVC_PATH}/bin")
% N: Z  U5 d# c; G' g2 yset(CMAKE_AUTOUIC ON)
set(CMAKE_AUTOMOC ON)
% J9 `/ d; Q' |5 Z$ l. p9 k' cset(CMAKE_AUTORCC ON)
9 O9 ]& m0 M# O) \: X" R7 o9 Gset(CMAKE_CXX_STANDARD 11)
2 M0 v( c. [8 W1 I  \: v; h. K# Mset(CMAKE_CXX_STANDARD_REQUIRED ON)
find_package(Qt5 COMPONENTS Widgets REQUIRED)
# 默认Release构建
2 v, h- H7 I; J( Yif (NOT CMAKE_BUILD_TYPE)
    set( CMAKE_BUILD_TYPE "Release" )
" O: l9 k# j/ wendif()
message("build type: ${CMAKE_BUILD_TYPE}")
# 按照自己的项目结构添加文件
. T! [1 t$ D9 C( U- V! G# 也可使用file/aux_source_directory批量引入，注意不要引入自动生成的文件！
add_executable(${PROJECT_NAME} WIN32
, R* `2 V1 h- y% s1 Y9 c# I  x  main.cpp
4 ~& l$ G* A; h+ N9 W. E  mainwindow.cpp
' ?! n# i& T9 I  mainwindow.h
)
9 Z! k4 c" V; v5 H+ c3 ^target_link_libraries(${PROJECT_NAME} PRIVATE Qt5::Widgets)
4 G0 V7 k2 {+ T+ c, D9 b' p0 V+ ?function(windeployqt target)
& N1 K" ?3 X; l' R0 G8 j. Z# POST_BUILD step
add_custom_command(TARGET ${target} POST_BUILD
COMMAND "${QT_BIN_PATH}/windeployqt.exe"
/ e9 u+ V4 m. B5 r, U, D+ Y--verbose 1
#--release
#--no-svg
#--no-angle
$ p) D* B  w$ V% a% L; a#--no-opengl
% U6 Y" h9 A  G5 l% `#--no-opengl-sw
#--no-compiler-runtime
& y) b; N: v8 B) y#--no-system-d3d-compiler
2 F4 c! i! F/ v- P* S2 J# u\"$\"
COMMENT "Deploying Qt libraries using windeployqt for compilation target '${target}' ..."
)
endfunction()
& M  L# P" }* Wif (WIN32)
3 W, }7 o/ Y4 t! x* n* A* _  V  windeployqt(${PROJECT_NAME})
7 R( l/ p6 R( Nendif()
````通过上面的配置，我们的Qt项目既可在Qt Creator中正常编译运行，也可在CLion/Visual Studio中正常编译运行而 无需安装Qt插件。
8 L, p9 F$ k0 @( Y( V$ t1 n 参考返回目录1. CMake官网
, U( ^4 o6 X7 P0 O3 D2. CMake教程
3. CMake FAQ
4. CMake指定编译器
AD：【国外VPS推荐】 搬瓦工三网回程CN2 GIA VPS，季付46.87$打赏赞(3)