Lernprogramm: Installieren und Verwenden von Paketen mit CMake in Visual Studio

  • Artikel

In diesem Lernprogramm erfahren Sie, wie Sie ein C++-Programm "Hallo Welt" erstellen, das die fmt Bibliothek mit CMake, vcpkg und Visual Studio verwendet. Sie installieren Abhängigkeiten, konfigurieren, erstellen und führen eine einfache Anwendung aus.

Voraussetzungen

1 – Einrichten von vcpkg

  1. Klonen des Repositorys

    Der erste Schritt besteht darin, das vcpkg-Repository von GitHub zu klonen. Das Repository enthält Skripts zum Abrufen der ausführbaren Datei vcpkg und eine Registrierung von kuratierten Open-Source-Bibliotheken Standard von der vcpkg-Community enthalten. Führen Sie dazu Folgendes aus:

    git clone https://github.com/microsoft/vcpkg.git

    Die kuratierte vcpkg-Registrierung ist eine Reihe von mehr als 2.000 Open-Source-Bibliotheken. Diese Bibliotheken wurden von den kontinuierlichen Integrationspipelines von vcpkg überprüft, um zusammenzuarbeiten. Während das vcpkg-Repository nicht den Quellcode für diese Bibliotheken enthält, enthält es Rezepte und Metadaten zum Erstellen und Installieren in Ihrem System.

  2. Ausführen des Bootstrap-Skripts

    Nachdem Sie das vcpkg-Repository geklont haben, navigieren Sie zum vcpkg Verzeichnis, und führen Sie das Bootstrap-Skript aus:

    cd vcpkg && bootstrap-vcpkg.bat

    cd vcpkg; .\bootstrap-vcpkg.bat

    cd vcpkg && ./bootstrap-vcpkg.sh

    Das Bootstrap-Skript führt erforderliche Prüfungen durch und lädt die ausführbare Datei vcpkg herunter.

    Das ist alles! vcpkg ist eingerichtet und einsatzbereit.

2 – Einrichten des Visual Studio-Projekts

  1. Erstellen des Visual Studio-Projekts

    • Erstellen eines neuen Projekts in Visual Studio mithilfe der Vorlage "CMake Project"

    Erstellen eines neuen CMake-Projekts

    • Benennen Sie Ihr Projekt "helloworld"
    • Aktivieren Sie das Kontrollkästchen für "Projektmappe und Projekt im selben Verzeichnis platzieren".
    • Klicken Sie auf die Schaltfläche "Erstellen".

    Benennen Ihres CMake-Projekts

  2. Konfigurieren Sie die Umgebungsvariable VCPKG_ROOT.

    Öffnen Sie das integrierte PowerShell-Fenster für Entwickler in Visual Studio.

    Öffnen der integrierten PowerShell für Entwickler

    Führen Sie die folgenden Befehle aus:

    $env:VCPKG_ROOT = "C:\path\to\vcpkg"
$env:PATH = "$env:VCPKG_ROOT;$env:PATH"

    Einrichten von Umgebungsvariablen

    Hinweis

    Das Festlegen von Umgebungsvariablen auf diese Weise wirkt sich nur auf die aktuelle Terminalsitzung aus. Um diese Änderungen in allen Sitzungen dauerhaft vorzunehmen, legen Sie sie über den Bereich "Windows System Environment Variables" fest.

    Öffnen Sie die Eingabeaufforderung für Entwickler in Visual Studio.

    Öffnen der Visual Studio-Entwickler-Eingabeaufforderung.

    Führen Sie die folgenden Befehle aus:

    set VCPKG_ROOT="C:\path\to\vcpkg"
set PATH=%VCPKG_ROOT%;%PATH%

    Einrichten von Umgebungsvariablen

    Hinweis

    Das Festlegen von Umgebungsvariablen auf diese Weise wirkt sich nur auf die aktuelle Terminalsitzung aus. Um diese Änderungen in allen Sitzungen dauerhaft vorzunehmen, legen Sie sie über den Bereich "Windows System Environment Variables" fest.

    Die Einstellung VCPKG_ROOT hilft Visual Studio beim Auffinden Ihrer vcpkg-Instanz. PATH Durch das Hinzufügen wird sichergestellt, dass Sie vcpkg-Befehle direkt über die Shell ausführen können.

  3. Generieren Sie eine Manifestdatei, und fügen Sie Abhängigkeiten hinzu.

    Führen Sie den folgenden Befehl aus, um eine vcpkg-Manifestdatei (vcpkg.json) zu erstellen:

    vcpkg new --application

    Der vcpkg new Befehl fügt eine vcpkg.json Datei und eine vcpkg-configuration.json Datei im Verzeichnis des Projekts hinzu.

    Fügen Sie das fmt Paket als Abhängigkeit hinzu:

    vcpkg add port fmt

    Sie vcpkg.json sollten jetzt Folgendes enthalten:

    {
    "dependencies": [
        "fmt"
    ]
}

    Dies ist Ihre Manifestdatei. vcpkg liest die Manifestdatei, um zu erfahren, welche Abhängigkeiten installiert und in CMake integriert werden sollen, um die für Ihr Projekt erforderlichen Abhängigkeiten bereitzustellen.

    Die generierte vcpkg-configuration.json Datei führt einen Basisplan ein, der Mindestversionseinschränkungen für die Abhängigkeiten des Projekts einschließt. Das Ändern dieser Datei liegt außerhalb des Umfangs dieses Lernprogramms. In diesem Lernprogramm ist es zwar nicht anwendbar, aber es empfiehlt sich, die vcpkg-configuration.json Datei unter Quellcodeverwaltung zu halten, um die Versionskonsistenz in verschiedenen Entwicklungsumgebungen sicherzustellen.

