Практическое упражнение по CMake

В этой статье показано, как использовать CMake для управления проектом на C++ средней сложности, охватывая полный процесс от создания проекта до компиляции и выполнения.

Содержание охватывает базовую конфигурацию, компоновку библиотек, модульное тестирование, пользовательские команды и продвинутые возможности, такие как кроссплатформенная кросс-компиляция.


Процесс сборки CMake

На следующей диаграмме показан полный процесс сборки CMake от исходного кода до итогового исполняемого файла:

CMake 构建流程


Обзор проекта

Мы создадим проект на C++, который содержит главную программу, статическую библиотеку и модульные тесты.

Библиотека предоставляет математические операции (сложение, вычитание, умножение). Главная программа вызывает эти функции, а тестовый код проверяет их корректность.

Структура каталогов проекта

MyProject/
├── CMakeLists.txt          # 根构建配置(项目定义、全局设置)
├── src/
│   ├── main.cpp            # 主程序入口
│   ├── CMakeLists.txt      # src 子目录构建配置(库 + 可执行文件)
│   ├── lib/
│   │   ├── module1.cpp     # 数学模块一:加法、减法
│   │   └── module2.cpp     # 数学模块二:乘法
│   └── include/
│       └── mylib.h         # 公共头文件(函数声明)
└── tests/
    ├── test_main.cpp       # 单元测试用例
    └── CMakeLists.txt      # 测试子目录构建配置

Сборка вне исходного каталогаЭто лучшая практика CMake: все артефакты сборки (Makefiles, объектные файлы, исполняемые файлы) размещаются в отдельном каталоге сборки, что сохраняет исходный каталог чистым.


Создание файла CMakeLists.txt

CMakeLists.txt — это основной файл конфигурации CMake. Он использует иерархическую структуру: один находится в корневом каталоге, а по одному — в каждом подкаталоге.

CMakeLists.txt в корневом каталоге

Корневая конфигурация определяет информацию уровня проекта и управляет подкаталогами через add_subdirectory.

Пример

cmake_minimum_required(VERSION 3.10)    # Укажите минимально требуемую версию CMake
project(MyProject VERSION 1.0)          # Определите имя и версию проекта

# Установить стандарт C++ в C++11 и сделать его обязательным
set(CMAKE_CXX_STANDARD 11)
set(CMAKE_CXX_STANDARD_REQUIRED ON)

# Добавить глобальный путь поиска заголовочных файлов (PROJECT_SOURCE_DIR — корневой каталог проекта)
include_directories(${PROJECT_SOURCE_DIR}/src/include)

# Добавить подкаталоги; CMake обработает их файлы CMakeLists.txt в порядке следования
add_subdirectory(src)      # Обработать библиотеку и исполняемый файл
add_subdirectory(tests)    # Обработать тесты

CMakeLists.txt в каталоге src

Этот файл определяет цель библиотеки (MyLib) и цель исполняемого файла (MyExecutable) и устанавливает зависимость.

Пример

# Создать цель статической библиотеки MyLib, состоящую из двух исходных файлов
add_library(MyLib STATIC
    lib/module1.cpp
    lib/module2.cpp
)

# Указать путь к публичным заголовочным файлам для MyLib (PUBLIC означает, что потребители также унаследуют этот путь)
target_include_directories(MyLib PUBLIC ${CMAKE_SOURCE_DIR}/src/include)

# Создать исполняемую цель MyExecutable
add_executable(MyExecutable main.cpp)

# Связать MyLib с исполняемым файлом (PRIVATE означает, что только MyExecutable нуждается в ней)
target_link_libraries(MyExecutable PRIVATE MyLib)

Разница между PRIVATE и PUBLIC:PRIVATEУказывает, что зависимость требуется только текущей цели,PUBLICУказывает, что зависимость распространяется на другие цели, которые линкуются с текущей целью.

CMakeLists.txt каталога tests

Конфигурация тестов использует фреймворк Google Test; сначала найдите и подключите пакет GTest.

Пример

# Добавьте следующее содержимое в src/CMakeLists.txt

# Вывести сообщение после сборки MyExecutable
add_custom_command(
    TARGET MyExecutable
POST_BUILD # Выполнить после сборки
COMMAND ${CMAKE_COMMAND} -E echo "Сборка MyExecutable завершена!"
COMMENT "Вывести сообщение о завершении сборки" # Комментарий, отображаемый в журнале сборки
)

