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

[db:作者]

本文目录

CMake简介

CMake命令

CMake常见指令

常用环境变量

Qt应用示例

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

参考CMake是一个跨平台、开源的构建工具，在C/C++项目中有广泛应用。本文首先介绍CMake及常用指令，并结合工作时需要用到的Qt 5，给出一个完整的CMake项目配置。
( ^0 N  l/ c2 F2 X" X5 W0 j- Q: s: S- f, d CMake简介返回目录CMake如其名”Cross-platform Make”，是一个 跨平台、开源 的构建工具。与make不同，CMake并不直接构建软件，而是生成用于构建的Makefile、.sln等工程文件，相当于高阶构建工具。
* W1 [6 |0 J: z- }% g1 V- f与另一构建工具Automake相比，CMake使用上更方便，支持更多的编译套件(Ninja、VS等)。许多编辑器和IDE，如VS Code(宇宙第一编辑器/IDE)、Clion、Visual Studio等都内置了对CMake的支持。特别的，CMake已经是QT 6的默认构建工具，官方给出从qmake迁移的理由是CMake成熟稳定、用户基数大生态完善。因此，对于需要跨平台编译运行的C/C++项目，很推荐学习和使用CMake作为构建工具，能方便的转换成各种IDE项目，团队成员无需切换编辑器/IDE即可工作。
8 v7 a( P; O3 A) A0 V值得一提的是，CMake由Kitware公司开发和维护，VTK和ParaView等知名开源产品均出自该公司。从这方面看，CMake也算出身名门，因此能很快流行开来。
/ ]2 Q9 m6 d" x9 f  f CMake命令返回目录CMake基于CMakeLists.txt文件来生成对应目标(generator)的构建文件，一个标准的CMake项目构建操作为(命令行方式)：
cd PROJECT_DIR
+ k7 ^2 ?# U% U4 gcmake
6 M8 V3 B! a, M1 {. Imake TARGET或者使用用CMake GUI：

( v7 d+ z/ W6 j3 L# F8 ?) u1 z7 ^1 s
) r3 Z* l, T0 K4 {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目录中构建：
% \! L/ A# m7 p  K: tmkdir -p build
cd $_
1 |) L1 F* X! M* K- l, Wcmake ..
/ N: d; q& g! k/ Kmake TARGET -j4如果使用CMake GUI，Browse Build时请选择单独的构建目录。
$ |3 F) ~: Q" D5 h1 |) j9 I命令行方式下编译Debug/Release版本、传递C++编译参数，请使用 -D 选项，例如：
% `; O& I4 _+ Q; |3 @) ?9 {cmake .. -DCMAKE_BUILD_TYPE=Release
( w7 G6 t9 |2 p) cmake TARGET -j4一些内置的宏定义参数可参考下文的环境变量。
" P' A* L9 X$ y如果是生成VS项目，则只需在VS中选择构建版本、设置编译和链接参数即可。
CMake常见指令返回目录CMake基于CMakeLists.txt文件生成项目构建文件，因此编写CMakeLists.txt文件是CMake项目的核心。本小节介绍一些用在CMakeLists.txt文件中的常用指令。
+ n6 K  q, d2 k+ k$ MCMakeLists.txt 使用  # 作为注释，# 所在行后续字符均作为注释被忽略
1 j$ H# w7 h. \

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

project指定项目名称及属性。C/C++项目的建议值为：project(项目名称 C CXX)。
9 m2 x7 A1 J0 X! x5 g+ }1 v

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

if…else[if]…endif条件控制语句，注意指令后的括号不可省略：
if (WIN32)
xxxx
else() # 括号不可省略
xxxx
. e- c# n) a! a0 j+ s: Oendif()

find_package查找指定模块，例如OpenMP。Qt 5项目一般需要：find_package(Qt5 COMPONENTS Widgets REQUIRED)。
! \4 O2 ^) i: B1 Q' R, W7 k, l

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

link_directories设置链接库的路径，更推荐的指令是 target_link_directories，理由见 include_directories。
/ F7 H/ n8 n. |, o# ~- D+ q. f4 b

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查找指定库的路径并保存到变量中。
& a6 _0 f$ b& m; y$ H# N8 n

add_custom_command添加自定义命令，可用于构建前进行moc，构建后拷贝文件等用途。
$ J. N, b( E' N) j' x

add_subdirectory添加一个需要构建的子目录，子目录下有CMakeLists.txt文件设定好构建规则。
. ^" \& x  h0 X

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

add_library构建动态或静态库，一般存在于子目录或者库的CMakeLists.txt文件中。
' l# _. e  E" ^. B

message可在cmake构建时输出信息。
CMakeLists.txt文件中指令不区分大小写，但一般来说同一个文件中指令应保持大小写风格一致。
: k9 d* }( T8 h; x更多指令可参考 CMake官方文档。
常用环境变量返回目录本小节介绍几个常用的环境变量(编译宏)。

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


Qt新建项目使用CMake生成项目后，项目文件夹将出现CMakeLists.txt和CMakeLists.txt.user两个文件，熟悉的.pro文件没有了(CMakeLists.txt.user充当了Qt Creator工程文件的角色，其他IDE用不到，可删除)。
' [- G7 U# z1 a但需要注意的是，此时Qt Creator中编译项目是没问题的，但是在CLion/VS Code中打开，或者生成Visual Studio用的.sln文件会有问题，因为CMake无法检测到Qt是否安装及其安装路径。
解决办法便是在 project 指令后增加如下指令告知Qt的安装位置：
4 D: s) m' ^8 a+ f  S' [: t# 具体路径请根据自身情况替换
* A8 e) \, S: g4 ?2 yset(QT_MSVC_PATH "C:\\Qt\\Qt5.12.8\\5.12.8\\msvc2017_64")
# B5 o  c* y& U2 v5 K8 ^4 Nset(CMAKE_PREFIX_PATH "${QT_MSVC_PATH}/lib/cmake")
然后再次运行 cmake 指令或者使用CMake GUI重新运行，构建文件夹下便能正常生成.sln项目文件。
VS中编译好后，运行时会提示无法找到Qt相关的dll导致程序不能正常运行。解决办法包括：
1. 设置VS选项，将Qt的dll路径包含进去；
) ~/ M& p! \8 p& K" g9 m 2. 将Qt相关dll拷贝到编译输出文件夹；
. [" v5 H7 w( @) i 3. 设置CMake，使其能自动复制所需要的dll。
8 f# ^0 T5 y0 V, c$ W这里介绍第三种方式，原理是借助Qt自带的windeployqt.exe程序自动部署程序所需dll到目标文件夹。具体操作为，在项目根目录的CMakeLists.txt最后添加部署dll的指令：
) L' w: }2 C% K! Sset(QT_BIN_PATH "${QT_MSVC_PATH}/bin")
function(windeployqt target)
# POST_BUILD step
- e  c; ~- b! P3 r- D  F* `2 n# - after build, we have a bin/lib for analyzing qt dependencies
" G2 x$ M. v( J8 [( Q# - we run windeployqt on target and deploy Qt libs
7 z5 a5 g8 g' @, T; J& h; aadd_custom_command(TARGET ${target} POST_BUILD
$ T% C0 p* q1 x7 y7 f! q6 LCOMMAND "${QT_BIN_PATH}/windeployqt.exe"
--verbose 1
#--release # uncomment this line if built with Release
6 I" Z" b5 Q, {. g' |9 V#--no-svg
& T% j) F4 H6 V" Z( W/ S4 Q4 B#--no-angle
#--no-opengl
#--no-opengl-sw
#--no-compiler-runtime
#--no-system-d3d-compiler
- S6 I1 E5 k0 u' ]+ Y\"$\"
6 O8 e2 R5 W+ Y6 B0 u  V. a& KCOMMENT "Deploying Qt libraries using windeployqt for compilation target '${target}' ..."
)
endfunction()
' p6 J( K( d# i+ t& P( C  lif (WIN32)
  windeployqt(${PROJECT_NAME})
