C / C++ / 系统课时

生成可分发的项目安装包

生成可分发的项目安装包

这一节把“本机能运行”的 CMake 项目整理成可交付成果:先定义安装规则,把程序和配置落到稳定目录,再用 CPack 生成压缩包,并用安装目录验证最终交付物是否完整。

学习目标

  • 使用 install() 明确可执行文件和配置文件的安装位置
  • 理解构建目录、安装目录和发布包三者的区别
  • 使用 CPack 生成压缩包,并检查交付内容是否符合约定

先定义发布目录,而不是复制 build

构建目录是编译系统的工作区,通常包含对象文件、缓存、生成脚本和临时文件,不适合作为交付目录。发布目录应该只保留目标环境真正需要的内容,例如 bin 下的可执行文件、etc 下的默认配置,以及项目明确要求随包交付的运行库。

从构建产物到发布包的交付链路

下面的安装约定把可执行文件放入 bin,默认配置放入 etc/mytool。这比在发布脚本里手工复制文件更可靠,因为同一份安装规则既能用于本地安装,也能直接成为打包输入。

用 install() 声明交付内容

假设项目只有一个可执行文件和一份默认配置,顶层 CMakeLists.txt 可以这样写。该配置要求 CMake 3.24 或更高版本,并启用 CPack 的 TGZ 生成器。

cmake
cmake_minimum_required(VERSION 3.24)
project(mytool VERSION 1.0.0 LANGUAGES C)

add_executable(mytool src/main.c)

# 安装规则只描述交付物,不复制整个构建目录。
install(TARGETS mytool
    RUNTIME DESTINATION bin
)

install(FILES config/mytool.conf
    DESTINATION etc/mytool
)

set(CPACK_PACKAGE_NAME "mytool")
set(CPACK_PACKAGE_VERSION "${PROJECT_VERSION}")
set(CPACK_PACKAGE_FILE_NAME
    "mytool-${PROJECT_VERSION}-${CMAKE_SYSTEM_NAME}-${CMAKE_SYSTEM_PROCESSOR}"
)
set(CPACK_GENERATOR "TGZ")
set(CPACK_INCLUDE_TOPLEVEL_DIRECTORY ON)

include(CPack)

该配置生效后,cmake --install 会按照两条 install() 规则组织文件;include(CPack) 则在配置阶段生成打包所需的 CPack 配置。

片段示例:src/main.c 是上述 CMake 项目的源文件,依赖顶层 CMakeLists.txt 构建,不单独执行。

c
#include <stdio.h>

int main(void) {
    puts("mytool 1.0.0");
    return 0;
}

片段示例:config/mytool.conf 是随程序安装的运行期配置,同样由前述安装规则处理。

text
mode=production

install(TARGETS) 只会处理明确声明的目标。如果程序还依赖项目自己构建的动态库,应为这些库增加对应的安装规则;不要假设 CPack 会自动收集所有第三方运行库。

先做 staged install 验证

正式打包前,先把安装结果写入项目内的临时目录。这样不需要修改系统目录,就能检查最终文件布局。下面示例以类 Unix 环境为例。

bash
set -e
cmake -S . -B build -DCMAKE_BUILD_TYPE=Release >/dev/null
cmake --build build >/dev/null
rm -rf stage
cmake --install build --prefix "$PWD/stage" >/dev/null
find stage -type f | sort

预期输出

text
stage/bin/mytool
stage/etc/mytool/mytool.conf

Windows 上可执行文件通常带 .exe,因此实际文件名会不同。验证重点是安装树只出现计划交付的文件,而不是把 build 中的缓存和中间产物一起带走。

用 CPack 生成压缩包

include(CPack) 会在配置阶段生成 CPackConfig.cmake。完成构建后,可以使用 cpack 生成 TGZ 包,并检查最终文件名。

bash
set -e
rm -f mytool-1.0.0-*.tar.gz
cpack --config build/CPackConfig.cmake -G TGZ >/dev/null
ls -1 mytool-1.0.0-*.tar.gz

预期输出

text
mytool-1.0.0-<SYSTEM>-<ARCH>.tar.gz

<SYSTEM> 和 <ARCH> 由当前 CMake 识别的平台决定,实际值可能不同。把版本和平台写入包名,可以降低不同构建产物互相覆盖的风险。

按目标环境验收发布包

交付前不能只确认压缩包已经生成,还应解包检查目录结构,并确认可执行文件能够启动、默认配置位于约定位置,以及必须随包分发的动态库没有缺失。

对于需要自包含部署的项目,还要明确运行库策略:操作系统提供的库由目标环境负责,项目私有库通过安装规则进入发布目录,第三方库则根据许可证和部署方式决定是否随包分发。CMake 和 CPack负责把这些选择变成可重复执行的安装与打包过程,而不是替代发布策略本身。

按自己的节奏,确认真正理解。

目录与阅读设置

阅读设置

17

记录一个想法

生成可分发的项目安装包

0 / 10000 · 笔记保存到账号。未提交的修改会在关闭、离开或刷新后丢失。

登录哪都通