C / C++ / 系统课时
用 install 定义安装规则
用 install 定义安装规则
CMake 的 install() 用来描述“构建产物最终应该放到哪里”,它把构建目录和可发布的安装目录分开。定义好规则后,同一套工程既可以安装到系统前缀,也可以先落到临时目录中检查,再交给打包工具生成发布包。
学习目标
- 能为可执行文件、库和头文件定义清晰的安装目的地
- 理解相对
DESTINATION与安装前缀之间的关系 - 能用
cmake --install将产物安装到临时目录并验证结果
install 解决的是安装树
编译成功只代表目标存在于构建目录;用户真正需要的是结构稳定的安装树,例如可执行文件进入 bin,库进入平台约定的库目录,公开头文件进入 include。install() 描述的正是从“构建产物”到“安装产物”的映射。
使用 GNUInstallDirs 可以获得 CMAKE_INSTALL_BINDIR、CMAKE_INSTALL_LIBDIR 和 CMAKE_INSTALL_INCLUDEDIR 等目录变量,避免把平台约定全部写死。
为目标和头文件定义规则
片段示例:假设项目已经定义了可执行目标 demo、库目标 mylib,并把公开头文件放在 include/mylib 下。
include(GNUInstallDirs)
install(
TARGETS demo mylib
RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}
LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}
ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR}
)
install(
DIRECTORY include/mylib
DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}
)RUNTIME 主要对应可执行文件和 Windows DLL,LIBRARY 对应共享库,ARCHIVE 对应静态库或导入库。这里使用相对目的地,因此最终位置由安装前缀与这些目录变量共同决定;这比直接写绝对路径更利于本地安装、打包和迁移。
这段配置本身不会输出文件列表。重新配置并构建工程后,用下一节的安装命令验证规则是否按预期落盘。
安装到临时目录验证
发布前不要直接把文件写进系统目录。先用 --prefix 指定一个临时安装前缀,可以在不修改 CMakeLists.txt 的情况下检查安装树。下面示例使用 POSIX Shell;项目需能正常配置和构建。
set -euo pipefail
rm -rf stage
cmake -S . -B build -DCMAKE_BUILD_TYPE=Release >/dev/null
cmake --build build --config Release --parallel >/dev/null
cmake --install build --config Release --prefix "$PWD/stage" >/dev/null
find stage -type f -print | sort预期输出
stage/<BINDIR>/<EXECUTABLE_FILE>
stage/<INCLUDEDIR>/mylib/<HEADER_FILE>
stage/<LIBDIR>/<LIBRARY_FILE><BINDIR>、<INCLUDEDIR>、<LIBDIR> 由 GNUInstallDirs 和平台决定,文件名也可能因操作系统、编译器和库类型不同而变化。关键验收点是:可执行文件、公开头文件和库分别进入各自类别的安装目录,而不是散落在构建树里。
安装前缀与规则边界
cmake --install build --prefix <PATH> 可以在安装时覆盖前缀,适合临时验收和打包;也可以在配置阶段设置 CMAKE_INSTALL_PREFIX 作为默认前缀。无论使用哪种方式,都应让 DESTINATION 保持相对路径,除非确实需要写入固定的系统位置。
安装规则只应该发布用户真正需要的文件。测试程序、临时脚本、对象文件和私有头文件通常不应进入安装树。把安装目录先落到独立的 staging 目录,再检查其内容,是避免遗漏文件和误带开发产物的最直接方法。