Verwenden von Containern zum Erstellen und Debuggen mit Visual Studio Code

Wenn Sie Visual Studio Code für die Anwendungsentwicklung verwenden, können Sie Ihr Projekt so einrichten, dass es in einem Container erstellt wird. Anschließend können Sie direkt im Container erstellen und debuggen. In diesem Thema wird davon ausgegangen, dass Sie ein Projekt mit Visual Studio Code erstellt haben, sodass das Vscode-Verzeichnis vorhanden ist und über die beiden Dateien launch.json und settings.json verfügt.

In diesem Thema wird die lokale Verwendung von Containern erläutert. Verwenden von GitHub Codespaces zum Erstellen und Debuggen beschreibt die Verwendung von GitHub Codespaces zum Bearbeiten, Erstellen, Bereitstellen und Debuggen Ihrer Azure Sphere-Apps.

Einrichten des Ordners ".devcontainer"

Erstellen Sie im Verzeichnis der obersten Ebene Ihres Projekts einen Ordner mit dem Namen .devcontainer. Erstellen Sie in diesem Ordner eine Datei namens devcontainer.json mit folgendem Inhalt:

{
    "name": "Azure Sphere Blink",
    "runArgs": [ "--cap-add=SYS_PTRACE", "--security-opt", "seccomp=unconfined"],
    "build": {
    "dockerfile": "Dockerfile",
    "target": "dev"
    },

    // Use 'settings' to set *default* container specific settings.json values on container create.
    // You can edit these settings after create using File > Preferences > Settings > Remote.
    "settings": {
            "terminal.integrated.shell.linux": "/bin/bash"
    },

    // Use 'appPort' to create a container with published ports. If the port isn't working, be sure
    // your server accepts connections from all interfaces (0.0.0.0 or '*'), not just localhost.
    // "appPort": [],

    // Uncomment the next line to run commands after the container is created.
    // "postCreateCommand": "gcc -v",

    // Comment out the next line if you want to run as root instead
    "remoteUser": "vscode",

    // Add the IDs of extensions you want installed when the container is created in the array below.
    "extensions": [
    "ms-vscode.cpptools",
    "ms-vscode.azure-sphere-tools",
    "ms-vscode.azure-sphere-tools-ui"
    ]
}

Erstellen Sie als Nächstes im Ordner .devcontainer eine Datei mit dem Namen Dockerfile mit folgendem Inhalt:

FROM mcr.microsoft.com/azurespheresdk:latest AS dev

FROM dev AS build
COPY ./ /src/
WORKDIR /out
RUN cmake -G "Ninja" -DCMAKE_TOOLCHAIN_FILE="/opt/azurespheresdk/CMakeFiles/AzureSphereToolchain.cmake" \
    -DAZURE_SPHERE_TARGET_API_SET="latest-lts" -DCMAKE_BUILD_TYPE="Release" "/src"
ENTRYPOINT [ "ninja" ]

Die erste FROM Zeile gibt das Azure Sphere-Standard-Docker-Image als Basisentwicklungscontainer an, und die zweite besagt, dass dieser Basiscontainer als Buildumgebung verwendet werden soll. Die COPY Zeile kopiert den Inhalt des Repositorys in das Verzeichnis /src/ des Containers. Gibt WORKDIR das Buildverzeichnis an. Der RUN Befehl stellt den CMake-Befehl bereit, um die Builddateien zu generieren. Schließlich gibt an ENTRYPOINT , dass Ninja aufgerufen werden soll, um die Anwendung tatsächlich zu erstellen.

Erstellen und Debuggen des Projekts

Öffnen Sie den Projektordner in Visual Studio Code. Visual Studio Code erkennt die neuen Dateien und öffnet ein Meldungsfeld mit der Meldung "Ordner enthält eine Dev Container-Konfigurationsdatei. Öffnen Sie den Ordner erneut, um in einem Container zu entwickeln." Wählen Sie die Schaltfläche In Container erneut öffnen aus, um den Ordner in dem Container erneut zu öffnen, der von der .devcontainer/Dockerfile-Datei erstellt wurde. Die Titelleiste in Visual Studio Code ändert sich, um anzuzeigen, dass Sie in einem Container bearbeiten. Wenn Sie die Registerkarte Erweiterungen in der linken Navigationsleiste öffnen, werden sowohl die lokal installierten als auch die im Container installierten Erweiterungen angezeigt.

Drücken Sie F5, um Ihr Projekt zu erstellen und mit dem Debuggen zu beginnen. Ihre Anwendung wird wie gewohnt erstellt und auf Ihr Gerät querladen. Wenn Sie einen Haltepunkt in Ihrem Code festgelegt haben, wird die App ausgeführt, bis der Haltepunkt erreicht ist. Sie können die üblichen Debugbefehle verwenden, um Ihren Code zu durchlaufen. Weitere Informationen finden Sie im Thema Debuggen in der Visual Studio Code-Dokumentation.

Wenn Sie mit dem Debuggen fertig sind, drücken Sie UMSCHALT+F5 oder das Symbol Beenden. Verwenden Sie zum Schließen des Containers den Befehl Remoteverbindung schließen im Menü Remote auf der Visual Studio Code-Symbolleiste.