kitware/cmake

CMake Docker 镜像文档

概述

CMake Docker 镜像是基于 CMake（跨平台开源构建系统）的容器化部署方案，提供预配置的 CMake 运行环境。该镜像旨在简化跨平台项目构建流程，消除本地环境依赖差异，支持快速集成到开发、测试及 CI/CD 流程中。

核心功能与特性

核心功能

• 跨平台构建支持：原生支持 Windows、Linux、macOS 等多平台项目构建，自动生成对应平台的构建文件（如 Makefile、Visual Studio 解决方案、Ninja 脚本等）。
• 多构建系统兼容：支持多种构建工具（Make、Ninja、Xcode、Visual Studio 等），可通过 -G 参数指定 Generator。
• 模块化配置：通过 CMakeLists.txt 脚本定义项目结构、依赖关系及构建规则，支持条件编译、变量传递和外部依赖管理。
• 缓存机制：自动生成 CMakeCache.txt 缓存构建配置，加速重复构建过程。

镜像特性

• 即开即用：无需本地安装 CMake，拉取镜像后直接运行构建命令。
• 版本化管理：提供多个标签（如 latest、3.28、3.27），支持指定 CMake 版本，满足不同项目兼容性需求。
• 环境隔离：构建过程在容器内隔离执行，避免影响宿主系统环境。
• 轻量高效：基于 Alpine 或 Debian 基础镜像，体积精简，启动速度快。

使用场景

1. 跨平台项目构建
   适用于需在不同操作系统（如 Linux 开发、Windows 部署）间保持一致构建流程的项目，如 C/C++ 跨平台应用、库开发等。

2. CI/CD 流程集成
   作为 CI/CD 流水线的构建环节，在 Jenkins、GitHub Actions、GitLab CI 等平台中自动化执行项目构建，确保流程一致性。

3. 开发环境标准化
   团队统一使用镜像版本，避免因本地 CMake 版本差异导致的“在我电脑上能运行”问题。

4. 临时构建任务
   快速验证第三方项目构建流程，无需在本地安装依赖，构建完成后自动清理容器（--rm 参数）。

使用方法与配置说明

基本使用

前提条件

• 已安装 Docker 引擎（20.10+ 版本推荐）。
• 项目根目录包含 CMakeLists.txt 文件。

基本构建命令

通过 docker run 启动容器，挂载项目目录并执行 CMake 命令：

bash
# 进入项目根目录，执行 CMake 生成构建文件
docker run --rm -v "$PWD":/app -w /app cmake:latest cmake .

# 生成构建文件后，执行 make 构建（需容器内包含 make，或使用对应构建工具）
docker run --rm -v "$PWD":/app -w /app cmake:latest make

• --rm：构建完成后自动删除容器，避免残留。
• -v "$PWD":/app：将当前目录（项目根目录）挂载到容器内 /app 目录。
• -w /app：设置容器工作目录为 /app（项目挂载路径）。
• cmake:latest：使用最新版本的 CMake 镜像。
• cmake .：执行 CMake 命令，生成构建文件（默认生成 Makefile）。

自定义构建

指定构建工具（Generator）

通过 -G 参数指定构建工具（如 Ninja、Visual Studio）：

bash
# 使用 Ninja 生成构建文件（需容器支持 Ninja，可选择包含 Ninja 的镜像标签，如 cmake:latest-ninja）
docker run --rm -v "$PWD":/app -w /app cmake:latest-ninja cmake -G Ninja .

设置 CMake 参数

通过 -D 参数传递 CMake 变量（如编译选项、安装路径等）：

bash
# 设置 CMAKE_BUILD_TYPE 为 Release，指定安装路径为 /app/install
docker run --rm -v "$PWD":/app -w /app cmake:latest cmake . -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=/app/install

版本选择

镜像标签对应 CMake 版本，可通过标签指定版本（完整版本列表见 https://hub.docker.com/_/cmake%EF%BC%89%EF%BC%9A

bash
# 使用 CMake 3.27 版本
docker run --rm -v "$PWD":/app -w /app cmake:3.27 cmake .

# 使用 CMake 3.26 版本（Alpine 基础镜像，体积更小）
docker run --rm -v "$PWD":/app -w /app cmake:3.26-alpine cmake .

高级配置

挂载缓存卷加速构建

CMake 缓存（如依赖下载缓存、编译中间文件）可通过卷挂载持久化，避免重复下载/编译：

bash
# 创建命名卷存储 CMake 缓存
docker volume create cmake_cache

# 挂载缓存卷到容器内 CMake 缓存目录
docker run --rm -v "$PWD":/app -v cmake_cache:/root/.cache -w /app cmake:latest cmake .

多阶段构建集成

在 Dockerfile 中集成 CMake 镜像实现多阶段构建（以 C++ 项目为例）：

dockerfile
# 阶段 1：使用 CMake 构建项目
FROM cmake:latest AS builder
WORKDIR /app
COPY . .
RUN cmake . -DCMAKE_BUILD_TYPE=Release && make -j4

# 阶段 2：构建运行时镜像
FROM alpine:latest
COPY --from=builder /app/bin/myapp /usr/local/bin/
CMD ["myapp"]

环境变量

CMake 镜像无预设环境变量，构建配置需通过命令行参数（如 -D）或 CMakeLists.txt 定义。常用 CMake 变量示例：

部署示例

docker run 示例

1. 生成构建文件并编译 Debug 版本

bash
docker run --rm -v "$PWD":/app -w /app cmake:3.28 cmake . -DCMAKE_BUILD_TYPE=Debug
docker run --rm -v "$PWD":/app -w /app cmake:3.28 make

2. 使用 Ninja 构建并安装项目

bash
# 假设使用包含 Ninja 的镜像标签
docker run --rm -v "$PWD":/app -w /app cmake:latest-ninja cmake -G Ninja . -DCMAKE_INSTALL_PREFIX=/app/install
docker run --rm -v "$PWD":/app -w /app cmake:latest-ninja ninja install

docker-compose 示例

创建 docker-compose.yml 配置文件，定义构建服务：

yaml
version: '3.8'
services:
  cmake-build:
    image: cmake:3.28
    volumes:
      - ./:/app
      - cmake_cache:/root/.cache  # 挂载缓存卷
    working_dir: /app
    command: cmake . -DCMAKE_BUILD_TYPE=Release && make -j4

volumes:
  cmake_cache:  # 持久化缓存卷

运行构建：

bash
docker-compose run cmake-build

注意事项

1. 文件权限：挂载宿主目录时，容器内默认使用 root 用户，可能导致构建产物权限问题。可通过 -u $(id -u):$(id -g) 指定用户 ID 解决：
   docker run --rm -u $(id -u):$(id -g) -v "$PWD":/app -w /app cmake:latest cmake .

2. 网络依赖：若构建需下载外部依赖（如 FetchContent），确保容器网络通畅（默认使用宿主网络）。

3. Windows 路径：Windows 系统下挂载目录需使用 / 分隔路径，示例：
   docker run --rm -v "C:/projects/myapp:/app" -w /app cmake:latest cmake .

4. 镜像标签选择：生产环境建议指定具体版本标签（如 3.28.1），避免 latest 标签自动更新导致兼容性问题。

参考链接

• CMake 官方文档
• https://hub.docker.com/_/cmake
• CMake Generator 列表