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等工程文件，相当于高阶构建工具。
1 N' m8 ^0 l  j  Q与另一构建工具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也算出身名门，因此能很快流行开来。
2 R& F& S+ L) z! X CMake命令返回目录CMake基于CMakeLists.txt文件来生成对应目标(generator)的构建文件，一个标准的CMake项目构建操作为(命令行方式)：
, x8 ^' g9 a; S& jcd PROJECT_DIR
' m5 n: s  v1 _$ tcmake
: z" v- m# P% f* D9 ]+ e0 c* ^make TARGET或者使用用CMake GUI：
" ?' U3 A* N. h8 c0 `% i
  G2 {# w. x7 b& t1 z; R
5 _* F( a, V, u, a# QCMake-GUI操作示意图然后使用VS打开生成的.sln项目，即可编译、运行和调试项目。
Linux/Unix/MacOS平台上，CMake默认生成标准的makefile；Windows平台上则会检测Visual Studio版本，生成对应的VS .sln项目工程文件(在MSYS/Cygwin/WSL环境下执行除外)。可以使用 -G 选项切换生成目标，例如生成Ninja构建文件：
cmake . -G Ninja
/ `) k  ~/ |5 |1 J# B& ]; X  ^ninja TARGETCMake一个非常棒的特性是“外部构建”(out-of-source build)，即支持在源码目录外构建。由于这个特性，以及CMake生成的makefile没有clean命令，一般来说都推荐在单独的build目录中构建：
; ?( Y3 M* }2 s/ ?, dmkdir -p build
5 y$ d0 g3 D0 Acd $_
* @/ L: ~3 A4 E( |cmake ..
$ y! Q! e) o; `- _: C3 Qmake TARGET -j4如果使用CMake GUI，Browse Build时请选择单独的构建目录。
, y1 l+ j1 [; B% B7 U8 }命令行方式下编译Debug/Release版本、传递C++编译参数，请使用 -D 选项，例如：
cmake .. -DCMAKE_BUILD_TYPE=Release
+ f% E; @4 p, y% G4 o2 T$ l4 bmake TARGET -j4一些内置的宏定义参数可参考下文的环境变量。
- N& j, e: d0 [4 P$ K  @+ r如果是生成VS项目，则只需在VS中选择构建版本、设置编译和链接参数即可。
' |: }4 k) ]% n: S$ ]- e6 Q, H CMake常见指令返回目录CMake基于CMakeLists.txt文件生成项目构建文件，因此编写CMakeLists.txt文件是CMake项目的核心。本小节介绍一些用在CMakeLists.txt文件中的常用指令。
CMakeLists.txt 使用  # 作为注释，# 所在行后续字符均作为注释被忽略
8 M1 T$ n. x7 L% }, h6 P

cmake_minimum_required一般这条指令出现在文件的最前面，用来指定项目支持的最低版本。对于Qt 5项目，建议为：cmake_minimum_required(VERSION 3.7)。
7 S+ G1 M5 P! k! h4 E8 r5 ~$ o+ ^0 d! x

project指定项目名称及属性。C/C++项目的建议值为：project(项目名称 C CXX)。
2 q0 C& H* E0 ?" w

set定义一些变量、宏的值。该指令一般会出现多次，例如设置C++语法标准：set(CMAKE_CXX_STANDARD 11)。相反的指令是unset。
; A- \* c3 e* B3 U( }2 e- m/ y

if…else[if]…endif条件控制语句，注意指令后的括号不可省略：
2 \, x% w. G  J  E: w! Jif (WIN32)
xxxx
else() # 括号不可省略
5 r# c( U$ L9 U: rxxxx
endif()

find_package查找指定模块，例如OpenMP。Qt 5项目一般需要：find_package(Qt5 COMPONENTS Widgets REQUIRED)。
) ~9 h9 S0 W7 f1 E: G  F( V

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

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

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查找指定库的路径并保存到变量中。
, ]! E4 @  {' N7 ~3 S, d

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

add_subdirectory添加一个需要构建的子目录，子目录下有CMakeLists.txt文件设定好构建规则。
# R  \" s3 I3 ?

add_executable构建可执行程序，一般项目的主CMakeLists.txt中会有这条指令。
# E* w2 E* T+ p' G

add_library构建动态或静态库，一般存在于子目录或者库的CMakeLists.txt文件中。
- S( d$ H& d5 ]8 E

message可在cmake构建时输出信息。
CMakeLists.txt文件中指令不区分大小写，但一般来说同一个文件中指令应保持大小写风格一致。
更多指令可参考 CMake官方文档。
% [0 ~! c+ ~9 i/ R! ?6 k& e' c# r" t 常用环境变量返回目录本小节介绍几个常用的环境变量(编译宏)。
& \% }: P4 u0 T

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的使用方式。
& m" v( [' V! I新建Qt项目时，可以选择CMake作为构建工具：
1 f3 X/ Z% t1 F' y6 P
  e8 M5 E& f7 e, E' h" s; H
6 L1 T/ i. y; Z$ d3 D9 o, O: q$ {Qt新建项目使用CMake生成项目后，项目文件夹将出现CMakeLists.txt和CMakeLists.txt.user两个文件，熟悉的.pro文件没有了(CMakeLists.txt.user充当了Qt Creator工程文件的角色，其他IDE用不到，可删除)。
7 [. A, k7 T: b4 e1 b但需要注意的是，此时Qt Creator中编译项目是没问题的，但是在CLion/VS Code中打开，或者生成Visual Studio用的.sln文件会有问题，因为CMake无法检测到Qt是否安装及其安装路径。
解决办法便是在 project 指令后增加如下指令告知Qt的安装位置：
# 具体路径请根据自身情况替换
- b# w# Y( m1 w; Z% tset(QT_MSVC_PATH "C:\\Qt\\Qt5.12.8\\5.12.8\\msvc2017_64")
set(CMAKE_PREFIX_PATH "${QT_MSVC_PATH}/lib/cmake")
1 R8 A# k/ n# }( l/ @然后再次运行 cmake 指令或者使用CMake GUI重新运行，构建文件夹下便能正常生成.sln项目文件。
* j: t7 v! J7 yVS中编译好后，运行时会提示无法找到Qt相关的dll导致程序不能正常运行。解决办法包括：
" M3 g$ u/ t$ S6 g) x# l1 C7 S- \" O1. 设置VS选项，将Qt的dll路径包含进去；
0 r" |! j0 H: k! U 2. 将Qt相关dll拷贝到编译输出文件夹；
3. 设置CMake，使其能自动复制所需要的dll。
这里介绍第三种方式，原理是借助Qt自带的windeployqt.exe程序自动部署程序所需dll到目标文件夹。具体操作为，在项目根目录的CMakeLists.txt最后添加部署dll的指令：
3 k8 j: @" g2 l" d, V3 h; O; ]set(QT_BIN_PATH "${QT_MSVC_PATH}/bin")
function(windeployqt target)
# POST_BUILD step
+ q; t+ K, i) s" z# - 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"
4 \# C4 s6 A- I--verbose 1
#--release # uncomment this line if built with Release
0 Z2 I, k2 |' J$ Y#--no-svg
, K" s8 w3 g- m, z3 A. K- V. V#--no-angle
* x0 J( t7 Y8 V2 T  ?) K#--no-opengl
#--no-opengl-sw
#--no-compiler-runtime
#--no-system-d3d-compiler
\"$\"
COMMENT "Deploying Qt libraries using windeployqt for compilation target '${target}' ..."
4 k% |  N( t, J+ c! T! \)
endfunction()
4 ?/ ]$ F4 A1 x. rif (WIN32)
" g' }& l1 J' d1 B( C- l- \  windeployqt(${PROJECT_NAME})
" o  @: M. g2 Q4 v. i* gendif()最后，转换成VS项目时，默认是Console项目，运行时会有cmd窗口。一个解决办法是在生成可执行文件时设置目标为 WIN32：
5 u% F1 J8 K# z9 j2 {/ Uadd_executable(${PROJECT_NAME} WIN32 xxxx)
: q" p6 Y2 d, O9 J6 K  D 一个完整的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)
4 t* W8 }+ o% e( k; i# 请更改为实际的Qt安装目录
, E9 ~7 M- W' g! hset(QT_MSVC_PATH "C:\\Qt\\Qt5.12.8\\5.12.8\\msvc2017_64")
, b+ T$ B8 x- Z7 bset(CMAKE_PREFIX_PATH "${QT_MSVC_PATH}/lib/cmake")
set(QT_BIN_PATH "${QT_MSVC_PATH}/bin")
" [: U/ M- h* a/ ]7 eset(CMAKE_AUTOUIC ON)
, U! e% m8 _* \+ j1 ~set(CMAKE_AUTOMOC ON)
set(CMAKE_AUTORCC ON)
set(CMAKE_CXX_STANDARD 11)
set(CMAKE_CXX_STANDARD_REQUIRED ON)
2 E9 \( [. @- W, }( bfind_package(Qt5 COMPONENTS Widgets REQUIRED)
# 默认Release构建
if (NOT CMAKE_BUILD_TYPE)
+ c* P  K% y: e    set( CMAKE_BUILD_TYPE "Release" )
2 e# z; z3 N$ c/ f! I9 K5 p/ Qendif()
message("build type: ${CMAKE_BUILD_TYPE}")
# 按照自己的项目结构添加文件
! L# O1 O# H! }6 d9 w* o# 也可使用file/aux_source_directory批量引入，注意不要引入自动生成的文件！
& a6 P* {& z2 V- \: K* M3 aadd_executable(${PROJECT_NAME} WIN32
  main.cpp
  mainwindow.cpp
# F, v/ a9 Y3 ], ?$ T6 S: Y. B& ^/ v  mainwindow.h
+ F1 c( Y# d" D7 y)
target_link_libraries(${PROJECT_NAME} PRIVATE Qt5::Widgets)
function(windeployqt target)
# POST_BUILD step
* G$ s9 _0 G4 S5 p5 ~add_custom_command(TARGET ${target} POST_BUILD
2 t$ j: C. C  e! S7 n5 w+ d; iCOMMAND "${QT_BIN_PATH}/windeployqt.exe"
--verbose 1
+ v6 a! \$ Q8 a4 f( N2 i) R#--release
#--no-svg
/ b5 n) N0 G# H/ p5 V, ~1 @' z: j#--no-angle
( Q2 p4 {* v7 }8 p7 G) N/ l#--no-opengl
% h; Y" i3 M7 d) x" j7 K% f#--no-opengl-sw
( ~3 |* y  T2 M9 P2 G#--no-compiler-runtime
. Q. D, i7 m0 {6 Y5 T) t4 g3 t* U4 p#--no-system-d3d-compiler
\"$\"
COMMENT "Deploying Qt libraries using windeployqt for compilation target '${target}' ..."
)
endfunction()
/ j8 X( ~8 G* mif (WIN32)
  windeployqt(${PROJECT_NAME})
$ y% t7 t' b  u1 ~, K3 wendif()
````通过上面的配置，我们的Qt项目既可在Qt Creator中正常编译运行，也可在CLion/Visual Studio中正常编译运行而 无需安装Qt插件。
参考返回目录1. CMake官网
6 S# U  D% ^# x$ L/ @/ W: c4 w2. CMake教程
5 i0 {" F% P; X# A/ M0 d2 j3. CMake FAQ
4. CMake指定编译器
3 Q& c9 e! b/ m# y6 {& wAD：【国外VPS推荐】 搬瓦工三网回程CN2 GIA VPS，季付46.87$打赏赞(3)