Teilen über

Lernprogramm: Erstellen einer Projektvorlage

Mit .NET können Sie Vorlagen erstellen und bereitstellen, die Projekte, Dateien und Ressourcen generieren. Dieses Lernprogramm ist Teil zwei einer Reihe, in der Sie erfahren, wie Sie Vorlagen für die Verwendung mit dem dotnet new Befehl erstellen, installieren und deinstallieren.

Tipp

Die offiziellen .NET-Vorlagen, die mit dem .NET SDK ausgeliefert werden, finden Sie in den folgenden Repositorys:

Vorlagen Repository
Konsole, Klassenbibliothek und allgemeine Elementvorlagen dotnet/sdk
ASP.NET- und Blazor-Vorlagen dotnet/aspnetcore
ASP.NET Vorlagen für eine Einzelseitenanwendung dotnet/spa-templates
WPF-Vorlagen dotnet/wpf
Windows Forms-Vorlagen dotnet/winforms
Testvorlagen dotnet/test-templates
MAUI-Vorlagen dotnet/maui

Sie können die auf Ihrem Computer installierten Vorlagen anzeigen, indem Sie den dotnet new list Befehl ausführen.

In diesem Teil der Serie erfahren Sie, wie Sie:

  • Erstellen Sie die Ressourcen einer Projektvorlage.
  • Erstellen Sie den Vorlagenkonfigurationsordner und die Datei.
  • Installieren Sie eine Vorlage aus einem Dateipfad.
  • Testen Sie eine Elementvorlage.
  • Deinstallieren Sie eine Elementvorlage.

Voraussetzungen

  • .NET 9 oder eine höhere Version.

  • Vervollständigen Sie Teil 1 dieser Lernprogrammreihe.

  • Öffnen Sie ein Terminal, und navigieren Sie zum Ordner "Working\Content ".

Erstellen einer Projektvorlage

Projektvorlagen erstellen sofort einsatzbereite Projekte, mit denen Benutzer mit einem funktionierenden Codesatz beginnen können. .NET enthält einige Projektvorlagen wie eine Konsolenanwendung oder eine Klassenbibliothek. In diesem Beispiel erstellen Sie ein neues Konsolenanwendungsprojekt, das die standardmäßige "Hello World"-Konsolenausgabe durch eine Konsole ersetzt, die asynchron ausgeführt wird.

Navigieren Sie in Ihrem Terminal zum Ordner "Working\Content ", und erstellen Sie einen neuen Unterordner mit dem Namen "consoleasync". Wechseln Sie in den Unterordner und führen Sie dotnet new console aus, um die Standardkonsolenanwendung zu generieren. Bearbeiten Sie die von dieser Vorlage erstellten Dateien, um eine neue Vorlage zu erstellen.

working
└───content
    └───consoleasync
            consoleasync.csproj
            Program.cs

Program.cs ändern

Öffnen Sie die Program.cs Datei. Das Standardkonsolenprojekt schreibt nicht asynchron in die Konsolenausgabe, daher sollten Sie dies hinzufügen. Ändern Sie den Code wie folgt, und speichern Sie die Datei:

// See https://aka.ms/new-console-template for more information
await Console.Out.WriteAsync("Hello World with C#");

Nachdem Sie nun den Inhalt der Vorlage erstellt haben, müssen Sie die Vorlagenkonfiguration im Stammordner der Vorlage erstellen.

Erstellen Sie die Vorlagenkonfiguration

In diesem Lernprogramm befindet sich Ihr Vorlagenordner unter "working\content\consoleasync".

Vorlagen werden von .NET erkannt, da sie über einen speziellen Ordner und eine konfigurationsdatei im Stammverzeichnis Des Vorlagenordners verfügen.

Erstellen Sie zunächst einen neuen Unterordner mit dem Namen .template.config, und geben Sie ihn ein. Erstellen Sie dann eine neue Datei mit dem Namen template.json. Die Ordnerstruktur sollte wie folgt aussehen:

working
└───content
    └───consoleasync
        └───.template.config
                template.json

Öffnen Sie die template.json mit Ihrem bevorzugten Text-Editor, und fügen Sie den folgenden JSON-Code ein, und speichern Sie sie.

{
  "$schema": "http://json.schemastore.org/template",
  "author": "Me",
  "classifications": [ "Common", "Console" ],
  "identity": "ExampleTemplate.AsyncProject",
  "name": "Example templates: async project",
  "shortName": "consoleasync",
  "sourceName":"consoleasync",
  "tags": {
    "language": "C#",
    "type": "project"
  }
}

Diese Konfigurationsdatei enthält alle Einstellungen für Ihre Vorlage. Sie können die grundlegenden Einstellungen sehen, wie name und shortName, aber es gibt auch einen tags/type-Wert, der auf project gesetzt ist. Dadurch wird Ihre Vorlage als "Projekt"-Vorlage kategorisiert. Es gibt keine Einschränkung beim Typ der Vorlage, die Sie erstellen. Die item und project Werte sind allgemeine Namen, die .NET empfiehlt, damit Benutzer den Typ der Vorlage, nach der sie suchen, problemlos filtern können.

