CMake-Build-Beispiel
In diesem Artikel wird anhand eines vollständigen C++-Projektbeispiels gezeigt, wie Sie mit CMake von Grund auf ein Projekt erstellen, das sowohl ausführbare Dateien als auch Bibliotheksdateien enthält.
Das Beispielprojekt umfasst ein Hauptprogramm und eine benutzerdefinierte Bibliothek und deckt den vollständigen Lebenszyklus eines CMake-Builds ab.
Projektvorbereitung
Bevor Sie mit dem Build beginnen, erstellen Sie zuerst die Projektdateien und machen sich mit der Projektstruktur vertraut.
Projektstruktur
Das Beispielprojekt enthält eine Hauptprogramm-Quelldatei, eine Bibliotheks-Quelldatei und eine Bibliotheks-Headerdatei. Die Verzeichnisstruktur sieht wie folgt aus:
MyProject/
├── CMakeLists.txt # CMake 配置文件
├── src/
│ ├── main.cpp # 主程序源文件
│ └── mylib.cpp # 库源文件
└── include/
└── mylib.h # 库头文件
| Datei | Zweck | Beschreibung |
|---|---|---|
CMakeLists.txt |
CMake-Konfigurationsdatei | Definiert die Build-Regeln, Ziele und Abhängigkeiten des Projekts |
src/main.cpp |
Hauptprogramm-Quelldatei | Enthält die main()-Funktion, den Einstiegspunkt des Programms |
src/mylib.cpp |
Bibliotheks-Quelldatei | Implementierung der Funktionalität der benutzerdefinierten Bibliothek |
include/mylib.h |
Bibliotheks-Headerdatei | Deklariert die öffentliche Schnittstelle der Bibliothek, damit das Hauptprogramm sie einbinden und verwenden kann |
CMakeLists.txt-Konfigurationsdatei
Erstelle eine CMakeLists.txt-Datei im Stammverzeichnis von MyProject und schreibe den folgenden Inhalt:
Beispiel
# Minimale CMake-Version angeben (muss in der ersten Zeile der Datei stehen)
cmake_minimum_required(VERSION 3.10)
# Projektnamen und Versionsnummer definieren
project(MyProject VERSION 1.0)
# C++-Standard auf C++11 setzen und den Compiler verpflichten, ihn durchzusetzen
set(CMAKE_CXX_STANDARD 11)
set(CMAKE_CXX_STANDARD_REQUIRED ON)
# Globalen Header-Datei-Suchpfad hinzufügen
include_directories(${PROJECT_SOURCE_DIR}/include)
# Bibliotheksziel MyLib erstellen (Quelldatei: src/mylib.cpp)
add_library(MyLib src/mylib.cpp)
# Ausführbares Ziel MyExecutable erstellen (Quelldatei: src/main.cpp)
add_executable(MyExecutable src/main.cpp)
# Die Bibliothek MyLib mit dem ausführbaren Ziel MyExecutable verknüpfen
target_link_libraries(MyExecutable MyLib)
Die Funktion jeder Direktive in der Konfigurationsdatei ist wie folgt:
| Direktive | Funktion | Wichtiger Punkt |
|---|---|---|
cmake_minimum_required(VERSION 3.10) |
Mindest-CMake-Version angeben | Muss ganz oben in der Datei stehen; niedrigere Versionen führen zu einem Fehler |
project(MyProject VERSION 1.0) |
Projektname und Version definieren | Die Versionsnummer legt Variablen wie PROJECT_VERSION fest |
set(CMAKE_CXX_STANDARD 11) |
C++-Standard angeben | Mit CMAKE_CXX_STANDARD_REQUIRED verwenden, um dessen Erzwingung sicherzustellen |
include_directories(...) |
Header-Datei-Suchpfad hinzufügen | Ermöglicht es dem Compiler, Header-Dateien unter include/ zu finden |
add_library(MyLib ...) |
Bibliotheks-Target erstellen | Wenn kein Typ angegeben ist, bestimmt BUILD_SHARED_LIBS, ob es statisch oder dynamisch ist |
add_executable(MyExecutable ...) |
Executable-Target erstellen | Der Target-Name wird als Name der endgültig generierten ausführbaren Datei verwendet |
target_link_libraries(...) |
Bibliothek mit ausführbarer Datei verknüpfen | MyExecutable wird MyLib während der Kompilierung automatisch linken |
Jedes add_executable und add_library definiert einBuild-Target (Target).Das Konzept der Targets ist der Kern von CMake – nachfolgende Befehle wie target_include_directories, target_link_libraries usw. sind alle um Targets herum organisiert.
Detaillierte Build-Schritte
Wenn CMakeLists.txt vorhanden ist, schließen Sie den Projekt-Build ab und führen Sie ihn in den folgenden sechs Schritten aus.
Überblick über den Gesamtprozess:
| Schritt | Aktion | Befehl |
|---|---|---|
| 1 | CMakeLists.txt erstellen | Konfigurationsdatei manuell schreiben |
| 2 | Build-Verzeichnis erstellen | mkdir build && cd build |
| 3 | Projekt konfigurieren | cmake .. |
| 4 | Projekt bauen | makeodercmake --build . |
| 5 | Ausführbare Datei ausführen | ./MyExecutable |
| 6 | Build-Dateien bereinigen | make clean |
CMakeLists.txt-Datei erstellen
Erstellen Sie die Datei CMakeLists.txt im Stammverzeichnis von MyProject; ihre Inhalte wurden in den Konfigurationsanweisungen des vorherigen Abschnitts angegeben.
Dies ist der Ausgangspunkt des gesamten CMake-Builds; alle Build-Regeln sind in dieser Datei definiert.
Build-Verzeichnis erstellen
Um das Quellcodeverzeichnis sauber zu halten, wird empfohlen,Out-of-sourceden Out-of-Source-Build-Ansatz zu verwenden—erstellen Sie ein separates Build-Verzeichnis unter dem Projektstamm.
Öffnen Sie ein Terminal und navigieren Sie zum Verzeichnis MyProject:
# 创建构建目录 mkdir build # 进入构建目录(后续所有操作都在此目录执行) cd build
Fügen Sie das build-Verzeichnis zur .gitignore-Datei hinzu, um zu vermeiden, dass Build-Artefakte in die Versionskontrolle eingecheckt werden.
Projekt konfigurieren
Führen Sie CMake im build-Verzeichnis aus, um für die aktuelle Plattform geeignete Build-System-Dateien (z. B. Makefile) zu generieren.
..Verweisen Sie auf das Quellverzeichnis, das CMakeLists.txt enthält.
# 在 build 目录中运行 CMake 配置 cmake ..
CMake gibt die Konfigurationsergebnisse aus und zeigt den erkannten Compiler und den Konfigurationsstatus an. Wenn alles gut geht, sehen Sie eine Ausgabe ähnlich der folgenden:
-- 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
Wenn während der Konfiguration Fehler auftreten (z. B. ein fehlender Compiler oder eine zu alte CMake-Version), bricht CMake ab und gibt den konkreten Fehlergrund aus. Nachdem Sie das entsprechende Problem behoben haben, führen Sie den Vorgang erneut aus
cmake ..und das war's.
Projekt kompilieren
Nachdem die Build-Dateien generiert wurden, verwenden Sie den entsprechenden Build-Befehl, um das Projekt zu kompilieren.
Standardmäßig generiert CMake auf Unix-ähnlichen Systemen Makefiles, sodass Sie den make-Befehl direkt verwenden können.
# 在 build 目录中编译项目 make
Sobald die Kompilierung abgeschlossen ist, werden die ausführbare Datei MyExecutable und die Bibliotheksdatei libMyLib.a im build-Verzeichnis generiert.
Sie können auch den plattformübergreifenden generischen Build-Befehl verwenden:
# cmake --build . 会自动调用正确的底层构建工具 cmake --build .
Ausführbare Datei ausführen
Führen Sie nach einem erfolgreichen Build die generierte ausführbare Datei direkt im Build-Verzeichnis aus.
# 运行编译生成的可执行文件 ./MyExecutable # 预期输出示例 Hello from EXAMPLE! This is MyLib speaking.
Build-Dateien bereinigen
Der Clean-Vorgang löscht Zwischendateien (.o-Dateien usw.) und während der Kompilierung erzeugte Zieldateien und gibt Speicherplatz frei.
Verwenden Sie den Befehl make clean:
# 删除编译产生的中间文件和目标文件 make clean
Löschen Sie das Build-Verzeichnis manuell:
Wenn keine Clean-Regeln definiert sind, können Sie einfach das gesamte Build-Verzeichnis löschen.
# 回到项目根目录,删除 build 目录 cd .. rm -rf build
Das Löschen des gesamten Build-Verzeichnisses ist die gründlichste Art der Bereinigung. Für den nächsten Build führen Sie einfach erneut mkdir build && cd build && cmake .. && make aus, um von vorn zu beginnen.
Hinweise
Stellen Sie sicher, dass die Pfade der Quelldateien korrekt sind.Die Pfade der Quelldateien in add_executable und add_library sind relativ zu dem Verzeichnis, in dem CMakeLists.txt liegt. Wenn die Pfade falsch sind, meldet die CMake-Konfigurationsphase keinen Fehler, aber die Kompilierung beschwert sich, dass die Dateien nicht gefunden werden können.
Bei Zielnamen wird zwischen Groß- und Kleinschreibung unterschieden.MyLib und mylib sind unterschiedliche Ziele. Die in target_link_libraries referenzierten Zielnamen müssen exakt mit den in add_library definierten Zielnamen übereinstimmen.
Nach dem Ändern von CMakeLists.txt ist eine Neukonfiguration erforderlich.Wenn Sie nur Quelldateien geändert haben, führen Sie einfach make aus; wenn Sie jedoch CMakeLists.txt geändert haben (z. B. neue Dateien hinzugefügt oder Kompilierungsoptionen geändert haben), müssen Sie cmake .. erneut ausführen oder direkt cmake --build . ausführen (es erkennt Konfigurationsänderungen automatisch).
Weitere ErweiterungenFür Erstbenutzer empfiehlt es sich, mit einem einfachen Projekt zu beginnen.Bringen Sie zunächst den gesamten Build-Ablauf mit einer einzigen ausführbaren Datei zum Laufen und fügen Sie dann nach und nach Bibliotheken, externe Abhängigkeiten und benutzerdefinierte Kompilierungsoptionen hinzu. Wenn Sie auf einmal zu viele Dinge hinzufügen, wird die Fehlersuche schwieriger.