Ejemplo de construcción con CMake

Este artículo utiliza un proyecto completo de ejemplo en C++ para demostrar cómo usar CMake para construir desde cero un proyecto que incluye un archivo ejecutable y archivos de biblioteca.

El proyecto de ejemplo incluye un programa principal y una biblioteca personalizada, cubriendo el ciclo de vida completo de una construcción con CMake.


Preparación del proyecto

Antes de comenzar la construcción, primero cree los archivos del proyecto y comprenda la estructura del proyecto.

Estructura del proyecto

El proyecto de ejemplo contiene un archivo fuente del programa principal, un archivo fuente de la biblioteca y un archivo de cabecera de la biblioteca. La estructura de directorios es la siguiente:

MyProject/
├── CMakeLists.txt          # CMake 配置文件
├── src/
│   ├── main.cpp            # 主程序源文件
│   └── mylib.cpp           # 库源文件
└── include/
    └── mylib.h             # 库头文件
Archivo Función Descripción
CMakeLists.txt Archivo de configuración de CMake Define las reglas de construcción, los objetivos y las dependencias del proyecto
src/main.cpp Archivo fuente del programa principal Contiene la función main(), el punto de entrada del programa
src/mylib.cpp Archivo fuente de la biblioteca Implementación de las funciones de la biblioteca personalizada
include/mylib.h Archivo de cabecera de la biblioteca Declaración de la interfaz pública de la biblioteca, para que el programa principal la incluya y la use

Archivo de configuración CMakeLists.txt

Cree el archivo CMakeLists.txt en el directorio raíz de MyProject y escriba el siguiente contenido:

Ejemplo

# Ruta del archivo: MyProject/CMakeLists.txt

# Especificar la versión mínima de CMake (debe colocarse en la primera línea del archivo)
cmake_minimum_required(VERSION 3.10)

# Definir el nombre del proyecto y el número de versión
project(MyProject VERSION 1.0)

# Establecer el estándar de C++ como C++11 y exigir que el compilador lo use forzosamente
set(CMAKE_CXX_STANDARD 11)
set(CMAKE_CXX_STANDARD_REQUIRED ON)

# Agregar ruta de búsqueda global para archivos de encabezado
include_directories(${PROJECT_SOURCE_DIR}/include)

# Crear el target de biblioteca MyLib (archivo fuente: src/mylib.cpp)
add_library(MyLib src/mylib.cpp)

# Crear el target de ejecutable MyExecutable (archivo fuente: src/main.cpp)
add_executable(MyExecutable src/main.cpp)

# Vincular la biblioteca MyLib al ejecutable MyExecutable
target_link_libraries(MyExecutable MyLib)

La función de cada directiva en el archivo de configuración es la siguiente:

Directiva Función Punto clave
cmake_minimum_required(VERSION 3.10) Especificar la versión mínima de CMake Debe colocarse en la parte superior del archivo; una versión inferior a esta mostrará un error
project(MyProject VERSION 1.0) Definir el nombre y la versión del proyecto El número de versión establece variables como PROJECT_VERSION
set(CMAKE_CXX_STANDARD 11) Especificar el estándar de C++ Combinado con CMAKE_CXX_STANDARD_REQUIRED para garantizar su uso obligatorio
include_directories(...) Añadir ruta de búsqueda de archivos de cabecera Permite al compilador encontrar los archivos de cabecera en include/
add_library(MyLib ...) Crear el objetivo de la biblioteca Cuando no se especifica el tipo, BUILD_SHARED_LIBS determina si es estática o dinámica
add_executable(MyExecutable ...) Crear el objetivo del ejecutable El nombre del objetivo será el nombre del archivo ejecutable generado
target_link_libraries(...) Enlazar la biblioteca al ejecutable MyExecutable enlazará automáticamente con MyLib durante la compilación

Cada add_executable y add_library define unobjetivo de compilación (Target)El concepto de objetivo es el núcleo de CMake: las directivas posteriores como target_include_directories, target_link_libraries, etc., se organizan en torno a los objetivos.


Explicación detallada de los pasos de construcción

Con CMakeLists.txt listo, complete la construcción y ejecución del proyecto siguiendo los siguientes seis pasos.

Resumen del flujo general:

Paso Operación Comando
1 Crear CMakeLists.txt Escribir manualmente el archivo de configuración
2 Crear el directorio de compilación mkdir build && cd build
3 Configurar el proyecto cmake ..
4 Compilar el proyecto makeocmake --build .
5 Ejecutar el archivo ejecutable ./MyExecutable
6 Limpiar los archivos de compilación make clean

