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

[db:作者]

本文目录

CMake简介

CMake命令

CMake常见指令

常用环境变量

Qt应用示例

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

参考CMake是一个跨平台、开源的构建工具，在C/C++项目中有广泛应用。本文首先介绍CMake及常用指令，并结合工作时需要用到的Qt 5，给出一个完整的CMake项目配置。
/ Z6 p% x  p2 |7 a7 ?  T 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即可工作。
8 s. n4 z) W* a! R+ D, k$ j7 C值得一提的是，CMake由Kitware公司开发和维护，VTK和ParaView等知名开源产品均出自该公司。从这方面看，CMake也算出身名门，因此能很快流行开来。
& b3 n# g" @  J CMake命令返回目录CMake基于CMakeLists.txt文件来生成对应目标(generator)的构建文件，一个标准的CMake项目构建操作为(命令行方式)：
cd PROJECT_DIR
/ {5 q# R' y8 F& u! @cmake
7 v8 G; U* G% l2 X$ [7 Nmake TARGET或者使用用CMake GUI：

: H4 ~9 a0 S7 ?2 q
+ z" [! D, v6 g6 i# g; MCMake-GUI操作示意图然后使用VS打开生成的.sln项目，即可编译、运行和调试项目。
3 }0 R/ j. I6 b1 r6 @Linux/Unix/MacOS平台上，CMake默认生成标准的makefile；Windows平台上则会检测Visual Studio版本，生成对应的VS .sln项目工程文件(在MSYS/Cygwin/WSL环境下执行除外)。可以使用 -G 选项切换生成目标，例如生成Ninja构建文件：
  F7 Y3 s3 e9 Ucmake . -G Ninja
ninja TARGETCMake一个非常棒的特性是“外部构建”(out-of-source build)，即支持在源码目录外构建。由于这个特性，以及CMake生成的makefile没有clean命令，一般来说都推荐在单独的build目录中构建：
9 p( u3 B" H' `& r7 N% P! Dmkdir -p build
cd $_
cmake ..
) H8 G4 ^) ?3 r" j# z% Y3 Hmake TARGET -j4如果使用CMake GUI，Browse Build时请选择单独的构建目录。
命令行方式下编译Debug/Release版本、传递C++编译参数，请使用 -D 选项，例如：
4 e3 g" S7 V$ e6 |2 Fcmake .. -DCMAKE_BUILD_TYPE=Release
  S5 `' k4 F# e3 J0 n  zmake TARGET -j4一些内置的宏定义参数可参考下文的环境变量。
. ~! e9 A0 L% c如果是生成VS项目，则只需在VS中选择构建版本、设置编译和链接参数即可。
CMake常见指令返回目录CMake基于CMakeLists.txt文件生成项目构建文件，因此编写CMakeLists.txt文件是CMake项目的核心。本小节介绍一些用在CMakeLists.txt文件中的常用指令。
CMakeLists.txt 使用  # 作为注释，# 所在行后续字符均作为注释被忽略

cmake_minimum_required一般这条指令出现在文件的最前面，用来指定项目支持的最低版本。对于Qt 5项目，建议为：cmake_minimum_required(VERSION 3.7)。
5 Y8 m5 R# K7 A) ?) H: M( r9 S

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

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

if…else[if]…endif条件控制语句，注意指令后的括号不可省略：
if (WIN32)
xxxx
# {6 |; h( p+ S8 Z) pelse() # 括号不可省略
$ C5 P2 ]  `2 ^0 k+ @, J/ Xxxxx
endif()

find_package查找指定模块，例如OpenMP。Qt 5项目一般需要：find_package(Qt5 COMPONENTS Widgets REQUIRED)。
% I. d+ p. J, x) S, z% _, f

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

link_directories设置链接库的路径，更推荐的指令是 target_link_directories，理由见 include_directories。
$ T% q5 W' T! g

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查找指定库的路径并保存到变量中。
# y2 _: C* M' C  h

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

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

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

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

message可在cmake构建时输出信息。
0 T/ q1 q2 V2 hCMakeLists.txt文件中指令不区分大小写，但一般来说同一个文件中指令应保持大小写风格一致。
更多指令可参考 CMake官方文档。
  k2 t& K& L9 D  t8 Y8 Q" L 常用环境变量返回目录本小节介绍几个常用的环境变量(编译宏)。
5 b& T9 X" U: e$ n4 h( _0 Q

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是否安装及其安装路径。
解决办法便是在 project 指令后增加如下指令告知Qt的安装位置：
# V5 S" u- l5 f# 具体路径请根据自身情况替换
" w; O5 R: E. [9 R0 t8 oset(QT_MSVC_PATH "C:\\Qt\\Qt5.12.8\\5.12.8\\msvc2017_64")
2 p+ }+ O- x. z. J$ m6 ^3 A$ i! o6 mset(CMAKE_PREFIX_PATH "${QT_MSVC_PATH}/lib/cmake")
然后再次运行 cmake 指令或者使用CMake GUI重新运行，构建文件夹下便能正常生成.sln项目文件。
  n- F3 N- f- u% Z  DVS中编译好后，运行时会提示无法找到Qt相关的dll导致程序不能正常运行。解决办法包括：