endif()最后，转换成VS项目时，默认是Console项目，运行时会有cmd窗口。一个解决办法是在生成可执行文件时设置目标为 WIN32：
add_executable(${PROJECT_NAME} WIN32 xxxx)
6 i1 j" t/ g* S6 A3 \" I( y5 p- q4 l' b 一个完整的Qt 5项目CMakeLists.txt返回目录以下是一个适用于Windows平台的Qt 5项目完整CMakeLists.txt，实际使用时请替换名字和Qt 5安装路径等：
cmake_minimum_required(VERSION 3.7)
, {% e% Q9 E# q% h4 H3 L" O# \# 请将myproject改成实际的应用名字
  O" K  a4 F1 r7 Dproject(myproject LANGUAGES CXX)
/ u8 J6 [/ K# @6 C' l  M" eset(CMAKE_INCLUDE_CURRENT_DIR ON)
) G3 _$ `$ Z+ c# 请更改为实际的Qt安装目录
/ R  t- n% r" r5 eset(QT_MSVC_PATH "C:\\Qt\\Qt5.12.8\\5.12.8\\msvc2017_64")
set(CMAKE_PREFIX_PATH "${QT_MSVC_PATH}/lib/cmake")
set(QT_BIN_PATH "${QT_MSVC_PATH}/bin")
set(CMAKE_AUTOUIC ON)
( j8 k+ b9 B! ~( ?9 ]; O3 pset(CMAKE_AUTOMOC ON)
set(CMAKE_AUTORCC ON)
set(CMAKE_CXX_STANDARD 11)
$ y* O$ {8 w" iset(CMAKE_CXX_STANDARD_REQUIRED ON)
& p" K8 c2 _4 c, T: Cfind_package(Qt5 COMPONENTS Widgets REQUIRED)
# 默认Release构建
8 [9 q! S% u$ O5 |/ fif (NOT CMAKE_BUILD_TYPE)
6 D2 m. Q7 O) A+ n6 u    set( CMAKE_BUILD_TYPE "Release" )
9 m. E5 [; C1 O% V8 x' Q1 Mendif()
) k/ w8 y7 ^" e- P5 ~/ Emessage("build type: ${CMAKE_BUILD_TYPE}")
# 按照自己的项目结构添加文件
# 也可使用file/aux_source_directory批量引入，注意不要引入自动生成的文件！
' U" h% p) |( N" s1 padd_executable(${PROJECT_NAME} WIN32
  main.cpp
5 t* ]1 g  j* H' z" D3 J9 h  mainwindow.cpp
  mainwindow.h
)
target_link_libraries(${PROJECT_NAME} PRIVATE Qt5::Widgets)
function(windeployqt target)
# POST_BUILD step
add_custom_command(TARGET ${target} POST_BUILD
COMMAND "${QT_BIN_PATH}/windeployqt.exe"
--verbose 1
#--release
+ j2 ^( s: t& f3 M0 g; }/ z#--no-svg
#--no-angle
1 |. n: Z, L/ @0 ?#--no-opengl
#--no-opengl-sw
#--no-compiler-runtime
#--no-system-d3d-compiler
\"$\"
COMMENT "Deploying Qt libraries using windeployqt for compilation target '${target}' ..."
, l8 q1 T& l  `- W6 B! M, J)
6 ?; Q" L' b0 z% S  g# @) Rendfunction()
if (WIN32)
0 k0 _* c/ k: P+ h4 i/ ~  windeployqt(${PROJECT_NAME})
* o, {( t0 e! c) l( x% e) j: Qendif()
; A: v' u( x; A; v+ ^& F: l& [6 r4 \````通过上面的配置，我们的Qt项目既可在Qt Creator中正常编译运行，也可在CLion/Visual Studio中正常编译运行而 无需安装Qt插件。
参考返回目录1. CMake官网
( q4 E+ L( D2 I( a2. CMake教程
3. CMake FAQ
4. CMake指定编译器
AD：【国外VPS推荐】 搬瓦工三网回程CN2 GIA VPS，季付46.87$打赏赞(3)