dotnet aspnet-codegenerator

Von Rick Anderson

dotnet aspnet-codegenerator: Führt die ASP.NET Core-Gerüstbauengine aus. dotnet aspnet-codegenerator wird nur für den Gerüstbau über die Befehlszeile benötigt, nicht zum Gerüstbau mit Visual Studio.

Installieren und Aktualisieren von aspnet-codegenerator

Installieren Sie das .NET SDK.

dotnet aspnet-codegenerator ist ein globales Tool, das installiert werden muss. Über den folgenden Befehl wird die neueste stabile Version des dotnet aspnet-codegenerator-Tools installiert:

dotnet tool install -g dotnet-aspnet-codegenerator

Hinweis

Standardmäßig stellt die Architektur der zu installierenden .NET-Binärdateien die derzeit ausgeführte Betriebssystemarchitektur dar. Informationen zum Angeben einer anderen Betriebssystemarchitektur finden Sie unter dotnet tool install, --arch option. Weitere Informationen finden Sie unter dem GitHub Issue dotnet/docs #29262.

Mit dem folgenden Befehl wird dotnet aspnet-codegenerator auf die neueste stabile Version aktualisiert, die in den installierten .NET Core SDKs verfügbar ist:

dotnet tool update -g dotnet-aspnet-codegenerator

Deinstallieren von aspnet-codegenerator

Es kann erforderlich sein, aspnet-codegenerator zu deinstallieren, um Probleme zu beheben. Wenn Sie z. B. eine Vorschauversion von aspnet-codegeneratorinstalliert haben, deinstallieren Sie diese, bevor Sie die veröffentlichte Version installieren.

Über den folgenden Befehl wird die neueste stabile Version des dotnet aspnet-codegenerator-Tools installiert:

dotnet tool uninstall -g dotnet-aspnet-codegenerator
dotnet tool install -g dotnet-aspnet-codegenerator

Übersicht

dotnet aspnet-codegenerator [arguments] [-p|--project] [-n|--nuget-package-dir] [-c|--configuration] [-tfm|--target-framework] [-b|--build-base-path] [--no-build] 
dotnet aspnet-codegenerator [-h|--help]

Beschreibung

Der globale Befehl dotnet aspnet-codegenerator führt den ASP.NET Code-Codegenerator und die Gerüstbauengine aus.

Argumente

generator

Der auszuführende Codegenerator. Folgende Generatoren sind verfügbar:

Generator Vorgang
area Gerüstbau für einen Bereich
Controller Gerüstbau für einen Controller
Identität Gerüstbau Identity
razorpage Gerüstbau für Razor Pages
Sicht Gerüstbau für eine Ansicht

Optionen

-n|--nuget-package-dir

Gibt das NuGet-Paketverzeichnis an.

-c|--configuration {Debug|Release}

Legt die Buildkonfiguration fest. Der Standardwert ist Debug.

-tfm|--target-framework

Das zu verwendende Zielframework. Beispielsweise net46.

-b|--build-base-path

Der Basispfad für den Build.

-h|--help

Druckt eine kurze Hilfe für den Befehl.

--no-build

Erstellt das Projekt nicht vor der Ausführung. Zudem wird das Flag --no-restore implizit festgelegt.

-p|--project <PATH>

Gibt den Pfad der auszuführenden Projektdatei an (Ordnername oder vollständiger Pfad). Wenn nicht angegeben, wird standardmäßig das aktuelle Verzeichnis gewählt.

Generatoroptionen

In den folgenden Abschnitte werden die verfügbaren Optionen für die unterstützten Generatoren vorgestellt:

  • Bereich
  • Controller
  • Identity
  • Razorpage
  • Ansicht

Bereichsoptionen

Dieses Tool ist für ASP.NET Core-Webprojekte mit Controllern und Ansichten vorgesehen. Es ist nicht für Razor Pages-Apps gedacht.

Verwendung: dotnet aspnet-codegenerator area AreaNameToGenerate

Der oben gezeigte Befehl generiert die folgenden Ordner:

  • Bereiche
    • AreaNameToGenerate
      • Controller
      • Data
      • Models
      • Ansichten