3 – Einrichten der Projektdateien

  1. Ändern Sie die Datei helloworld.cpp.

    Ersetzen Sie den Inhalt durch helloworld.cpp den folgenden Code:

    #include <fmt/core.h>

int main()
{
    fmt::print("Hello World!\n");
    return 0;
}

    Diese Quelldatei enthält den <fmt/core.h> Header, der Teil der fmt Bibliothek ist. Die main() Funktion ruft fmt::print() auf, um die Meldung "Hallo Welt!" an die Konsole auszugeben.

  2. Konfigurieren Sie die CMakePresets.json Datei.

    • Benennen Sie die Datei CMakePresets.json in CMakeUserPresets.json um.
    • Aktualisieren Sie den Inhalt wie unten dargestellt. Ersetzen Sie <VCPKG_ROOT> den Pfad zu Ihrem vcpkg-Verzeichnis.
    {
  "version": 2,
  "configurePresets": [
    {
      "name": "default",
      "generator": "Ninja",
      "binaryDir": "${sourceDir}/build",
      "cacheVariables": {
        "CMAKE_TOOLCHAIN_FILE": "<VCPKG_ROOT>/scripts/buildsystems/vcpkg.cmake"
      }
    }
  ]
}
    • Da diese Datei einen hartcodierten absoluten Pfad enthält, wird empfohlen, diese Datei nicht unter der Quellcodeverwaltung zu behalten. Wenn Sie Git verwenden, fügen Sie Ihrer .gitignore Datei hinzuCMakeUserPresets.json.

    Die CMakeUserPresets.json Datei enthält eine einzelne Voreinstellung namens "default", diese Voreinstellung legt die Verwendung der CMAKE_TOOLCHAIN_FILE CMake-Toolchaindatei von vcpkg fest. Dadurch kann vcpkg Pakete für CMake bereitstellen, wenn Sie das Projekt konfigurieren und erstellen. Lesen Sie die vcpkg CMake-Integrationsdokumentation , um mehr zu erfahren.

  3. Bearbeiten Sie die CMakeLists.txt-Datei.

    Ersetzen Sie den Inhalt der Datei CMakeLists.txt durch den folgenden Code:

    cmake_minimum_required(VERSION 3.10)

project(HelloWorld)

find_package(fmt CONFIG REQUIRED)

add_executable(HelloWorld main.cpp)

target_link_libraries(HelloWorld PRIVATE fmt::fmt)

    Lassen Sie uns nun die Funktionsweise jeder Zeile in der CMakeLists.txt Datei aufschlüsseln:

    • cmake_minimum_required(VERSION 3.10): Gibt an, dass die zum Erstellen des Projekts erforderliche Mindestversion von CMake 3.10 ist. Wenn die auf Ihrem System installierte CMake-Version niedriger ist als dies, schlägt der Build fehl.
    • project(HelloWorld): Legt den Namen des Projekts auf "HelloWorld" fest.
    • find_package(fmt CONFIG REQUIRED): Sucht anhand der CMake-Konfigurationsdatei nach der fmt Bibliothek. Die REQUIRED Schlüsselwort (keyword) stellt sicher, dass ein Fehler generiert wird, wenn das Paket nicht gefunden wird.
    • add_executable(HelloWorld helloworld.cpp): Fügt ein ausführbares Ziel namens "HelloWorld" hinzu, das aus der Quelldatei helloworld.cpperstellt wurde.
    • target_link_libraries(HelloWorld PRIVATE fmt::fmt): Gibt an, dass die HelloWorld ausführbare Datei mit der fmt Bibliothek verknüpft werden soll. Die PRIVATE Schlüsselwort (keyword) weist darauf hin, dass fmt nur für das Bauen HelloWorld erforderlich ist und nicht an andere abhängige Projekte weitergegeben werden sollte.

4 – Erstellen und Ausführen des Projekts

  1. Erstellen Sie das Projekt.

    Drücken Sie Ctrl+Shift+B , um das Projekt in Visual Studio zu erstellen.

  2. Führen Sie die Anwendung aus.

    Führen Sie schließlich die ausführbare Datei aus:

    Ausführen der ausführbaren Datei

    Die folgende Ausgabe sollte angezeigt werden:

    Programmausgabe

Nächste Schritte

Weitere vcpkg.jsonInformationen finden Sie in unserer Referenzdokumentation: