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等工程文件，相当于高阶构建工具。
" r9 _* o/ U. e$ m7 X- f: c与另一构建工具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也算出身名门，因此能很快流行开来。
8 x3 E/ ^' X5 x. j CMake命令返回目录CMake基于CMakeLists.txt文件来生成对应目标(generator)的构建文件，一个标准的CMake项目构建操作为(命令行方式)：
+ f, \% e' W! qcd PROJECT_DIR
* A* g. G/ U0 {cmake
; C, G5 g) S& }& @4 F' Omake TARGET或者使用用CMake GUI：


" b4 I8 R7 _: e% m& o' b% eCMake-GUI操作示意图然后使用VS打开生成的.sln项目，即可编译、运行和调试项目。
Linux/Unix/MacOS平台上，CMake默认生成标准的makefile；Windows平台上则会检测Visual Studio版本，生成对应的VS .sln项目工程文件(在MSYS/Cygwin/WSL环境下执行除外)。可以使用 -G 选项切换生成目标，例如生成Ninja构建文件：
cmake . -G Ninja
5 s1 I! j" A, E; i% Lninja TARGETCMake一个非常棒的特性是“外部构建”(out-of-source build)，即支持在源码目录外构建。由于这个特性，以及CMake生成的makefile没有clean命令，一般来说都推荐在单独的build目录中构建：
1 V8 w  \. t7 u- E! Q- e7 Cmkdir -p build
% W6 k0 \1 O" }9 o3 p! L0 Ucd $_
+ W  ^: {5 o' z' `2 E+ D5 T5 gcmake ..
' \) d0 I  g% R% O/ o, }make TARGET -j4如果使用CMake GUI，Browse Build时请选择单独的构建目录。
+ V( [. c$ s9 X$ f9 s" S! z0 ~7 Q命令行方式下编译Debug/Release版本、传递C++编译参数，请使用 -D 选项，例如：
2 F0 i) G5 q3 ^1 `/ i' q, i7 \cmake .. -DCMAKE_BUILD_TYPE=Release
- `- Q# V6 e8 n8 N' q, tmake TARGET -j4一些内置的宏定义参数可参考下文的环境变量。
: H; f: s$ w8 _# w7 p1 M7 V如果是生成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 ?0 a3 e2 Q( C! b

project指定项目名称及属性。C/C++项目的建议值为：project(项目名称 C CXX)。
% M6 Q  w3 Y* m1 N0 u

set定义一些变量、宏的值。该指令一般会出现多次，例如设置C++语法标准：set(CMAKE_CXX_STANDARD 11)。相反的指令是unset。
1 L! c* G8 ^3 O5 F5 r

if…else[if]…endif条件控制语句，注意指令后的括号不可省略：
if (WIN32)
xxxx
% U7 P; v3 e2 p/ L& ?else() # 括号不可省略
+ p& z9 G+ x( C' b% gxxxx
endif()
1 A% D; L) Q% D  V9 ]+ w

find_package查找指定模块，例如OpenMP。Qt 5项目一般需要：find_package(Qt5 COMPONENTS Widgets REQUIRED)。
+ ?4 y- }% b8 G! Y% Q" R5 e

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

link_directories设置链接库的路径，更推荐的指令是 target_link_directories，理由见 include_directories。
! J, M4 y# e% l! P/ m) N7 Y

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

filefile命令是一个功能丰富的目录和文件操作指令，例如递归找出目录下的所有源文件保存到SRC变量中：file(GLOB_RECURSE SRC "src/*.cpp" "src/*/*.cpp")。
( D# Q: k" \  f2 \, B相对于把每个需要编译的文件添加到CMakeLists.txt中，aux_source_directory 和 file 等指令可方便的引入多个文件，但其弊端之一是CMake不能感知文件变化。当新增文件、文件被删除、重命名时需刷新CMake缓存才能被应用到项目中。
4 F1 N+ O" D. T% P' f% @6 _

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

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

add_subdirectory添加一个需要构建的子目录，子目录下有CMakeLists.txt文件设定好构建规则。
$ R( b' r$ E& W5 O' t7 w

add_executable构建可执行程序，一般项目的主CMakeLists.txt中会有这条指令。
( t- `% Q# |3 H  l& h  R  a

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

message可在cmake构建时输出信息。
CMakeLists.txt文件中指令不区分大小写，但一般来说同一个文件中指令应保持大小写风格一致。
: Y: t0 x$ {( b3 V: k) P: |2 {8 B更多指令可参考 CMake官方文档。
常用环境变量返回目录本小节介绍几个常用的环境变量(编译宏)。
/ D, J& K- B! l* E9 _

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

" J7 G! w3 D$ h! }+ b/ w
9 F8 J0 F. J; Z( ]$ {* X( jQt新建项目使用CMake生成项目后，项目文件夹将出现CMakeLists.txt和CMakeLists.txt.user两个文件，熟悉的.pro文件没有了(CMakeLists.txt.user充当了Qt Creator工程文件的角色，其他IDE用不到，可删除)。
9 K* _( g/ t1 `: {+ n但需要注意的是，此时Qt Creator中编译项目是没问题的，但是在CLion/VS Code中打开，或者生成Visual Studio用的.sln文件会有问题，因为CMake无法检测到Qt是否安装及其安装路径。
% N4 W: ]4 _0 a5 |( P( Y6 x解决办法便是在 project 指令后增加如下指令告知Qt的安装位置：
6 B3 Z: y4 h0 B+ ^$ k) E' {& z) ]# 具体路径请根据自身情况替换
% H8 g$ A# F( H) }* `* R& n# _5 pset(QT_MSVC_PATH "C:\\Qt\\Qt5.12.8\\5.12.8\\msvc2017_64")
8 e3 d; Y6 x# M) Z( E* |  V1 ]set(CMAKE_PREFIX_PATH "${QT_MSVC_PATH}/lib/cmake")
0 ]" |) x; F; d/ l% y2 d( F- c$ ^然后再次运行 cmake 指令或者使用CMake GUI重新运行，构建文件夹下便能正常生成.sln项目文件。
3 C; P2 P& O& K7 {1 }' m* E0 H6 x  nVS中编译好后，运行时会提示无法找到Qt相关的dll导致程序不能正常运行。解决办法包括：
1. 设置VS选项，将Qt的dll路径包含进去；
/ R0 n$ N% {+ J+ h# u 2. 将Qt相关dll拷贝到编译输出文件夹；
( y7 B/ ]! W( C% w! W( {4 h 3. 设置CMake，使其能自动复制所需要的dll。
( Y2 @+ Z, x/ ]9 H8 N这里介绍第三种方式，原理是借助Qt自带的windeployqt.exe程序自动部署程序所需dll到目标文件夹。具体操作为，在项目根目录的CMakeLists.txt最后添加部署dll的指令：
1 n' ]; `5 k$ E) o& l" `set(QT_BIN_PATH "${QT_MSVC_PATH}/bin")
* ]1 M& r3 ^" ^- z4 C7 X! m$ Lfunction(windeployqt target)
, ]$ Z2 P% @  d2 Z6 G# POST_BUILD step
# - after build, we have a bin/lib for analyzing qt dependencies
& R8 ~9 A- Y: F# - we run windeployqt on target and deploy Qt libs
add_custom_command(TARGET ${target} POST_BUILD
COMMAND "${QT_BIN_PATH}/windeployqt.exe"
--verbose 1
: N( ~! S% m% C1 J' Z! I4 |: [& q* @+ b& z#--release # uncomment this line if built with Release
7 s* n5 e! z. ^1 `+ k#--no-svg
( R9 J$ {) e" w#--no-angle
4 s) Y& y' y2 k% x$ A) M#--no-opengl
#--no-opengl-sw
#--no-compiler-runtime
#--no-system-d3d-compiler
\"$\"
, ]7 {* i% l% L+ K. KCOMMENT "Deploying Qt libraries using windeployqt for compilation target '${target}' ..."
)
endfunction()
if (WIN32)
  windeployqt(${PROJECT_NAME})
. X8 w& Z' H' dendif()最后，转换成VS项目时，默认是Console项目，运行时会有cmd窗口。一个解决办法是在生成可执行文件时设置目标为 WIN32：
4 m" O1 s. g$ z5 a3 oadd_executable(${PROJECT_NAME} WIN32 xxxx)
- S: M/ |, u, a" I7 G% j5 q+ N6 n 一个完整的Qt 5项目CMakeLists.txt返回目录以下是一个适用于Windows平台的Qt 5项目完整CMakeLists.txt，实际使用时请替换名字和Qt 5安装路径等：
+ a) D% @& N/ s  R$ U' Ncmake_minimum_required(VERSION 3.7)
# 请将myproject改成实际的应用名字
project(myproject LANGUAGES CXX)
set(CMAKE_INCLUDE_CURRENT_DIR ON)
' j/ ^5 T7 A, W8 l) G8 z- }4 z# 请更改为实际的Qt安装目录
( y6 c4 R7 V9 Jset(QT_MSVC_PATH "C:\\Qt\\Qt5.12.8\\5.12.8\\msvc2017_64")
) N7 p. b1 ^* P4 F8 kset(CMAKE_PREFIX_PATH "${QT_MSVC_PATH}/lib/cmake")
. l' p/ W$ d7 Fset(QT_BIN_PATH "${QT_MSVC_PATH}/bin")
set(CMAKE_AUTOUIC ON)
1 i+ w0 ^7 v- t6 g5 G! Dset(CMAKE_AUTOMOC ON)
# v8 V6 J& E, S6 @# Vset(CMAKE_AUTORCC ON)
set(CMAKE_CXX_STANDARD 11)
* N' A/ @( Y6 R: I0 _% _set(CMAKE_CXX_STANDARD_REQUIRED ON)
find_package(Qt5 COMPONENTS Widgets REQUIRED)
8 Q3 _  P; Y4 e+ ~7 s  r3 E, w# 默认Release构建
if (NOT CMAKE_BUILD_TYPE)
    set( CMAKE_BUILD_TYPE "Release" )
endif()
! D% @, I9 X. o+ wmessage("build type: ${CMAKE_BUILD_TYPE}")
3 S4 @- e  d" I# 按照自己的项目结构添加文件
# 也可使用file/aux_source_directory批量引入，注意不要引入自动生成的文件！
add_executable(${PROJECT_NAME} WIN32
  main.cpp
  mainwindow.cpp
$ `3 M# E  W% V$ Q/ P( @* Y  mainwindow.h
, W* d- c% }4 }: `! C. g)
" p# y- d3 g! j  b1 ztarget_link_libraries(${PROJECT_NAME} PRIVATE Qt5::Widgets)
+ i; N! z3 a! ^function(windeployqt target)
7 R0 S( S% Z6 F9 u% ]( t8 n* l7 K# POST_BUILD step
" N% m) Z0 n& x; h% T9 Z" u6 Radd_custom_command(TARGET ${target} POST_BUILD
& x# W; K3 _0 }2 {COMMAND "${QT_BIN_PATH}/windeployqt.exe"
--verbose 1
#--release
#--no-svg
0 P0 r! K" E; C/ l% v* Q  ^#--no-angle
+ P. t+ p; E) Q/ P4 Q#--no-opengl
#--no-opengl-sw
$ O0 ?: Y' D8 D- p( E#--no-compiler-runtime
#--no-system-d3d-compiler
6 ?1 d5 F, r- \- s% N\"$\"
COMMENT "Deploying Qt libraries using windeployqt for compilation target '${target}' ..."
)
$ B+ W. h' V6 O* eendfunction()
5 @4 C. t- {( s) _5 Y0 J- I4 rif (WIN32)
' }* d$ s" Z. B1 ~/ ?  windeployqt(${PROJECT_NAME})
endif()
````通过上面的配置，我们的Qt项目既可在Qt Creator中正常编译运行，也可在CLion/Visual Studio中正常编译运行而 无需安装Qt插件。
参考返回目录1. CMake官网
2. CMake教程
3. CMake FAQ
4. CMake指定编译器
. y/ }9 q+ B- F0 O/ y! F% J$ P% b5 yAD：【国外VPS推荐】 搬瓦工三网回程CN2 GIA VPS，季付46.87$打赏赞(3)