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

[db:作者]

本文目录

CMake简介

CMake命令

CMake常见指令

常用环境变量

Qt应用示例

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

参考CMake是一个跨平台、开源的构建工具，在C/C++项目中有广泛应用。本文首先介绍CMake及常用指令，并结合工作时需要用到的Qt 5，给出一个完整的CMake项目配置。
3 G- Q+ i1 i# d4 O' L CMake简介返回目录CMake如其名”Cross-platform Make”，是一个 跨平台、开源 的构建工具。与make不同，CMake并不直接构建软件，而是生成用于构建的Makefile、.sln等工程文件，相当于高阶构建工具。
9 p, Y+ E7 n( C  }  A与另一构建工具Automake相比，CMake使用上更方便，支持更多的编译套件(Ninja、VS等)。许多编辑器和IDE，如VS Code(宇宙第一编辑器/IDE)、Clion、Visual Studio等都内置了对CMake的支持。特别的，CMake已经是QT 6的默认构建工具，官方给出从qmake迁移的理由是CMake成熟稳定、用户基数大生态完善。因此，对于需要跨平台编译运行的C/C++项目，很推荐学习和使用CMake作为构建工具，能方便的转换成各种IDE项目，团队成员无需切换编辑器/IDE即可工作。
2 R( y5 P- W8 L( [值得一提的是，CMake由Kitware公司开发和维护，VTK和ParaView等知名开源产品均出自该公司。从这方面看，CMake也算出身名门，因此能很快流行开来。
CMake命令返回目录CMake基于CMakeLists.txt文件来生成对应目标(generator)的构建文件，一个标准的CMake项目构建操作为(命令行方式)：
, L$ |" C6 N  Hcd PROJECT_DIR
+ n0 a0 G# W  N7 K# Wcmake
make TARGET或者使用用CMake GUI：


# H5 L: q$ _- u& Y/ p2 L: I9 }CMake-GUI操作示意图然后使用VS打开生成的.sln项目，即可编译、运行和调试项目。
1 p# a+ D- E" I1 k* h2 q5 t6 ~2 h5 R+ ~+ {Linux/Unix/MacOS平台上，CMake默认生成标准的makefile；Windows平台上则会检测Visual Studio版本，生成对应的VS .sln项目工程文件(在MSYS/Cygwin/WSL环境下执行除外)。可以使用 -G 选项切换生成目标，例如生成Ninja构建文件：
cmake . -G Ninja
& d2 Q4 L( m1 U% @8 n& sninja TARGETCMake一个非常棒的特性是“外部构建”(out-of-source build)，即支持在源码目录外构建。由于这个特性，以及CMake生成的makefile没有clean命令，一般来说都推荐在单独的build目录中构建：
mkdir -p build
cd $_
cmake ..
/ i. T9 Q$ `* Q( V$ F# [7 a7 wmake TARGET -j4如果使用CMake GUI，Browse Build时请选择单独的构建目录。
命令行方式下编译Debug/Release版本、传递C++编译参数，请使用 -D 选项，例如：
cmake .. -DCMAKE_BUILD_TYPE=Release
make TARGET -j4一些内置的宏定义参数可参考下文的环境变量。
5 S/ L0 y0 s# t3 F9 Q+ D5 E: }, V; b如果是生成VS项目，则只需在VS中选择构建版本、设置编译和链接参数即可。
; L0 ]( h3 D( n2 z5 C" ] CMake常见指令返回目录CMake基于CMakeLists.txt文件生成项目构建文件，因此编写CMakeLists.txt文件是CMake项目的核心。本小节介绍一些用在CMakeLists.txt文件中的常用指令。
CMakeLists.txt 使用  # 作为注释，# 所在行后续字符均作为注释被忽略

cmake_minimum_required一般这条指令出现在文件的最前面，用来指定项目支持的最低版本。对于Qt 5项目，建议为：cmake_minimum_required(VERSION 3.7)。
0 A: R, @* t. Y5 C/ m* Y5 p' [

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

set定义一些变量、宏的值。该指令一般会出现多次，例如设置C++语法标准：set(CMAKE_CXX_STANDARD 11)。相反的指令是unset。
* R! B$ k4 a6 f2 R* q& f7 S; v

if…else[if]…endif条件控制语句，注意指令后的括号不可省略：
0 c8 H8 c% p: T# a" Wif (WIN32)
xxxx
else() # 括号不可省略
) D# M  L* ]( ]* Axxxx
- Y/ u% Q6 A6 X( ]- c) a' Qendif()

find_package查找指定模块，例如OpenMP。Qt 5项目一般需要：find_package(Qt5 COMPONENTS Widgets REQUIRED)。
' b9 e* x: d, ?7 v: s1 t

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

link_directories设置链接库的路径，更推荐的指令是 target_link_directories，理由见 include_directories。

aux_source_directory将指定目录下的源文件添加到变量中，例如：aux_source_directory(./src SRC)。注意该命令不会递归包含子目录源文件。
8 u. k. r1 t+ O) R6 l+ z

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

find_library查找指定库的路径并保存到变量中。
6 H; X6 J3 f4 n5 I$ ]

add_custom_command添加自定义命令，可用于构建前进行moc，构建后拷贝文件等用途。
# q3 L9 N8 I% {9 p6 M

add_subdirectory添加一个需要构建的子目录，子目录下有CMakeLists.txt文件设定好构建规则。
* H, S* d3 p4 b: e- Q/ \+ I! E

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

add_library构建动态或静态库，一般存在于子目录或者库的CMakeLists.txt文件中。
  o/ W' ~/ E7 G1 s& h1 e" S

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

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的使用方式。
5 I9 \( H; a+ E+ p7 c新建Qt项目时，可以选择CMake作为构建工具：
# |" l4 r, ?3 O. H, ?

" ]" j: c; A- U* NQt新建项目使用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的安装位置：
& v8 [2 |% r& O% K/ p+ a6 j9 p# 具体路径请根据自身情况替换
set(QT_MSVC_PATH "C:\\Qt\\Qt5.12.8\\5.12.8\\msvc2017_64")
: m% Q& n# M1 f+ a# Q6 Sset(CMAKE_PREFIX_PATH "${QT_MSVC_PATH}/lib/cmake")
, S! x9 ~& I7 F4 ~然后再次运行 cmake 指令或者使用CMake GUI重新运行，构建文件夹下便能正常生成.sln项目文件。
6 r8 N0 f8 q4 z% AVS中编译好后，运行时会提示无法找到Qt相关的dll导致程序不能正常运行。解决办法包括：
1. 设置VS选项，将Qt的dll路径包含进去；
% Q: n' y# X0 G3 l5 Z+ x+ ^+ p' { 2. 将Qt相关dll拷贝到编译输出文件夹；
3. 设置CMake，使其能自动复制所需要的dll。
6 b4 I8 d5 u/ R: g这里介绍第三种方式，原理是借助Qt自带的windeployqt.exe程序自动部署程序所需dll到目标文件夹。具体操作为，在项目根目录的CMakeLists.txt最后添加部署dll的指令：
set(QT_BIN_PATH "${QT_MSVC_PATH}/bin")
function(windeployqt target)
# POST_BUILD step
9 p9 Y7 Z, g7 k& z* d' y; x# - 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
2 k0 K! e; Z+ c) q% X$ c* {& CCOMMAND "${QT_BIN_PATH}/windeployqt.exe"
--verbose 1
#--release # uncomment this line if built with Release
! W. p3 U' e: f& V#--no-svg
#--no-angle
#--no-opengl
#--no-opengl-sw
# V9 o; z# K$ B0 c# |( H#--no-compiler-runtime
#--no-system-d3d-compiler
4 z- G" g/ g# o$ j$ a; {+ c\"$\"
COMMENT "Deploying Qt libraries using windeployqt for compilation target '${target}' ..."
3 b* w5 f8 \& j+ G)
. c/ n: K4 F9 |! a/ ~endfunction()
+ N! D8 c* Y% rif (WIN32)
/ K3 p7 ?4 L' T* k3 `+ F5 R( h  windeployqt(${PROJECT_NAME})
) D7 g$ Y% D' F' Sendif()最后，转换成VS项目时，默认是Console项目，运行时会有cmd窗口。一个解决办法是在生成可执行文件时设置目标为 WIN32：
add_executable(${PROJECT_NAME} WIN32 xxxx)
一个完整的Qt 5项目CMakeLists.txt返回目录以下是一个适用于Windows平台的Qt 5项目完整CMakeLists.txt，实际使用时请替换名字和Qt 5安装路径等：
! Q4 y2 k$ q2 ]/ rcmake_minimum_required(VERSION 3.7)
) f/ A* W8 R8 p. @) _" ~# 请将myproject改成实际的应用名字
6 f$ Q' f( A6 Aproject(myproject LANGUAGES CXX)
set(CMAKE_INCLUDE_CURRENT_DIR ON)
" V7 \0 J! ~) |4 h% S/ f9 n# 请更改为实际的Qt安装目录
6 ~: x- C3 J$ r5 Fset(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")
0 ?/ {% J1 o' T* B- vset(CMAKE_AUTOUIC ON)
set(CMAKE_AUTOMOC ON)
set(CMAKE_AUTORCC ON)
, L: _, h0 E3 U( q. t7 O, eset(CMAKE_CXX_STANDARD 11)
set(CMAKE_CXX_STANDARD_REQUIRED ON)
find_package(Qt5 COMPONENTS Widgets REQUIRED)
1 r; |3 c! w5 \, o) w# x# 默认Release构建
if (NOT CMAKE_BUILD_TYPE)
2 c$ e5 ]9 k4 }& E* p7 R9 h    set( CMAKE_BUILD_TYPE "Release" )
endif()
message("build type: ${CMAKE_BUILD_TYPE}")
' y% V0 k4 l1 e. Z7 L# 按照自己的项目结构添加文件
+ r. _1 }; ~' s& t# 也可使用file/aux_source_directory批量引入，注意不要引入自动生成的文件！
  u1 r3 o5 a/ L% C) l- Padd_executable(${PROJECT_NAME} WIN32
  main.cpp
% j. o  d9 Z7 x: W  mainwindow.cpp
  mainwindow.h
; }3 \$ l, e) |( O0 j)
9 n  P$ u  ?) A" C8 p3 ]' @target_link_libraries(${PROJECT_NAME} PRIVATE Qt5::Widgets)
% T  l) W+ C: J- k, P& p! Wfunction(windeployqt target)
/ D3 i9 v) j* ~* [5 O  M8 ~# POST_BUILD step
add_custom_command(TARGET ${target} POST_BUILD
6 z* w( F6 A- [% xCOMMAND "${QT_BIN_PATH}/windeployqt.exe"
4 ]6 l  w. {; E--verbose 1
4 Z9 u/ M' U- i0 F. s#--release
5 V$ J/ f; u0 u. z. O) v: p5 g#--no-svg
4 A, @2 n9 _9 R2 v, I#--no-angle
6 ~4 \; X# m" `5 W3 c* w#--no-opengl
7 l/ F* L  p! J; A: c7 O#--no-opengl-sw
#--no-compiler-runtime
#--no-system-d3d-compiler
\"$\"
6 L5 h& G  ]& @COMMENT "Deploying Qt libraries using windeployqt for compilation target '${target}' ..."
)
endfunction()
if (WIN32)
  windeployqt(${PROJECT_NAME})
9 @7 A% y8 \3 t5 @9 nendif()
# z' [  J# K* E; t1 G5 x````通过上面的配置，我们的Qt项目既可在Qt Creator中正常编译运行，也可在CLion/Visual Studio中正常编译运行而 无需安装Qt插件。
参考返回目录1. CMake官网
4 F2 T" y& A1 w, A3 d2. CMake教程
. R# Q* R( ^, u- D. e  @! \3 I4 P) S# O3. CMake FAQ
4. CMake指定编译器
AD：【国外VPS推荐】 搬瓦工三网回程CN2 GIA VPS，季付46.87$打赏赞(3)