Controlleroptionen

In der folgenden Tabelle sind Optionen für aspnet-codegeneratorrazorpage, controller und view aufgelistet:

Option BESCHREIBUNG
--model oder -m Die Modellklasse, die verwendet werden soll.
--dataContext oder -dc Die zu verwendende DbContext-Klasse oder der Name der zu generierenden Klasse.
--bootstrapVersion oder -b Gibt die Bootstrap-Version an. Gültige Werte sind 3 und 4. Der Standardwert ist 4. Falls benötigt und noch nicht vorhanden, wird ein wwwroot-Verzeichnis erstellt, das die Bootstrap-Dateien der angegebenen Version enthält.
--referenceScriptLibraries oder -scripts Verweist auf Skriptbibliotheken in den erstellten Ansichten. Fügt _ValidationScriptsPartial zum Bearbeiten und Erstellen von Seiten hinzu.
--layout oder -l Benutzerdefinierte Layoutseite, die verwendet werden soll.
--useDefaultLayout oder -udl Verwendet das Standardlayout für die Ansichten.
--force oder -f Überschreibt vorhandene Dateien.
--relativeFolderPath oder -outDir Angeben des relativen Ausgabeordnerpfads von dem Projekt aus, in dem die Datei generiert werden muss. Falls nicht angegeben, wird die Datei im Projektordner generiert.
--useSqlite oder -sqlite Flag, um anzugeben, ob DbContext SQLite anstelle von SQL Server verwenden sollte.

Die folgende Tabelle zeigt die Optionen für aspnet-codegenerator controller:

Option Beschreibung
--controllerName oder -name Der Name des Controllers.
--useAsyncActions oder -async Generiert asynchrone Controlleraktionen.
--noViews oder -nv Generiert keine Ansichten.
--restWithNoViews oder -api Generiert einen Controller mit einer API im REST-Stil. noViews wird vorausgesetzt, und ansichtsbezogene Optionen werden ignoriert.
--readWriteActions oder -actions Generiert einen Controller mit Lese-/Schreibaktionen ohne Modell.

Verwenden Sie den Schalter -h, um Hilfe zum aspnet-codegenerator controller-Befehl zu erhalten:

dotnet aspnet-codegenerator controller -h

Unter Erstellen des Gerüsts für das Filmmodell finden Sie ein Beispiel für dotnet aspnet-codegenerator controller.

Razorpage

Für Razor Pages können jeweils einzelne Gerüste erstellt werden, indem der Name der neuen Seite und der zu verwendenden Vorlage angegeben wird. Folgende Vorlagen werden unterstützt:

  • Empty
  • Create
  • Edit
  • Delete
  • Details
  • List

Beispielsweise verwendet der folgende Befehl die Bearbeitungsvorlage, um MyEdit.cshtml und MyEdit.cshtml.cs zu generieren:

dotnet aspnet-codegenerator razorpage MyEdit Edit -m Movie -dc RazorPagesMovieContext -outDir Pages/Movies

Typischerweise werden die Vorlage und der Name der generierten Datei nicht angegeben, und es werden die folgenden Vorlagen erstellt:

  • Create
  • Edit
  • Delete
  • Details
  • List

In der folgenden Tabelle sind Optionen für aspnet-codegeneratorrazorpage, controller und view aufgelistet:

Option BESCHREIBUNG
--model oder -m Die Modellklasse, die verwendet werden soll.
--dataContext oder -dc Die zu verwendende DbContext-Klasse oder der Name der zu generierenden Klasse.
--bootstrapVersion oder -b Gibt die Bootstrap-Version an. Gültige Werte sind 3 und 4. Der Standardwert ist 4. Falls benötigt und noch nicht vorhanden, wird ein wwwroot-Verzeichnis erstellt, das die Bootstrap-Dateien der angegebenen Version enthält.
--referenceScriptLibraries oder -scripts Verweist auf Skriptbibliotheken in den erstellten Ansichten. Fügt _ValidationScriptsPartial zum Bearbeiten und Erstellen von Seiten hinzu.
--layout oder -l Benutzerdefinierte Layoutseite, die verwendet werden soll.
--useDefaultLayout oder -udl Verwendet das Standardlayout für die Ansichten.
--force oder -f Überschreibt vorhandene Dateien.
--relativeFolderPath oder -outDir Angeben des relativen Ausgabeordnerpfads von dem Projekt aus, in dem die Datei generiert werden muss. Falls nicht angegeben, wird die Datei im Projektordner generiert.
--useSqlite oder -sqlite Flag, um anzugeben, ob DbContext SQLite anstelle von SQL Server verwenden sollte.

