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项目构建操作为(命令行方式)：
3 `& A% s# r/ [$ Fcd PROJECT_DIR
2 T" R6 Y/ ^, N) S& e: r* Xcmake
make TARGET或者使用用CMake GUI：


% ?# M1 S; s  p' ICMake-GUI操作示意图然后使用VS打开生成的.sln项目，即可编译、运行和调试项目。
, x' ^, ?1 }" m; n6 U5 M: ZLinux/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目录中构建：
& M- J7 m& y9 d! {, p% omkdir -p build
- q+ o7 r% x; \8 N) Jcd $_
; {( W* c% {& a, {: Hcmake ..
make TARGET -j4如果使用CMake GUI，Browse Build时请选择单独的构建目录。
命令行方式下编译Debug/Release版本、传递C++编译参数，请使用 -D 选项，例如：
4 @* R/ Z9 m9 ?cmake .. -DCMAKE_BUILD_TYPE=Release
& h3 f/ z, H3 C# q) K, hmake TARGET -j4一些内置的宏定义参数可参考下文的环境变量。
如果是生成VS项目，则只需在VS中选择构建版本、设置编译和链接参数即可。
CMake常见指令返回目录CMake基于CMakeLists.txt文件生成项目构建文件，因此编写CMakeLists.txt文件是CMake项目的核心。本小节介绍一些用在CMakeLists.txt文件中的常用指令。
CMakeLists.txt 使用  # 作为注释，# 所在行后续字符均作为注释被忽略
) q+ c' \( O% H/ `. c/ k

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

project指定项目名称及属性。C/C++项目的建议值为：project(项目名称 C CXX)。
, B' e( u- z) `. Q& _" T. L' k) @

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

if…else[if]…endif条件控制语句，注意指令后的括号不可省略：
1 y; [& w: X5 j- p5 q4 yif (WIN32)
xxxx
else() # 括号不可省略
6 M& P. {- ?9 X) k) i; U; u, Pxxxx
endif()

find_package查找指定模块，例如OpenMP。Qt 5项目一般需要：find_package(Qt5 COMPONENTS Widgets REQUIRED)。
. w# q, T& t: }7 e. O

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

link_directories设置链接库的路径，更推荐的指令是 target_link_directories，理由见 include_directories。
) O3 h  V4 T$ q

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缓存才能被应用到项目中。
+ n8 D" Y# ]. Q1 L' J0 s

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

add_custom_command添加自定义命令，可用于构建前进行moc，构建后拷贝文件等用途。
8 ~8 U9 q  c# y; p  C6 A0 s* [6 t

