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

Artikel
09/26/2024

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

Visual Studio mit C++-Entwicklungsarbeitsauslastung und CMake-Komponente
Git

1 – Einrichten von vcpkg

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 kuratierter Open-Source-Bibliotheken, die von der vcpkg-Community verwaltet werden. 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.
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

Erstellen des Visual Studio-Projekts
- Erstellen eines neuen Projekts in Visual Studio mithilfe der Vorlage "CMake Project"
Screenshot der Visual Studio-Benutzeroberfläche zum Erstellen eines neuen CMake-Projekts in Visual Studio
- 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".
Screenshot der Visual Studio-Benutzeroberfläche zum Benennen Ihres CMake-Projekts und Klicken auf die Schaltfläche "Erstellen".
Konfigurieren Sie die Umgebungsvariable VCPKG_ROOT.

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 das integrierte PowerShell-Fenster für Entwickler in Visual Studio.

Screenshot der Visual Studio-Benutzeroberfläche für das integrierte PowerShell-Entwicklerfenster

Führen Sie die folgenden Befehle aus:
```
$env:VCPKG_ROOT="C:\path\to\vcpkg"
$env:PATH="$env:VCPKG_ROOT;$env:PATH"
```
Screenshot der Visual Studio-Benutzeroberfläche für das integrierte PowerShell-Entwicklerfenster, in dem gezeigt wird, wie Sie VCPKG_ROOT einrichten und zu PATH hinzufügen können.
Öffnen Sie die Eingabeaufforderung für Entwickler in Visual Studio.

Screenshot der Visual Studio-Benutzeroberfläche für die Entwickler-Eingabeaufforderung.

Führen Sie die folgenden Befehle aus:
```
set "VCPKG_ROOT=C:\path\to\vcpkg"
set PATH=%VCPKG_ROOT%;%PATH%
```
Screenshot der Visual Studio-Eingabeaufforderung für Entwickler, die zeigt, wie sie VCPKG_ROOT einrichten und zu PATH hinzufügen.
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.
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

Ä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.
Konfigurieren Sie die CMakePresets.json Datei.

CMake kann Bibliotheken, die von vcpkg installiert werden, automatisch verknüpfen, wenn CMAKE_TOOLCHAIN_FILE die benutzerdefinierte Toolkette von vcpkg verwendet wird. Dies kann mithilfe von CMake-Voreinstellungen erstellt werden.

Ändern, CMakePresets.json um dem folgenden Inhalt zu entsprechen:
```
{
  "version": 2,
  "configurePresets": [
    {
      "name": "vcpkg",
      "generator": "Ninja",
      "binaryDir": "${sourceDir}/build",
      "cacheVariables": {
        "CMAKE_TOOLCHAIN_FILE": "$env{VCPKG_ROOT}/scripts/buildsystems/vcpkg.cmake"
      }
    }
  ]
}
```
Erstellen Sie CMakeUserPresets.json mit dem folgenden Inhalt:
```
{
    "version": 2,
    "configurePresets": [
      {
        "name": "default",
        "inherits": "vcpkg",
        "environment": {
          "VCPKG_ROOT": "<path to vcpkg>"
        }
      }
    ]
  }
```
Die CMakePresets.json Datei enthält eine einzelne Voreinstellung namens "vcpkg", die die CMAKE_TOOLCHAIN_FILE Variable festlegt. Die CMakeUserPresets.json Datei legt die VCPKG_ROOT Umgebungsvariable so fest, dass sie auf den absoluten Pfad zeigt, der Die lokale Installation von vcpkg enthält. Es wird empfohlen, keine Versionskontrollsysteme zu überprüfen CMakeUserPresets.json .
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 helloworld.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. Das REQUIRED Schlüsselwort 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. Das PRIVATE Schlüsselwort gibt an, dass fmt nur für das Erstellen HelloWorld erforderlich ist und nicht an andere abhängige Projekte weitergegeben werden soll.

4 – Erstellen und Ausführen des Projekts

Erstellen Sie das Projekt.

Drücken Sie Ctrl+Shift+B , um das Projekt in Visual Studio zu erstellen.
Führen Sie die Anwendung aus.

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

Screenshot der Visual Studio-Benutzeroberfläche zum Ausführen der ausführbaren Datei.

Die folgende Ausgabe sollte angezeigt werden:

Screenshot der Programmausgabe - "Hallo Welt!"

Nächste Schritte

Weitere vcpkg.jsonInformationen finden Sie in unserer Referenzdokumentation:

Freigeben über