CMake构建学习笔记2-zlib库的构建

1. 概述

Zlib是一个数据压缩库,它提供了在内存中对数据进行压缩和解压缩的功能。这个库非常泛用,除了直接使用这个库之外,很多依赖库都会间接依赖它。这里就以Windows系统为例介绍一下如何通过CMake构建它。

2. 详论

2.1 设置构建目录

尽管CMake提供了GUI工具,但是不推荐通过GUI进行构建。原因很简单,有很多构建选项需要我们自己控制,一个个去配置是很容易忘记自己配置了哪些选项的,总不能把配置的截图保存下来吧?因此还是使用脚本比较合适。

在下载源代码之后,进入源代码目录,会有一个CMakeLists.txt文件,这个文件就是用于CMake构建的项目文件。在进行构建之前,需要设置一个单独的目录存放构建的中间文件和结果文件,方便与源代码分开。通常的做法是在这个跟目录中创建一个名为Build的目录。

2.2 配置构建

接下来,使用如下命令来配置构建项目:

# 配置CMake  
cmake .. -G "$Generator" -A x64 -DCMAKE_CONFIGURATION_TYPES=RelWithDebInfo -DCMAKE_INSTALL_PREFIX="$InstallDir" -DZLIB_BUILD_EXAMPLES=OFF
  1. ..表示项目的根目录是上一级目录。
  2. -G $Generator的意思设置生成器,在Windows环境下一般使用MSVC进行构建,例如使用Visual Studio 2019进行构建,Generator就应该是"Visual Studio 16 2019"。
  3. -A x64指定架构为64位。
  4. 所有的构建配置项目以-D开头,CMAKE_CONFIGURATION_TYPES是一个CMake内置变量,用于控制可用的配置类型,这里使用的是RelWithDebInfo,也就是Release带调试信息的类型。
  5. CMAKE_INSTALL_PREFIX也是一个内置的CMake变量,用于设置项目安装的目录,如果不设置的话,Linux系统下默认会安装到"/usr/local",Windows系统下会安装到"C:/Program Files/"。
  6. ZLIB_BUILD_EXAMPLES内置一个项目提供的一个配置项,表示不用构建项目自带的案例程序。

越是大型项目,需要配置的构建项就越多。对于项目提供的配置项,可以在CMakeLists.txt中看到,例如:

option(ZLIB_BUILD_EXAMPLES "Enable Zlib Examples" ON)

如果不会看这些也不要紧,可以打开CMake的GUI工具帮助我们辅助查看。在GUI工具中会列出所有的CMake变量和项目配置项:

2.3 构建项目

然后就是正式开始构建项目了:

# 构建阶段,指定构建类型
cmake --build . --config RelWithDebInfo
  1. --build表示构建项目。
  2. .表示构建的结果放在当前目录。
  3. --config RelWithDebInfo表示按照Release带调试信息的类型进行构建。

2.4 安装项目

最后是安装项目。有的读者包括笔者最开始会比较奇怪,dll也需要安装的吗?是的没错,需要安装,而且最好把所有依赖库安装到一个目录中,这样便于引用和管理。

# 安装阶段,指定构建类型和安装目标
cmake --build . --config RelWithDebInfo --target install

2.5 清理构建目录

另外还有个指令是清理构建生成的文件,不过使用的不是很多,手动删除也行:

# 清理构建目录
cmake --build . --target clean

3. 总结

以上大概就是构建一个C/C++依赖库项目的过程了,不止是zlib,其他库也可以按照这种方式进行构建,最大的区别就是不同的项目可能需要的配置项不同,读者需要灵活掌握。