Das sourceName Element wird ersetzt, wenn der Benutzer die Vorlage verwendet. Der Wert sourceName in der Konfigurationsdatei wird in jedem Dateinamen und Dateiinhalt gesucht und standardmäßig durch den Namen des aktuellen Ordners ersetzt. Wenn der -n--name Parameter mit dem dotnet new Befehl übergeben wird, wird der angegebene Wert anstelle des aktuellen Ordnernamens verwendet. Im Fall dieser Vorlage wird consoleasync im Namen der .csproj-Datei ersetzt.

Das classifications Element stellt die Tags-Spalte dar, die Sie sehen, wenn Sie dotnet new ausführen und eine Liste mit Vorlagen erhalten. Benutzer können auch basierend auf Klassifizierungstags suchen. Verwechseln Sie die tags Eigenschaft in der template.json Datei nicht mit der classifications Tagsliste. Es handelt sich um zwei verschiedene Konzepte, die leider gleich genannt werden. Das vollständige Schema für die template.json-Datei finden Sie im JSON Schema Store und wird unter Reference for template.jsonbeschrieben. Weitere Informationen zur template.json-Datei finden Sie im Dotnet-Vorlagenwiki.

Nachdem Sie nun über eine gültige .template.config/template.json Datei verfügen, kann Ihre Vorlage installiert werden. Bevor Sie die Vorlage installieren, stellen Sie sicher, dass Sie alle zusätzlichen Ordner und Dateien löschen, die Sie nicht in Ihrer Vorlage enthalten möchten, z. B. die Ordner "Bin" oder " Obj ". Navigieren Sie in Ihrem Terminal zum Ordner "consoleasync ", und führen Sie die Ausführung aus dotnet new install .\ , um die Vorlage im aktuellen Ordner zu installieren. Wenn Sie ein Linux- oder macOS-Betriebssystem verwenden, verwenden Sie einen Schrägstrich: dotnet new install ./.

dotnet new install .\

Mit diesem Befehl wird eine Liste der installierten Vorlagen ausgegeben, die Ihre enthalten sollten.

The following template packages will be installed:
   <root path>\working\content\consoleasync

Success: <root path>\working\content\consoleasync installed the following templates:
Templates                                         Short Name               Language          Tags
--------------------------------------------      -------------------      ------------      ----------------------
Example templates: async project                  consoleasync             [C#]              Common/Console

Testen der Projektvorlage

Nachdem Sie nun eine Projektvorlage installiert haben, testen Sie sie.

  1. Navigieren Sie zum Testordner .

  2. Erstellen Sie eine neue Konsolenanwendung mit dem folgenden Befehl, der ein funktionierendes Projekt generiert, das Sie problemlos mit dem dotnet run Befehl testen können.

    dotnet new consoleasync -n MyProject

    Sie erhalten die folgende Ausgabe.

    The template "Example templates: async project" was created successfully.

  3. Führen Sie das Projekt mit dem folgenden Befehl aus.

    dotnet run

    Sie erhalten die folgende Ausgabe.

    Hello World with C#

Glückwunsch! Sie haben eine Projektvorlage mit .NET erstellt und bereitgestellt. Deinstallieren Sie in Vorbereitung auf den nächsten Teil dieser Lernprogrammreihe die von Ihnen erstellte Vorlage. Stellen Sie sicher, dass auch alle Dateien aus dem Testordner gelöscht werden. Dies bringt Sie zurück in einen sauberen Zustand, sodass Sie bereit sind für den nächsten Teil dieser Tutorial-Serie.

Deinstallieren der Vorlage

Navigieren Sie in Ihrem Terminal zum Ordner "consoleasync ", und führen Sie den folgenden Befehl aus, um die Vorlage zu deinstallieren, die sich im aktuellen Ordner befindet:

  • Unter Windows: dotnet new uninstall .\
  • Unter Linux oder macOS: dotnet new uninstall ./

Dieser Befehl gibt eine Liste der Vorlagen aus, die deinstalliert wurden und Ihre Vorlage enthalten sollten.

Success: <root path>\working\content\consoleasync was uninstalled.

Zu jeder Zeit können Sie mit dotnet new uninstall eine Liste der installierten Vorlagenpakete aufrufen, einschließlich des jeweiligen Befehls zum Deinstallieren jedes Vorlagenpakets.

Nächste Schritte

In diesem Tutorial haben Sie eine Projektvorlage erstellt. Wenn Sie erfahren möchten, wie Sie sowohl die Element- als auch projektvorlagen in eine einfach zu verwendende Datei verpacken, fahren Sie mit dieser Lernprogrammreihe fort.

Erstellen eines Vorlagenpakets

  • Last updated on