add_subdirectory添加一个需要构建的子目录，子目录下有CMakeLists.txt文件设定好构建规则。
- X! l: C0 Y9 \4 h. {

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

add_library构建动态或静态库，一般存在于子目录或者库的CMakeLists.txt文件中。
7 \" j4 v' Z0 O

message可在cmake构建时输出信息。
CMakeLists.txt文件中指令不区分大小写，但一般来说同一个文件中指令应保持大小写风格一致。
8 M7 x( F  E2 k, p更多指令可参考 CMake官方文档。
常用环境变量返回目录本小节介绍几个常用的环境变量(编译宏)。
: m* Y# ~1 S/ f0 F3 n

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的使用方式。
8 w# v7 y- |& U8 b4 ~6 S4 m2 f新建Qt项目时，可以选择CMake作为构建工具：
: x3 S, R, y+ S3 ~. e5 K
; y5 x* I5 Q5 G
* o& i5 _! p- q6 n% xQt新建项目使用CMake生成项目后，项目文件夹将出现CMakeLists.txt和CMakeLists.txt.user两个文件，熟悉的.pro文件没有了(CMakeLists.txt.user充当了Qt Creator工程文件的角色，其他IDE用不到，可删除)。
9 h: N+ u1 ^; j" C( I8 Y  _! a但需要注意的是，此时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")
. w2 I$ @0 v- z/ e2 k# v# r- U) v. q- Eset(CMAKE_PREFIX_PATH "${QT_MSVC_PATH}/lib/cmake")
4 W2 O3 }6 j' `然后再次运行 cmake 指令或者使用CMake GUI重新运行，构建文件夹下便能正常生成.sln项目文件。
VS中编译好后，运行时会提示无法找到Qt相关的dll导致程序不能正常运行。解决办法包括：
1. 设置VS选项，将Qt的dll路径包含进去；
2. 将Qt相关dll拷贝到编译输出文件夹；
3. 设置CMake，使其能自动复制所需要的dll。
: [8 ?- ?8 n, E& g/ A) C这里介绍第三种方式，原理是借助Qt自带的windeployqt.exe程序自动部署程序所需dll到目标文件夹。具体操作为，在项目根目录的CMakeLists.txt最后添加部署dll的指令：
set(QT_BIN_PATH "${QT_MSVC_PATH}/bin")
* d% N. u( E, a( C9 yfunction(windeployqt target)
# POST_BUILD step
2 [7 s2 G" C, {: p4 p8 @# - after build, we have a bin/lib for analyzing qt dependencies
/ G7 n3 A; q" u9 z0 a# \* C  S# - we run windeployqt on target and deploy Qt libs
+ ]+ H8 @. [: Y& g- o" n7 C' Badd_custom_command(TARGET ${target} POST_BUILD
* H9 Q( z2 s6 q' Z; ]COMMAND "${QT_BIN_PATH}/windeployqt.exe"
--verbose 1
0 ?( y5 G- h' a; e#--release # uncomment this line if built with Release
2 k2 @  i$ N( ~9 O9 e8 Q#--no-svg
#--no-angle
% ^2 Z: u8 g$ M* t#--no-opengl
9 T. l/ |/ R8 }/ n#--no-opengl-sw
#--no-compiler-runtime
" ?# t5 Z# N/ U3 a#--no-system-d3d-compiler
' {5 p! z( a; b0 E  y9 a\"$\"
: w/ C# d4 L! Y) o' X3 U; @COMMENT "Deploying Qt libraries using windeployqt for compilation target '${target}' ..."
3 l; T9 i& a( p& T* F$ T: W)
endfunction()
, N! S3 W9 v1 r* Q" e7 I6 yif (WIN32)
( z% v/ l) I2 C0 u2 c2 e  windeployqt(${PROJECT_NAME})
& N& z! Q, W- Q) T" bendif()最后，转换成VS项目时，默认是Console项目，运行时会有cmd窗口。一个解决办法是在生成可执行文件时设置目标为 WIN32：
. C* I3 r! O3 A1 c9 H! d# Yadd_executable(${PROJECT_NAME} WIN32 xxxx)
! t7 {  A$ U$ W; P( J* E 一个完整的Qt 5项目CMakeLists.txt返回目录以下是一个适用于Windows平台的Qt 5项目完整CMakeLists.txt，实际使用时请替换名字和Qt 5安装路径等：
2 \% J# S/ i. D/ U5 dcmake_minimum_required(VERSION 3.7)
# 请将myproject改成实际的应用名字
/ a& s1 R1 |2 cproject(myproject LANGUAGES CXX)
& d& i5 v3 e- u# n' l" }set(CMAKE_INCLUDE_CURRENT_DIR ON)
# 请更改为实际的Qt安装目录
set(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)
set(CMAKE_AUTOMOC ON)
9 C- T  s" @+ H0 q; i) X; R% |set(CMAKE_AUTORCC ON)
) D3 m& t' o3 ]* rset(CMAKE_CXX_STANDARD 11)
set(CMAKE_CXX_STANDARD_REQUIRED ON)
( O5 z( I9 M/ ~- i9 n' _/ |0 O. kfind_package(Qt5 COMPONENTS Widgets REQUIRED)
# 默认Release构建
if (NOT CMAKE_BUILD_TYPE)
9 ^  s. J4 i; A& e: i2 ?( W( w    set( CMAKE_BUILD_TYPE "Release" )
2 z$ D$ S4 s, J$ h, Mendif()
message("build type: ${CMAKE_BUILD_TYPE}")
/ i# e5 Q) G& o: C0 H/ k" M# 按照自己的项目结构添加文件
- b7 x" l" Z7 Y- w# 也可使用file/aux_source_directory批量引入，注意不要引入自动生成的文件！
add_executable(${PROJECT_NAME} WIN32
  main.cpp
( D* l; D$ i1 K; y  mainwindow.cpp
- J, [4 u; k8 O! s  mainwindow.h
)
target_link_libraries(${PROJECT_NAME} PRIVATE Qt5::Widgets)
function(windeployqt target)
) ~) D9 G2 ]! g0 Z# POST_BUILD step
! o/ h  B/ [5 A  J4 D' l. R/ _( h5 Eadd_custom_command(TARGET ${target} POST_BUILD
COMMAND "${QT_BIN_PATH}/windeployqt.exe"
--verbose 1
#--release
+ i  q/ K! X; d#--no-svg
$ z$ L$ J$ Q- Q, a#--no-angle
- _  Q0 A, ^4 l, z! n#--no-opengl
5 f& K8 \% u. `( g#--no-opengl-sw
#--no-compiler-runtime
#--no-system-d3d-compiler
\"$\"
COMMENT "Deploying Qt libraries using windeployqt for compilation target '${target}' ..."
. d) n- A8 t% K' P7 y)
) }) ^7 v/ {* `: L; hendfunction()
if (WIN32)
" x" q2 U: p6 l  windeployqt(${PROJECT_NAME})
8 s0 J  S/ h" z. X+ M# tendif()
````通过上面的配置，我们的Qt项目既可在Qt Creator中正常编译运行，也可在CLion/Visual Studio中正常编译运行而 无需安装Qt插件。
参考返回目录1. CMake官网
2 I4 J: L. I; H- W4 U8 z9 T: @: B2. CMake教程
& }/ x: Y& y/ }8 K) P7 A9 [3. CMake FAQ
2 X4 `/ a/ P8 Q- N" c+ x0 K4. CMake指定编译器
! J0 b7 ]$ Y" c: K/ `* v7 rAD：【国外VPS推荐】 搬瓦工三网回程CN2 GIA VPS，季付46.87$打赏赞(3)