5 j7 A) m- R" |+ P1. 设置VS选项，将Qt的dll路径包含进去；
2. 将Qt相关dll拷贝到编译输出文件夹；
& Z- K# \. }7 c4 g, y 3. 设置CMake，使其能自动复制所需要的dll。
8 W7 Y' B! H7 [% Y这里介绍第三种方式，原理是借助Qt自带的windeployqt.exe程序自动部署程序所需dll到目标文件夹。具体操作为，在项目根目录的CMakeLists.txt最后添加部署dll的指令：
  i8 _6 m# ]0 k* yset(QT_BIN_PATH "${QT_MSVC_PATH}/bin")
function(windeployqt target)
$ P6 [6 \, a5 V' J9 W( o' o% Z1 Q' }# POST_BUILD step
7 l& Z" {. ^2 l! ~3 g, [# - after build, we have a bin/lib for analyzing qt dependencies
# - we run windeployqt on target and deploy Qt libs
' z9 y* {8 p3 _$ }, K! M1 Dadd_custom_command(TARGET ${target} POST_BUILD
/ t+ e: Z6 F  y/ A% P! h3 KCOMMAND "${QT_BIN_PATH}/windeployqt.exe"
--verbose 1
" j) q" x5 f$ ?# c* J, |#--release # uncomment this line if built with Release
#--no-svg
#--no-angle
#--no-opengl
3 v! [( a% j1 e#--no-opengl-sw
9 h" [3 T( M9 i2 Q  B* v/ }: c  ]8 R#--no-compiler-runtime
  \% F4 j2 S* F5 K: o#--no-system-d3d-compiler
0 m9 {0 M$ }9 R( T3 p\"$\"
COMMENT "Deploying Qt libraries using windeployqt for compilation target '${target}' ..."
)
endfunction()
* e. f; h5 X2 N- C' rif (WIN32)
  windeployqt(${PROJECT_NAME})
/ q+ T1 ~* b0 O( B; S0 }% Xendif()最后，转换成VS项目时，默认是Console项目，运行时会有cmd窗口。一个解决办法是在生成可执行文件时设置目标为 WIN32：
0 s' ?0 ^" i+ T1 \8 Y, L; |3 ?add_executable(${PROJECT_NAME} WIN32 xxxx)
一个完整的Qt 5项目CMakeLists.txt返回目录以下是一个适用于Windows平台的Qt 5项目完整CMakeLists.txt，实际使用时请替换名字和Qt 5安装路径等：
cmake_minimum_required(VERSION 3.7)
6 k8 U+ b0 v6 _( S, t# u$ x# 请将myproject改成实际的应用名字
project(myproject LANGUAGES CXX)
- }  m0 R% |$ T, H7 |7 Dset(CMAKE_INCLUDE_CURRENT_DIR ON)
. ^' G! E8 n: v# U# 请更改为实际的Qt安装目录
- ]" @8 k/ B4 j( \  sset(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)
; J2 ]; h. @4 {8 q4 m# xset(CMAKE_AUTORCC ON)
set(CMAKE_CXX_STANDARD 11)
set(CMAKE_CXX_STANDARD_REQUIRED ON)
: `& z7 |0 z/ h0 Rfind_package(Qt5 COMPONENTS Widgets REQUIRED)
6 z- d: S% k$ y% K3 x6 D' _# 默认Release构建
  l# ~8 T4 J! n0 w7 Nif (NOT CMAKE_BUILD_TYPE)
! j4 `* _+ g2 [& F$ o+ e3 ^    set( CMAKE_BUILD_TYPE "Release" )
endif()
) |1 m) V: i; X7 d8 |( u9 k  }message("build type: ${CMAKE_BUILD_TYPE}")
# 按照自己的项目结构添加文件
# 也可使用file/aux_source_directory批量引入，注意不要引入自动生成的文件！
7 @+ N1 K/ l5 i2 \1 X2 [add_executable(${PROJECT_NAME} WIN32
  main.cpp
7 Z$ Q" u: [9 Q0 D' Q& m' i  mainwindow.cpp
  mainwindow.h
( U/ k9 _* v) U# ?+ k5 ])
( j2 T; F0 h6 ?8 u7 Ytarget_link_libraries(${PROJECT_NAME} PRIVATE Qt5::Widgets)
function(windeployqt target)
0 _7 o, H6 l4 H+ B# POST_BUILD step
add_custom_command(TARGET ${target} POST_BUILD
COMMAND "${QT_BIN_PATH}/windeployqt.exe"
6 M5 E( y; P' D& K--verbose 1
7 Z1 {) L8 C1 h, H3 E#--release
: G3 L& J% @) Z7 i9 Y; a2 ?" q#--no-svg
+ v% K, w# L+ W0 N" P8 x' g. |( \#--no-angle
#--no-opengl
#--no-opengl-sw
#--no-compiler-runtime
! L4 ?  q* \" F5 C, t#--no-system-d3d-compiler
0 D% E3 `! h" G4 b# f6 F* ~& y- G\"$\"
COMMENT "Deploying Qt libraries using windeployqt for compilation target '${target}' ..."
  P0 W7 k- S: f)
endfunction()
if (WIN32)
  windeployqt(${PROJECT_NAME})
9 m! s# H  C1 _5 C- _2 @( Vendif()
) {% v  f7 a4 H2 _0 B````通过上面的配置，我们的Qt项目既可在Qt Creator中正常编译运行，也可在CLion/Visual Studio中正常编译运行而 无需安装Qt插件。
参考返回目录1. CMake官网
2. CMake教程
3. CMake FAQ
4. CMake指定编译器
AD：【国外VPS推荐】 搬瓦工三网回程CN2 GIA VPS，季付46.87$打赏赞(3)