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等工程文件，相当于高阶构建工具。
# D+ W6 d# [, F2 s! n3 s5 x2 o" F与另一构建工具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项目构建操作为(命令行方式)：
6 \) y+ n- C1 E. Y& \" e' Dcd PROJECT_DIR
cmake
make TARGET或者使用用CMake GUI：
8 A) J% f) ^5 m& t  _3 r
9 E/ S0 |6 H5 j" `0 m  {
; X6 X5 K8 \  G  {+ U' f9 W1 k; sCMake-GUI操作示意图然后使用VS打开生成的.sln项目，即可编译、运行和调试项目。
7 \8 |- u7 Y! W2 pLinux/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目录中构建：
mkdir -p build
% {8 Y! S) d8 Y* Pcd $_
cmake ..
make TARGET -j4如果使用CMake GUI，Browse Build时请选择单独的构建目录。
命令行方式下编译Debug/Release版本、传递C++编译参数，请使用 -D 选项，例如：
cmake .. -DCMAKE_BUILD_TYPE=Release
make TARGET -j4一些内置的宏定义参数可参考下文的环境变量。
' }: ]) U* S* k% v+ f& ]如果是生成VS项目，则只需在VS中选择构建版本、设置编译和链接参数即可。
* R/ U( b- Q. p! C$ f CMake常见指令返回目录CMake基于CMakeLists.txt文件生成项目构建文件，因此编写CMakeLists.txt文件是CMake项目的核心。本小节介绍一些用在CMakeLists.txt文件中的常用指令。
' u4 I7 R* E0 z/ wCMakeLists.txt 使用  # 作为注释，# 所在行后续字符均作为注释被忽略
$ o- X! {& q) Q8 r

cmake_minimum_required一般这条指令出现在文件的最前面，用来指定项目支持的最低版本。对于Qt 5项目，建议为：cmake_minimum_required(VERSION 3.7)。
0 A+ s  R. o; ?

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

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

if…else[if]…endif条件控制语句，注意指令后的括号不可省略：
if (WIN32)
xxxx
else() # 括号不可省略
xxxx
endif()
9 A" {8 B7 d$ p5 P- i

find_package查找指定模块，例如OpenMP。Qt 5项目一般需要：find_package(Qt5 COMPONENTS Widgets REQUIRED)。
+ G% a" k9 b" a5 Y

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

link_directories设置链接库的路径，更推荐的指令是 target_link_directories，理由见 include_directories。
' y' V) t1 q" I# z+ Y1 k

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缓存才能被应用到项目中。
' }' U' Z& `2 h9 T/ p# F" [

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

add_custom_command添加自定义命令，可用于构建前进行moc，构建后拷贝文件等用途。
5 `# G, w5 W; z

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

add_executable构建可执行程序，一般项目的主CMakeLists.txt中会有这条指令。
2 P; u+ h# b1 r9 h* H

add_library构建动态或静态库，一般存在于子目录或者库的CMakeLists.txt文件中。
4 M$ w$ W5 H  j1 F7 n

message可在cmake构建时输出信息。
$ _. [  o  M+ w. x2 I1 YCMakeLists.txt文件中指令不区分大小写，但一般来说同一个文件中指令应保持大小写风格一致。
更多指令可参考 CMake官方文档。
+ p( Y1 F9 H4 ~& O 常用环境变量返回目录本小节介绍几个常用的环境变量(编译宏)。

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


1 [; `  ^, |3 }( k' O" mQt新建项目使用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的安装位置：
# 具体路径请根据自身情况替换
set(QT_MSVC_PATH "C:\\Qt\\Qt5.12.8\\5.12.8\\msvc2017_64")
set(CMAKE_PREFIX_PATH "${QT_MSVC_PATH}/lib/cmake")
4 O6 J8 |! D" `+ w然后再次运行 cmake 指令或者使用CMake GUI重新运行，构建文件夹下便能正常生成.sln项目文件。
VS中编译好后，运行时会提示无法找到Qt相关的dll导致程序不能正常运行。解决办法包括：
! x& ~$ W0 u7 [) F1. 设置VS选项，将Qt的dll路径包含进去；
  P; c- h8 A; N6 P( H) t 2. 将Qt相关dll拷贝到编译输出文件夹；
3. 设置CMake，使其能自动复制所需要的dll。
这里介绍第三种方式，原理是借助Qt自带的windeployqt.exe程序自动部署程序所需dll到目标文件夹。具体操作为，在项目根目录的CMakeLists.txt最后添加部署dll的指令：
  G0 u8 `7 H& j( b  eset(QT_BIN_PATH "${QT_MSVC_PATH}/bin")
9 k. W* T5 k! S$ x" [function(windeployqt target)
# POST_BUILD step
# - after build, we have a bin/lib for analyzing qt dependencies
% ]  y: y( ?- r# - we run windeployqt on target and deploy Qt libs
7 P# r1 U" w. g5 p$ T, C2 Aadd_custom_command(TARGET ${target} POST_BUILD
COMMAND "${QT_BIN_PATH}/windeployqt.exe"
" Z3 g  ^% Q2 V# Q--verbose 1
#--release # uncomment this line if built with Release
" m) y& g( p# s$ b+ Y1 v* S% T#--no-svg
* D( s. i  o2 _4 c7 _#--no-angle
#--no-opengl
7 V/ i& ^1 T  f- V3 F6 T#--no-opengl-sw
* r6 L; G- ~6 `9 t#--no-compiler-runtime
! S+ \0 a9 ~2 W$ u% S8 {1 K+ R% A#--no-system-d3d-compiler
: A2 W& R* ^+ R7 T7 ^5 w\"$\"
COMMENT "Deploying Qt libraries using windeployqt for compilation target '${target}' ..."
, L5 P, q8 c9 E' R)
endfunction()
if (WIN32)
9 H$ y. v. u* [% v+ u% U  windeployqt(${PROJECT_NAME})
  S! D& z9 \$ z* k  L/ a. Z8 d3 X7 oendif()最后，转换成VS项目时，默认是Console项目，运行时会有cmd窗口。一个解决办法是在生成可执行文件时设置目标为 WIN32：
5 ?/ S: |  v- ]) gadd_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)
3 N  b3 G8 T- _; ^# 请更改为实际的Qt安装目录
$ z5 I* a; u" Wset(QT_MSVC_PATH "C:\\Qt\\Qt5.12.8\\5.12.8\\msvc2017_64")
set(CMAKE_PREFIX_PATH "${QT_MSVC_PATH}/lib/cmake")
+ x3 n5 N7 Y( u8 }5 |  X0 j7 d+ W1 Jset(QT_BIN_PATH "${QT_MSVC_PATH}/bin")
, d3 [- `" x7 R- {$ g) _& fset(CMAKE_AUTOUIC ON)
0 A8 K, ^# k# E  bset(CMAKE_AUTOMOC ON)
! K( v; z" M) Hset(CMAKE_AUTORCC ON)
" V& U7 ]1 L5 B* Aset(CMAKE_CXX_STANDARD 11)
, E0 b, E9 ?, Gset(CMAKE_CXX_STANDARD_REQUIRED ON)
' p1 w/ [2 H( ]$ s+ I' l) Jfind_package(Qt5 COMPONENTS Widgets REQUIRED)
5 @1 ~: \# |) G% o# 默认Release构建
if (NOT CMAKE_BUILD_TYPE)
: N0 R% U9 ~3 A; g6 M    set( CMAKE_BUILD_TYPE "Release" )
2 h  X2 k! u/ x  Oendif()
message("build type: ${CMAKE_BUILD_TYPE}")
# 按照自己的项目结构添加文件
! P: r: [5 t8 ^- y, ^# 也可使用file/aux_source_directory批量引入，注意不要引入自动生成的文件！
add_executable(${PROJECT_NAME} WIN32
  main.cpp
  mainwindow.cpp
  mainwindow.h
+ G$ C( J3 b& a. U)
target_link_libraries(${PROJECT_NAME} PRIVATE Qt5::Widgets)
. z9 a! i2 h  M3 k, y6 S% ^; A6 nfunction(windeployqt target)
# POST_BUILD step
+ b, f) m- `7 W  uadd_custom_command(TARGET ${target} POST_BUILD
COMMAND "${QT_BIN_PATH}/windeployqt.exe"
# i9 r* R5 G" u( ?& N! ^. w$ f--verbose 1
/ E+ b( u* o4 I) p3 S2 ]' l- b2 ^#--release
#--no-svg
% Y  X- C+ x1 d- X& {9 R#--no-angle
#--no-opengl
#--no-opengl-sw
, n7 n, A! j  g  ^#--no-compiler-runtime
& o. f, H4 h; L! x* Y# l' M#--no-system-d3d-compiler
5 G) R/ o) }0 `7 s( v! G\"$\"
1 o: t$ Q( K3 U7 a0 X+ fCOMMENT "Deploying Qt libraries using windeployqt for compilation target '${target}' ..."
6 O: v( G% \' G8 F* D8 Q)
: T; f- W/ H7 {; Uendfunction()
$ l$ s) N1 X, p6 Yif (WIN32)
  windeployqt(${PROJECT_NAME})
endif()
````通过上面的配置，我们的Qt项目既可在Qt Creator中正常编译运行，也可在CLion/Visual Studio中正常编译运行而 无需安装Qt插件。
参考返回目录1. CMake官网
9 y& {- `0 j' @5 O" U4 P2. CMake教程
4 L# v; `' }! d( }! n3. CMake FAQ
4. CMake指定编译器
$ ^2 ^( J7 i4 i+ D# rAD：【国外VPS推荐】 搬瓦工三网回程CN2 GIA VPS，季付46.87$打赏赞(3)