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

[db:作者]

本文目录

CMake简介

CMake命令

CMake常见指令

常用环境变量

Qt应用示例

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

参考CMake是一个跨平台、开源的构建工具，在C/C++项目中有广泛应用。本文首先介绍CMake及常用指令，并结合工作时需要用到的Qt 5，给出一个完整的CMake项目配置。
4 S& q% K7 ?5 |; v) l 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即可工作。
! [( o) ?' Q' t  Y值得一提的是，CMake由Kitware公司开发和维护，VTK和ParaView等知名开源产品均出自该公司。从这方面看，CMake也算出身名门，因此能很快流行开来。
5 l: a5 s9 X' j8 v8 T, y$ q CMake命令返回目录CMake基于CMakeLists.txt文件来生成对应目标(generator)的构建文件，一个标准的CMake项目构建操作为(命令行方式)：
2 Z0 X( ]1 C8 b' d; d1 s; ]" ~8 @cd PROJECT_DIR
; w9 {/ E) }# ?cmake
) w. U8 l( @3 Z/ y( B# }make TARGET或者使用用CMake GUI：
1 B1 _! [+ ]& D+ P1 ^; g
$ b' G$ }. t- @0 ]
1 e8 I6 C* i6 P% H0 h; @CMake-GUI操作示意图然后使用VS打开生成的.sln项目，即可编译、运行和调试项目。
1 [1 V6 M! G4 {) C0 @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目录中构建：
5 X! O1 L# ~7 `; Dmkdir -p build
cd $_
6 Z( C# l/ `* W: ~; _* k1 Rcmake ..
+ ]/ M6 p% S. ]* C; ]/ w+ u. W$ lmake TARGET -j4如果使用CMake GUI，Browse Build时请选择单独的构建目录。
! K- u7 T5 t, @, I命令行方式下编译Debug/Release版本、传递C++编译参数，请使用 -D 选项，例如：
cmake .. -DCMAKE_BUILD_TYPE=Release
4 b: U/ I2 H4 kmake TARGET -j4一些内置的宏定义参数可参考下文的环境变量。
! ?. e; q: N1 A如果是生成VS项目，则只需在VS中选择构建版本、设置编译和链接参数即可。
3 d+ w: C1 [, X+ P# ]* x7 q/ B CMake常见指令返回目录CMake基于CMakeLists.txt文件生成项目构建文件，因此编写CMakeLists.txt文件是CMake项目的核心。本小节介绍一些用在CMakeLists.txt文件中的常用指令。
# b5 K& @& B2 c9 w3 |CMakeLists.txt 使用  # 作为注释，# 所在行后续字符均作为注释被忽略

cmake_minimum_required一般这条指令出现在文件的最前面，用来指定项目支持的最低版本。对于Qt 5项目，建议为：cmake_minimum_required(VERSION 3.7)。
2 r. Y7 b, s" }* ]) g

project指定项目名称及属性。C/C++项目的建议值为：project(项目名称 C CXX)。
) L% \0 F- ?$ X: E6 ]/ Y8 i

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