Die folgende Tabelle zeigt die Optionen für aspnet-codegenerator razorpage:

Option Beschreibung
--namespaceName oder -namespace Der Name des Namespace, der für das generierte PageModel verwendet wird.
--partialView oder -partial Generiert eine Teilansicht. Die Layoutoptionen -l und -udl werden ignoriert, wenn diese Option angegeben wird.
--noPageModel oder -npm Schalter, um keine PageModel-Klasse für eine leere Vorlage zu generieren.

Verwenden Sie den Schalter -h, um Hilfe zum aspnet-codegenerator razorpage-Befehl zu erhalten:

dotnet aspnet-codegenerator razorpage -h

Unter Erstellen des Gerüsts für das Filmmodell finden Sie ein Beispiel für dotnet aspnet-codegenerator razorpage.

Sicht

Für Ansichten können jeweils einzelne Gerüste erstellt werden, indem der Name der Ansicht und die zu verwendende Vorlage angegeben wird. Folgende Vorlagen werden unterstützt:

  • Empty
  • Create
  • Edit
  • Delete
  • Details
  • List

Beispielsweise verwendet der folgende Befehl die Bearbeitungsvorlage, um MyEdit.cshtml zu generieren:

dotnet aspnet-codegenerator view MyEdit Edit -m Movie -dc MovieContext -outDir Views/Movies

In der folgenden Tabelle sind Optionen für aspnet-codegeneratorrazorpage, controller und view aufgelistet:

Option BESCHREIBUNG
--model oder -m Die Modellklasse, die verwendet werden soll.
--dataContext oder -dc Die zu verwendende DbContext-Klasse oder der Name der zu generierenden Klasse.
--bootstrapVersion oder -b Gibt die Bootstrap-Version an. Gültige Werte sind 3 und 4. Der Standardwert ist 4. Falls benötigt und noch nicht vorhanden, wird ein wwwroot-Verzeichnis erstellt, das die Bootstrap-Dateien der angegebenen Version enthält.
--referenceScriptLibraries oder -scripts Verweist auf Skriptbibliotheken in den erstellten Ansichten. Fügt _ValidationScriptsPartial zum Bearbeiten und Erstellen von Seiten hinzu.
--layout oder -l Benutzerdefinierte Layoutseite, die verwendet werden soll.
--useDefaultLayout oder -udl Verwendet das Standardlayout für die Ansichten.
--force oder -f Überschreibt vorhandene Dateien.
--relativeFolderPath oder -outDir Angeben des relativen Ausgabeordnerpfads von dem Projekt aus, in dem die Datei generiert werden muss. Falls nicht angegeben, wird die Datei im Projektordner generiert.
--useSqlite oder -sqlite Flag, um anzugeben, ob DbContext SQLite anstelle von SQL Server verwenden sollte.

Die folgende Tabelle zeigt die Optionen für aspnet-codegenerator view:

Option BESCHREIBUNG
--controllerNamespace oder -namespace Angeben des Namens des Namespace, der für den generierten Controller verwendet wird.
--partialView oder -partial Generieren einer Teilansicht. Andere Layoutoptionen („-l“ und „-udl“) werden ignoriert, wenn dies angegeben ist.

Verwenden Sie den Schalter -h, um Hilfe zum aspnet-codegenerator view-Befehl zu erhalten:

dotnet aspnet-codegenerator view -h

Identity

Siehe Gerüst Identity