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等工程文件，相当于高阶构建工具。
与另一构建工具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项目构建操作为(命令行方式)：
% r& j) @3 a8 rcd PROJECT_DIR
, ?5 C/ M0 p' E% s/ jcmake
make TARGET或者使用用CMake GUI：
+ r) t. ~7 d; e: k

CMake-GUI操作示意图然后使用VS打开生成的.sln项目，即可编译、运行和调试项目。
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目录中构建：
mkdir -p build
, {. C1 `% H$ Q' n% \" z2 M# q% |" fcd $_
cmake ..
make TARGET -j4如果使用CMake GUI，Browse Build时请选择单独的构建目录。
命令行方式下编译Debug/Release版本、传递C++编译参数，请使用 -D 选项，例如：
cmake .. -DCMAKE_BUILD_TYPE=Release
make TARGET -j4一些内置的宏定义参数可参考下文的环境变量。
; U  G  Q7 ~% }  U% V; e5 t如果是生成VS项目，则只需在VS中选择构建版本、设置编译和链接参数即可。
* d6 U! U, O% P/ v$ h3 t( }7 ` CMake常见指令返回目录CMake基于CMakeLists.txt文件生成项目构建文件，因此编写CMakeLists.txt文件是CMake项目的核心。本小节介绍一些用在CMakeLists.txt文件中的常用指令。
$ h& |6 N, B! P; A: j4 BCMakeLists.txt 使用  # 作为注释，# 所在行后续字符均作为注释被忽略

cmake_minimum_required一般这条指令出现在文件的最前面，用来指定项目支持的最低版本。对于Qt 5项目，建议为：cmake_minimum_required(VERSION 3.7)。
- W+ v* R' ?! O, l

project指定项目名称及属性。C/C++项目的建议值为：project(项目名称 C CXX)。
# ~9 ]: s0 z' |/ ?

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

if…else[if]…endif条件控制语句，注意指令后的括号不可省略：
1 y4 W1 i4 J2 _9 P7 c( z- c; Vif (WIN32)
xxxx
else() # 括号不可省略
xxxx
, S/ ^% l6 {6 j* F0 a; [endif()

find_package查找指定模块，例如OpenMP。Qt 5项目一般需要：find_package(Qt5 COMPONENTS Widgets REQUIRED)。
* y3 h$ q. ~, }# Z+ B6 ^$ k

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

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")。
. A, F8 m4 @5 `+ h相对于把每个需要编译的文件添加到CMakeLists.txt中，aux_source_directory 和 file 等指令可方便的引入多个文件，但其弊端之一是CMake不能感知文件变化。当新增文件、文件被删除、重命名时需刷新CMake缓存才能被应用到项目中。
+ j& i2 f, R$ ^0 h

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

add_custom_command添加自定义命令，可用于构建前进行moc，构建后拷贝文件等用途。
, _; v$ f* V* t) N/ }

add_subdirectory添加一个需要构建的子目录，子目录下有CMakeLists.txt文件设定好构建规则。
( y* K5 ~7 V( o# w9 E

add_executable构建可执行程序，一般项目的主CMakeLists.txt中会有这条指令。
& ~4 x1 @1 \% l/ T$ ~

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

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

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的使用方式。
9 G3 R4 G0 @' ?. V5 x新建Qt项目时，可以选择CMake作为构建工具：
2 \( s5 j% ], z" q( F( e8 Q* Y0 L
6 m/ @  |3 k+ j2 C- n2 H: i7 ^9 B0 ]
$ \" c9 F# B3 U3 ?7 l, ^5 TQt新建项目使用CMake生成项目后，项目文件夹将出现CMakeLists.txt和CMakeLists.txt.user两个文件，熟悉的.pro文件没有了(CMakeLists.txt.user充当了Qt Creator工程文件的角色，其他IDE用不到，可删除)。
2 {8 A) _+ ]: a$ g, v, c但需要注意的是，此时Qt Creator中编译项目是没问题的，但是在CLion/VS Code中打开，或者生成Visual Studio用的.sln文件会有问题，因为CMake无法检测到Qt是否安装及其安装路径。
解决办法便是在 project 指令后增加如下指令告知Qt的安装位置：
; q* M; ^5 Q0 {, Q' u" r# 具体路径请根据自身情况替换
. |4 q0 b  e2 z, }" Z" \set(QT_MSVC_PATH "C:\\Qt\\Qt5.12.8\\5.12.8\\msvc2017_64")
9 v' Q- O9 G( I) B+ }3 Qset(CMAKE_PREFIX_PATH "${QT_MSVC_PATH}/lib/cmake")
然后再次运行 cmake 指令或者使用CMake GUI重新运行，构建文件夹下便能正常生成.sln项目文件。
VS中编译好后，运行时会提示无法找到Qt相关的dll导致程序不能正常运行。解决办法包括：
$ U2 e/ ]; I. g% l1. 设置VS选项，将Qt的dll路径包含进去；
; U% j; z/ f: n& F8 { 2. 将Qt相关dll拷贝到编译输出文件夹；
$ |! S) D6 e4 G4 a, f 3. 设置CMake，使其能自动复制所需要的dll。
$ v4 Q8 \% I8 C, a: U  Y这里介绍第三种方式，原理是借助Qt自带的windeployqt.exe程序自动部署程序所需dll到目标文件夹。具体操作为，在项目根目录的CMakeLists.txt最后添加部署dll的指令：
set(QT_BIN_PATH "${QT_MSVC_PATH}/bin")
- d. K7 Q4 k, k7 o2 dfunction(windeployqt target)
# POST_BUILD step
# - after build, we have a bin/lib for analyzing qt dependencies
  r. Y5 f5 b; U) L- U# - we run windeployqt on target and deploy Qt libs
add_custom_command(TARGET ${target} POST_BUILD
COMMAND "${QT_BIN_PATH}/windeployqt.exe"
' O- j' l; X6 Z--verbose 1
#--release # uncomment this line if built with Release
#--no-svg
- Z2 s' B# X& q" T( T$ i#--no-angle
#--no-opengl
#--no-opengl-sw
#--no-compiler-runtime
% e+ h+ D$ A7 d1 a#--no-system-d3d-compiler
" k0 f# r3 i* U$ R\"$\"
- q# S& D9 c, ~$ sCOMMENT "Deploying Qt libraries using windeployqt for compilation target '${target}' ..."
)
endfunction()
if (WIN32)
. D& d9 K& |; B6 D  windeployqt(${PROJECT_NAME})
* Z: U8 L* s. g, a8 Jendif()最后，转换成VS项目时，默认是Console项目，运行时会有cmd窗口。一个解决办法是在生成可执行文件时设置目标为 WIN32：
add_executable(${PROJECT_NAME} WIN32 xxxx)
* _: q( ]+ G# G9 x) t 一个完整的Qt 5项目CMakeLists.txt返回目录以下是一个适用于Windows平台的Qt 5项目完整CMakeLists.txt，实际使用时请替换名字和Qt 5安装路径等：
  v( y  U9 W' b3 xcmake_minimum_required(VERSION 3.7)
9 P6 r# `6 o2 E6 O, j+ m# 请将myproject改成实际的应用名字
project(myproject LANGUAGES CXX)
" e6 n1 Y% @# ]: nset(CMAKE_INCLUDE_CURRENT_DIR ON)
# 请更改为实际的Qt安装目录
set(QT_MSVC_PATH "C:\\Qt\\Qt5.12.8\\5.12.8\\msvc2017_64")
  [6 H! |; _" a+ C8 {/ m  Xset(CMAKE_PREFIX_PATH "${QT_MSVC_PATH}/lib/cmake")
" u5 }* Y/ Q, m  r! Rset(QT_BIN_PATH "${QT_MSVC_PATH}/bin")
7 {: i* o2 {7 E- [set(CMAKE_AUTOUIC ON)
set(CMAKE_AUTOMOC ON)
set(CMAKE_AUTORCC ON)
  {) i1 n$ \! J* n, @9 W1 W$ n! xset(CMAKE_CXX_STANDARD 11)
set(CMAKE_CXX_STANDARD_REQUIRED ON)
find_package(Qt5 COMPONENTS Widgets REQUIRED)
# 默认Release构建
3 k& X5 R2 |# l- ^$ Lif (NOT CMAKE_BUILD_TYPE)
" `  r3 P! i" P! J7 k% W3 f    set( CMAKE_BUILD_TYPE "Release" )
3 p5 q: z* u; }& C0 }! b" ]- V) W. @endif()
message("build type: ${CMAKE_BUILD_TYPE}")
# 按照自己的项目结构添加文件
; a3 h' U5 K  Z0 @! [6 ]# 也可使用file/aux_source_directory批量引入，注意不要引入自动生成的文件！
- i( N; v# q4 |6 Sadd_executable(${PROJECT_NAME} WIN32
  main.cpp
  mainwindow.cpp
  mainwindow.h
7 D# w$ Q! f% F* T" k)
( ?4 Y0 V6 h2 ]* R* M: otarget_link_libraries(${PROJECT_NAME} PRIVATE Qt5::Widgets)
function(windeployqt target)
# POST_BUILD step
5 L7 o! S: V( s8 t: tadd_custom_command(TARGET ${target} POST_BUILD
COMMAND "${QT_BIN_PATH}/windeployqt.exe"
--verbose 1
#--release
#--no-svg
#--no-angle
) s: q/ C+ p4 w+ }. d#--no-opengl
#--no-opengl-sw
& K( t9 _, n( Q; n7 I#--no-compiler-runtime
- j: Z& x& D0 ^8 D8 z4 \# P; d& W9 v#--no-system-d3d-compiler
\"$\"
COMMENT "Deploying Qt libraries using windeployqt for compilation target '${target}' ..."
9 V0 i5 I3 a5 [* z)
9 b) M6 b! ~! ?, Yendfunction()
if (WIN32)
2 t6 }  G2 {5 p% c2 l  windeployqt(${PROJECT_NAME})
endif()
````通过上面的配置，我们的Qt项目既可在Qt Creator中正常编译运行，也可在CLion/Visual Studio中正常编译运行而 无需安装Qt插件。
) \2 Q, Y- l; L% a! u6 S9 p$ g 参考返回目录1. CMake官网
2. CMake教程
. i+ V0 z, U3 o( R3 v  i6 _3. CMake FAQ
0 {) T8 }9 [% Q) K4. CMake指定编译器
AD：【国外VPS推荐】 搬瓦工三网回程CN2 GIA VPS，季付46.87$打赏赞(3)