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

[db:作者]

本文目录

CMake简介

CMake命令

CMake常见指令

常用环境变量

Qt应用示例

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

参考CMake是一个跨平台、开源的构建工具，在C/C++项目中有广泛应用。本文首先介绍CMake及常用指令，并结合工作时需要用到的Qt 5，给出一个完整的CMake项目配置。
' u) n8 ~5 O4 }; q6 N1 w CMake简介返回目录CMake如其名”Cross-platform Make”，是一个 跨平台、开源 的构建工具。与make不同，CMake并不直接构建软件，而是生成用于构建的Makefile、.sln等工程文件，相当于高阶构建工具。
' V5 ?5 J: `7 z+ A5 d与另一构建工具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项目构建操作为(命令行方式)：
cd PROJECT_DIR
cmake
. F$ w! k: n' ymake TARGET或者使用用CMake GUI：
) R' X1 U" @( e- Q% j9 A  B

CMake-GUI操作示意图然后使用VS打开生成的.sln项目，即可编译、运行和调试项目。
* j! L: S1 |* W4 O5 }Linux/Unix/MacOS平台上，CMake默认生成标准的makefile；Windows平台上则会检测Visual Studio版本，生成对应的VS .sln项目工程文件(在MSYS/Cygwin/WSL环境下执行除外)。可以使用 -G 选项切换生成目标，例如生成Ninja构建文件：
8 m$ p+ c2 D* \. a% @! ^- Xcmake . -G Ninja
) y& ~% e( u; y6 H( m2 Z' gninja TARGETCMake一个非常棒的特性是“外部构建”(out-of-source build)，即支持在源码目录外构建。由于这个特性，以及CMake生成的makefile没有clean命令，一般来说都推荐在单独的build目录中构建：
4 S; t( D5 F1 ]* G" G% F9 I- qmkdir -p build
cd $_
* ?% d# t2 i; S3 Acmake ..
0 S& o3 i: f+ M5 ?0 p5 E2 B& bmake TARGET -j4如果使用CMake GUI，Browse Build时请选择单独的构建目录。
5 N0 b" R: k% y' J1 Y命令行方式下编译Debug/Release版本、传递C++编译参数，请使用 -D 选项，例如：
cmake .. -DCMAKE_BUILD_TYPE=Release
; ]6 f1 U5 k5 Z9 ]make TARGET -j4一些内置的宏定义参数可参考下文的环境变量。
6 T$ c0 u0 J; E2 L2 N0 {* G! H2 U如果是生成VS项目，则只需在VS中选择构建版本、设置编译和链接参数即可。
; S1 R. p4 A0 ]! _, t CMake常见指令返回目录CMake基于CMakeLists.txt文件生成项目构建文件，因此编写CMakeLists.txt文件是CMake项目的核心。本小节介绍一些用在CMakeLists.txt文件中的常用指令。
. A; N9 M* c2 ~% k$ A9 h/ MCMakeLists.txt 使用  # 作为注释，# 所在行后续字符均作为注释被忽略
: O! b7 f) O' l0 P

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

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

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