Пользовательские цели (add_custom_target)

Пользовательская цель — это независимая цель, которая не создаёт выходные файлы и используется для выполнения определённых задач.

Пример

# Добавьте следующее в src/CMakeLists.txt

# Создайте цель run для выполнения скомпилированной программы
add_custom_target(run
    COMMAND ${CMAKE_BINARY_DIR}/src/MyExecutable
    DEPENDS MyExecutable                # Зависит от MyExecutable, чтобы гарантировать, что он собран первым
    COMMENT "Запустить MyExecutable"
)

Запуск пользовательской цели:

# 在 build 目录下执行
make run
# 或
cmake --build . --target run

Различия между пользовательскими командами и пользовательскими целями:add_custom_commandПривязана к цели, запускается на определённом этапе сборки цели;add_custom_targetЯвляется независимой целью, выполняется только при явном указании.


Кроссплатформенность и кросс-компиляция

Одно из ключевых преимуществ CMake — поддержка кроссплатформенности, позволяющая легко переключать целевые платформы и архитектуры.

Указание целевой платформы

Целевую платформу можно задать с помощью переменной CMAKE_SYSTEM_NAME.

# 为 Linux 平台交叉编译
cmake -DCMAKE_SYSTEM_NAME=Linux ..

# 为 Windows 平台交叉编译
cmake -DCMAKE_SYSTEM_NAME=Windows ..

Использование файлов инструментальной цепочки

Для сложных сценариев кросс-компиляции рекомендуется использовать файл инструментальной цепочки для централизованного управления всеми конфигурациями, связанными с платформой.

Сначала создайте файл инструментальной цепочки toolchain.cmake:

Пример

# Путь к файлу: MyProject/toolchain.cmake
# Конфигурация инструментальной цепочки кросс-компиляции для ARM Linux

# Укажите целевую систему
set(CMAKE_SYSTEM_NAME Linux)
set(CMAKE_SYSTEM_PROCESSOR arm)

# Укажите путь к кросс-компилятору (настройте в соответствии с фактическим окружением)
set(CMAKE_C_COMPILER arm-linux-gnueabihf-gcc)
set(CMAKE_CXX_COMPILER arm-linux-gnueabihf-g++)

# Укажите путь к корневой файловой системе целевой системы (необязательно, используется для поиска библиотек и заголовочных файлов)
set(CMAKE_FIND_ROOT_PATH /path/to/arm/sysroot)

# Искать программы только в целевом sysroot (не в хост-системе)
set(CMAKE_FIND_ROOT_PATH_MODE_PROGRAM NEVER)
# Искать файлы библиотек только в целевом sysroot
set(CMAKE_FIND_ROOT_PATH_MODE_LIBRARY ONLY)
# Искать заголовочные файлы только в целевом sysroot
set(CMAKE_FIND_ROOT_PATH_MODE_INCLUDE ONLY)

Сборка с использованием файла цепочки инструментов:

# 在 build 目录下执行
cmake -DCMAKE_TOOLCHAIN_FILE=../toolchain.cmake ..
cmake --build .

Файл цепочки инструментов централизованно управляет конфигурациями, связанными с платформой, такими как компиляторы, компоновщики и пути к библиотекам, поэтому для переключения целевых платформ достаточно указать другой файл цепочки инструментов, не изменяя CMakeLists.txt.


Типы сборки и общие параметры

CMake поддерживает несколько типов сборки, управляемых переменной CMAKE_BUILD_TYPE.

Тип сборки Параметры компилятора Применимые сценарии
Debug -g (отладочные символы) Фаза разработки и отладки, когда необходимы точки останова и проверка значений переменных
Release -O2 -DNDEBUG (оптимизация + удаление утверждений) Релиз для продакшена, нацеленный на скорость выполнения
RelWithDebInfo -O2 -g (оптимизация + отладочные символы) Версия Release, требующая анализа производительности или оптимизированной отладки
MinSizeRel -Os (оптимизация размера) Встроенные системы или сценарии, чувствительные к размеру

Указание типа сборки:

# Debug 构建
cmake -DCMAKE_BUILD_TYPE=Debug ..

# Release 构建
cmake -DCMAKE_BUILD_TYPE=Release ..
Другие расширения