Crear el archivo CMakeLists.txt

Cree el archivo CMakeLists.txt en el directorio raíz de MyProject. Su contenido ya se proporcionó en la descripción de configuración de la sección anterior.

Este es el punto de partida de toda la construcción con CMake; todas las reglas de construcción se definen en este archivo.

Crear el directorio de compilación

Para mantener limpio el directorio del código fuente, se recomienda utilizar elOut-of-sourcemétodo de compilación: crear un directorio de compilación independiente en el directorio raíz del proyecto.

Abra una terminal y entre en el directorio MyProject:

# 创建构建目录
mkdir build

# 进入构建目录(后续所有操作都在此目录执行)
cd build

Añada el directorio build al archivo .gitignore para evitar enviar los artefactos de compilación al sistema de control de versiones.

Configurar el proyecto

Ejecute CMake en el directorio de compilación para generar los archivos del sistema de compilación adecuados para la plataforma actual (como Makefile).

..Apunta al directorio del código fuente que contiene CMakeLists.txt.

# 在 build 目录中运行 CMake 配置
cmake ..

CMake mostrará el resultado de la configuración, indicando el compilador detectado y el estado de la configuración. Si todo es normal, verá una salida similar a la siguiente:

-- The CXX compiler identification is GNU 11.4.0
-- Detecting CXX compiler ABI info - done
-- Configuring done
-- Generating done
-- Build files have been written to: /path/to/MyProject/build

Si se produce un error durante la configuración (como la falta de un compilador o una versión de CMake demasiado baja), CMake se detendrá y mostrará la causa específica del error. Después de resolver el problema correspondiente, vuelva a ejecutarcmake ..y listo.

Compilar el proyecto

Una vez generados los archivos de compilación, use el comando de compilación correspondiente para compilar el proyecto.

Por defecto, CMake genera Makefile en sistemas tipo Unix, por lo que puede usar directamente el comando make.

# 在 build 目录中编译项目
make

Después de la compilación, en el directorio build se generarán el ejecutable MyExecutable y el archivo de biblioteca libMyLib.a.

También puede usar el comando de compilación universal multiplataforma:

# cmake --build . 会自动调用正确的底层构建工具
cmake --build .

Ejecutar el archivo ejecutable

Después de una compilación exitosa, ejecute directamente el archivo ejecutable generado en el directorio de compilación.

# 运行编译生成的可执行文件
./MyExecutable

# 预期输出示例
Hello from EJEMPLO! This is MyLib speaking.

Limpiar los archivos de compilación

La operación de limpieza elimina los archivos intermedios generados durante la compilación (archivos .o, etc.) y los archivos objeto, liberando espacio en disco.

Use el comando make clean:

# 删除编译产生的中间文件和目标文件
make clean

Elimine manualmente el directorio de compilación:

Si no hay reglas de limpieza definidas, puede eliminar directamente todo el directorio de compilación.

# 回到项目根目录,删除 build 目录
cd ..
rm -rf build

Eliminar todo el directorio build es la forma más completa de limpiar. En la próxima compilación, solo necesita volver a ejecutar mkdir build && cd build && cmake .. && make para empezar desde cero.


Notas

Asegúrese de que las rutas de los archivos fuente sean correctas.Las rutas de los archivos fuente en add_executable y add_library son relativas al directorio donde se encuentra CMakeLists.txt. Si las rutas están mal escritas, CMake no mostrará un error en la fase de configuración, pero durante la compilación indicará que no se encuentran los archivos.

Los nombres de los objetivos distinguen entre mayúsculas y minúsculas.MyLib y mylib son objetivos diferentes. El nombre del objetivo referenciado en target_link_libraries debe coincidir exactamente con el nombre del objetivo definido por add_library.

Después de modificar CMakeLists.txt es necesario volver a configurar.Si solo ha modificado los archivos fuente, ejecute make directamente; pero si ha modificado CMakeLists.txt (como añadir nuevos archivos o cambiar opciones de compilación), necesita volver a ejecutar cmake .. o ejecutar directamente cmake --build . (detectará automáticamente los cambios de configuración).

Para quienes lo usan por primera vez, se recomienda comenzar con un proyecto simple.Primero use un solo ejecutable para completar todo el proceso de compilación y luego agregue gradualmente bibliotecas, dependencias externas y opciones de compilación personalizadas. Agregar demasiadas cosas a la vez dificultará la depuración de errores.

Otras extensiones