if…else[if]…endif条件控制语句，注意指令后的括号不可省略：
if (WIN32)
: Q  O" G1 q' s) p8 f: kxxxx
  G: }, g* s6 d/ x( Z: S1 zelse() # 括号不可省略
; F6 J' L' x  _) l3 Lxxxx
  d. p; {" b1 G6 x: z( Iendif()

find_package查找指定模块，例如OpenMP。Qt 5项目一般需要：find_package(Qt5 COMPONENTS Widgets REQUIRED)。
" K! j4 P8 Z5 b

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

link_directories设置链接库的路径，更推荐的指令是 target_link_directories，理由见 include_directories。
  [6 q5 c+ Y6 k5 x

aux_source_directory将指定目录下的源文件添加到变量中，例如：aux_source_directory(./src SRC)。注意该命令不会递归包含子目录源文件。
5 Y0 x% p9 q& D! `/ a

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

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

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

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

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

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

message可在cmake构建时输出信息。
CMakeLists.txt文件中指令不区分大小写，但一般来说同一个文件中指令应保持大小写风格一致。
更多指令可参考 CMake官方文档。
. I- M. r& P3 w5 v, S# y5 |7 D 常用环境变量返回目录本小节介绍几个常用的环境变量(编译宏)。

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

$ e( a: Y0 L5 l6 m  `
Qt新建项目使用CMake生成项目后，项目文件夹将出现CMakeLists.txt和CMakeLists.txt.user两个文件，熟悉的.pro文件没有了(CMakeLists.txt.user充当了Qt Creator工程文件的角色，其他IDE用不到，可删除)。
但需要注意的是，此时Qt Creator中编译项目是没问题的，但是在CLion/VS Code中打开，或者生成Visual Studio用的.sln文件会有问题，因为CMake无法检测到Qt是否安装及其安装路径。
: G5 ?  K# l; j6 i7 g$ C解决办法便是在 project 指令后增加如下指令告知Qt的安装位置：
# 具体路径请根据自身情况替换
& O8 C- j3 \9 W- Cset(QT_MSVC_PATH "C:\\Qt\\Qt5.12.8\\5.12.8\\msvc2017_64")
% ~  C  |3 L! f. `- |6 v8 Cset(CMAKE_PREFIX_PATH "${QT_MSVC_PATH}/lib/cmake")
然后再次运行 cmake 指令或者使用CMake GUI重新运行，构建文件夹下便能正常生成.sln项目文件。
4 {/ l; ^! \; }  LVS中编译好后，运行时会提示无法找到Qt相关的dll导致程序不能正常运行。解决办法包括：
1. 设置VS选项，将Qt的dll路径包含进去；
2. 将Qt相关dll拷贝到编译输出文件夹；
% S( x7 ~+ g7 C0 I% a 3. 设置CMake，使其能自动复制所需要的dll。
( }! n+ ]4 R7 `; `, [这里介绍第三种方式，原理是借助Qt自带的windeployqt.exe程序自动部署程序所需dll到目标文件夹。具体操作为，在项目根目录的CMakeLists.txt最后添加部署dll的指令：
( @: X& s6 Z6 {: G! Xset(QT_BIN_PATH "${QT_MSVC_PATH}/bin")
function(windeployqt target)
# POST_BUILD step
" L' B% A* C- U# m* t4 @# - after build, we have a bin/lib for analyzing qt dependencies
# - we run windeployqt on target and deploy Qt libs
  w7 K; x, M( u. Vadd_custom_command(TARGET ${target} POST_BUILD
COMMAND "${QT_BIN_PATH}/windeployqt.exe"
--verbose 1
7 j2 r7 k% y' n6 |#--release # uncomment this line if built with Release
#--no-svg
#--no-angle
  U7 I, \2 K, n" F% O#--no-opengl
" P. I: ]' ~6 [3 [& m#--no-opengl-sw
3 F! c" t) P' C! [3 }+ |#--no-compiler-runtime
. E' E- w/ x* c# ^! a; Z, W1 i#--no-system-d3d-compiler
\"$\"
COMMENT "Deploying Qt libraries using windeployqt for compilation target '${target}' ..."
$ T& K! v  q) w7 R5 S1 T6 z)
endfunction()
' D7 L/ e0 c# u+ Y* q: o3 A5 wif (WIN32)
. K  f1 t3 g) v7 q# v7 }" }; {* C  windeployqt(${PROJECT_NAME})
endif()最后，转换成VS项目时，默认是Console项目，运行时会有cmd窗口。一个解决办法是在生成可执行文件时设置目标为 WIN32：
add_executable(${PROJECT_NAME} WIN32 xxxx)
一个完整的Qt 5项目CMakeLists.txt返回目录以下是一个适用于Windows平台的Qt 5项目完整CMakeLists.txt，实际使用时请替换名字和Qt 5安装路径等：
  P+ v3 y+ }, Z; _. bcmake_minimum_required(VERSION 3.7)
5 H8 w, o' B- ~. r2 ^) p% z& h2 X# 请将myproject改成实际的应用名字
' ?5 L: A4 i$ @- n+ ~' ~project(myproject LANGUAGES CXX)
! n$ Q# @; c6 e3 M+ u; O1 {4 @set(CMAKE_INCLUDE_CURRENT_DIR ON)
# 请更改为实际的Qt安装目录
/ n7 X- J- g# O& K) q* ~% }1 ^  cset(QT_MSVC_PATH "C:\\Qt\\Qt5.12.8\\5.12.8\\msvc2017_64")
set(CMAKE_PREFIX_PATH "${QT_MSVC_PATH}/lib/cmake")
1 u! Y* G  y# z( [4 qset(QT_BIN_PATH "${QT_MSVC_PATH}/bin")
set(CMAKE_AUTOUIC ON)
set(CMAKE_AUTOMOC ON)
# T$ m/ @" a% O/ bset(CMAKE_AUTORCC ON)
set(CMAKE_CXX_STANDARD 11)
set(CMAKE_CXX_STANDARD_REQUIRED ON)
# o/ E. ]) a: c  c) h. ~8 o. ufind_package(Qt5 COMPONENTS Widgets REQUIRED)
# 默认Release构建
if (NOT CMAKE_BUILD_TYPE)
% }* b- z9 A: {; C    set( CMAKE_BUILD_TYPE "Release" )
5 W+ y' ~5 ?8 W5 Mendif()
2 \% i( _9 P: z. j: c, y0 Emessage("build type: ${CMAKE_BUILD_TYPE}")
# 按照自己的项目结构添加文件
# 也可使用file/aux_source_directory批量引入，注意不要引入自动生成的文件！
add_executable(${PROJECT_NAME} WIN32
4 K6 {; ^$ r* Z3 V# w* B1 I  main.cpp
  mainwindow.cpp
7 Q/ J* j* B4 j7 I* W  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"
% s& s, v( s; \1 I' @+ |. Q--verbose 1
! X' }; @6 L  V( L! R; R& T#--release
#--no-svg
#--no-angle
#--no-opengl
% t6 Z' |2 B0 C#--no-opengl-sw
#--no-compiler-runtime
#--no-system-d3d-compiler
' D. W" k& J4 g4 c, E\"$\"
" T/ ^. ?; g& @4 Z7 M" ]0 tCOMMENT "Deploying Qt libraries using windeployqt for compilation target '${target}' ..."
6 K' e) F0 Z+ k; h% |0 d5 a)
endfunction()
if (WIN32)
  windeployqt(${PROJECT_NAME})
$ v0 r8 {  M  F8 P$ t+ |% Hendif()
````通过上面的配置，我们的Qt项目既可在Qt Creator中正常编译运行，也可在CLion/Visual Studio中正常编译运行而 无需安装Qt插件。
参考返回目录1. CMake官网
) p) j8 D- Z+ x- x' U( O" k+ _2. CMake教程
) n3 h, a5 K6 ~& t; U2 e4 g/ ^$ \3. CMake FAQ
/ j; Q  A  T; _" A) ^$ C1 W3 `4. CMake指定编译器
AD：【国外VPS推荐】 搬瓦工三网回程CN2 GIA VPS，季付46.87$打赏赞(3)