if…else[if]…endif条件控制语句，注意指令后的括号不可省略：
if (WIN32)
* y; `. I' Z' o5 s5 d# {0 I* }+ Exxxx
else() # 括号不可省略
xxxx
endif()
+ T% N3 H2 w+ h! Q  [

find_package查找指定模块，例如OpenMP。Qt 5项目一般需要：find_package(Qt5 COMPONENTS Widgets REQUIRED)。
8 c1 t  @- d: N

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

link_directories设置链接库的路径，更推荐的指令是 target_link_directories，理由见 include_directories。
; z! y* R- M- V5 O) p& ~

aux_source_directory将指定目录下的源文件添加到变量中，例如：aux_source_directory(./src SRC)。注意该命令不会递归包含子目录源文件。
% G* F& n8 e7 \$ L! e

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

find_library查找指定库的路径并保存到变量中。
( v# ^; B: Z# W9 ^3 R

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

add_subdirectory添加一个需要构建的子目录，子目录下有CMakeLists.txt文件设定好构建规则。
& U* P  t8 v  {3 z5 j# [

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

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

message可在cmake构建时输出信息。
8 i. T& r" p; i9 S% `CMakeLists.txt文件中指令不区分大小写，但一般来说同一个文件中指令应保持大小写风格一致。
更多指令可参考 CMake官方文档。
常用环境变量返回目录本小节介绍几个常用的环境变量(编译宏)。
' d0 S3 Z6 b3 b7 @

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用不到，可删除)。
但需要注意的是，此时Qt Creator中编译项目是没问题的，但是在CLion/VS Code中打开，或者生成Visual Studio用的.sln文件会有问题，因为CMake无法检测到Qt是否安装及其安装路径。
% T3 m/ {. \6 Q7 R* ]# t0 M解决办法便是在 project 指令后增加如下指令告知Qt的安装位置：
# 具体路径请根据自身情况替换
set(QT_MSVC_PATH "C:\\Qt\\Qt5.12.8\\5.12.8\\msvc2017_64")
set(CMAKE_PREFIX_PATH "${QT_MSVC_PATH}/lib/cmake")
* H( M0 O1 Y) `$ @. g2 w) x然后再次运行 cmake 指令或者使用CMake GUI重新运行，构建文件夹下便能正常生成.sln项目文件。
, B3 @  Q8 J6 C9 m- d5 z  `VS中编译好后，运行时会提示无法找到Qt相关的dll导致程序不能正常运行。解决办法包括：
# l; t5 f) k. b- x1. 设置VS选项，将Qt的dll路径包含进去；
2. 将Qt相关dll拷贝到编译输出文件夹；
3. 设置CMake，使其能自动复制所需要的dll。
. o7 d" T& ^" M8 X: A  Q7 W这里介绍第三种方式，原理是借助Qt自带的windeployqt.exe程序自动部署程序所需dll到目标文件夹。具体操作为，在项目根目录的CMakeLists.txt最后添加部署dll的指令：
set(QT_BIN_PATH "${QT_MSVC_PATH}/bin")
' J! g& W; |% j2 s* N3 J  Ofunction(windeployqt target)
+ v5 P4 y, K4 ]# POST_BUILD step
# - after build, we have a bin/lib for analyzing qt dependencies
# - we run windeployqt on target and deploy Qt libs
add_custom_command(TARGET ${target} POST_BUILD
COMMAND "${QT_BIN_PATH}/windeployqt.exe"
. r/ u2 k8 q/ S8 x! t  h* ^--verbose 1
#--release # uncomment this line if built with Release
#--no-svg
#--no-angle
! ?2 `* z' i% |5 m0 k6 T% ^#--no-opengl
#--no-opengl-sw
5 w: m& x& Q7 o& v#--no-compiler-runtime
, P: f2 Q" J4 M#--no-system-d3d-compiler
( ~; Y! E2 y6 q: R" X5 E4 D5 v\"$\"
8 N! I& `/ O" _! OCOMMENT "Deploying Qt libraries using windeployqt for compilation target '${target}' ..."
)
# Z8 Z* I1 C9 }* O$ s! {endfunction()
if (WIN32)
$ K+ l. q. T( ]  s& n  windeployqt(${PROJECT_NAME})
endif()最后，转换成VS项目时，默认是Console项目，运行时会有cmd窗口。一个解决办法是在生成可执行文件时设置目标为 WIN32：
6 c. C8 |/ s5 p8 ]* hadd_executable(${PROJECT_NAME} WIN32 xxxx)
一个完整的Qt 5项目CMakeLists.txt返回目录以下是一个适用于Windows平台的Qt 5项目完整CMakeLists.txt，实际使用时请替换名字和Qt 5安装路径等：
cmake_minimum_required(VERSION 3.7)
# 请将myproject改成实际的应用名字
project(myproject LANGUAGES CXX)
set(CMAKE_INCLUDE_CURRENT_DIR ON)
# 请更改为实际的Qt安装目录
# M3 h" S7 j7 Aset(QT_MSVC_PATH "C:\\Qt\\Qt5.12.8\\5.12.8\\msvc2017_64")
set(CMAKE_PREFIX_PATH "${QT_MSVC_PATH}/lib/cmake")
2 z, y+ @2 @/ Sset(QT_BIN_PATH "${QT_MSVC_PATH}/bin")
: n* Q, i8 I% w! Z$ ^' |0 \$ J( j  fset(CMAKE_AUTOUIC ON)
set(CMAKE_AUTOMOC ON)
  W+ ?8 c2 m& B# Y; Vset(CMAKE_AUTORCC ON)
$ @* J# j) r/ ^set(CMAKE_CXX_STANDARD 11)
6 ?3 w9 t0 ~) X# r0 a3 r3 A* @3 w4 Kset(CMAKE_CXX_STANDARD_REQUIRED ON)
# U) g: a; F$ ofind_package(Qt5 COMPONENTS Widgets REQUIRED)
# 默认Release构建
if (NOT CMAKE_BUILD_TYPE)
    set( CMAKE_BUILD_TYPE "Release" )
endif()
; Y3 s0 ~  B8 R( e# smessage("build type: ${CMAKE_BUILD_TYPE}")
# 按照自己的项目结构添加文件
# 也可使用file/aux_source_directory批量引入，注意不要引入自动生成的文件！
" ?% X) M. Z* ^* q, L0 {add_executable(${PROJECT_NAME} WIN32
  main.cpp
2 C+ X8 S1 N/ d2 C* _- [9 j  mainwindow.cpp
+ B6 `0 D1 U$ {  mainwindow.h
9 p- m( h# C* ]2 w* s0 P)
target_link_libraries(${PROJECT_NAME} PRIVATE Qt5::Widgets)
function(windeployqt target)
# POST_BUILD step
6 M' f8 e: W; w4 v% g. L0 padd_custom_command(TARGET ${target} POST_BUILD
# \: R" A* x+ BCOMMAND "${QT_BIN_PATH}/windeployqt.exe"
4 G0 t$ a7 S4 x2 b--verbose 1
#--release
+ X# Y, Z0 w" o. a1 x: C5 p#--no-svg
#--no-angle
#--no-opengl
( z0 s; f$ |6 @0 o1 K0 T#--no-opengl-sw
#--no-compiler-runtime
7 u! h+ j3 j/ p#--no-system-d3d-compiler
8 ^6 B  Y" K/ |- v1 f\"$\"
COMMENT "Deploying Qt libraries using windeployqt for compilation target '${target}' ..."
8 x6 W5 |; ^3 m. H3 m5 m7 U)
) X  v8 s, n+ A; l: {" O; k4 E: @endfunction()
if (WIN32)
/ A# a0 {; F: B2 B/ [  windeployqt(${PROJECT_NAME})
endif()
2 f& L* c7 l8 w0 k; U````通过上面的配置，我们的Qt项目既可在Qt Creator中正常编译运行，也可在CLion/Visual Studio中正常编译运行而 无需安装Qt插件。
3 f9 ~) Z; T# M 参考返回目录1. CMake官网
2. CMake教程
3. CMake FAQ
4 k# j& [# s7 N: d4. CMake指定编译器
( K8 k3 I: i$ ?" _0 E& jAD：【国外VPS推荐】 搬瓦工三网回程CN2 GIA VPS，季付46.87$打赏赞(3)