dotnet aspnet-codegeneratordotnet aspnet-codegenerator

Von Rick AndersonBy Rick Anderson

dotnet aspnet-codegenerator: Führt die ASP.NET Core-Gerüstbauengine aus.dotnet aspnet-codegenerator - Runs the ASP.NET Core scaffolding engine. dotnet aspnet-codegenerator wird nur für den Gerüstbau über die Befehlszeile benötigt, nicht zum Gerüstbau mit Visual Studio.dotnet aspnet-codegenerator is only required to scaffold from the command line, it's not needed to use scaffolding with Visual Studio.

Installieren und Aktualisieren von aspnet-codegeneratorInstall and update aspnet-codegenerator

Installieren Sie das .NET SDK.Install the .NET SDK.

dotnet-aspnet-codegenerator ist ein globales Tool, das installiert werden muss.dotnet-aspnet-codegenerator is a global tool that must be installed. Über den folgenden Befehl wird die neueste stabile Version des dotnet-aspnet-codegenerator-Tools installiert:The following command installs the latest stable version of the dotnet-aspnet-codegenerator tool:

dotnet tool install -g dotnet-aspnet-codegenerator

Mit dem folgenden Befehl wird dotnet-aspnet-codegenerator auf die neueste stabile Version aktualisiert, die in den installierten .NET Core SDKs verfügbar ist:The following command updates dotnet-aspnet-codegenerator to the latest stable version available from the installed .NET Core SDKs:

dotnet tool update -g dotnet-aspnet-codegenerator

Deinstallieren von aspnet-codegeneratorUninstall aspnet-codegenerator

Es kann erforderlich sein, aspnet-codegenerator zu deinstallieren, um Probleme zu beheben.It may be necessary to uninstall the aspnet-codegenerator to resolve problems. Wenn Sie z. B. eine Vorschauversion von aspnet-codegeneratorinstalliert haben, deinstallieren Sie diese, bevor Sie die veröffentlichte Version installieren.For example, if you installed a preview version of aspnet-codegenerator, uninstall it before installing the released version.

Über den folgenden Befehl wird die neueste stabile Version des dotnet-aspnet-codegenerator-Tools installiert:The following commands uninstall the dotnet-aspnet-codegenerator tool and installs the latest stable version:

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

ÜbersichtSynopsis

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]

BeschreibungDescription

Der globale Befehl dotnet aspnet-codegenerator führt den ASP.NET Code-Codegenerator und die Gerüstbauengine aus.The dotnet aspnet-codegenerator global command runs the ASP.NET Core code generator and scaffolding engine.

ArgumenteArguments

generator

Der auszuführende Codegenerator.The code generator to run. Folgende Generatoren sind verfügbar:The following generators are available:

GeneratorGenerator VorgangOperation
areaarea Gerüstbau für einen BereichScaffolds an Area
Controllercontroller Gerüstbau für einen ControllerScaffolds a controller
Identitätidentity Gerüstbau IdentityScaffolds Identity
razorpagerazorpage Gerüstbau für Razor PagesScaffolds Razor Pages
Sichtview Gerüstbau für eine AnsichtScaffolds a view

OptionenOptions

-n|--nuget-package-dir

Gibt das NuGet-Paketverzeichnis an.Specifies the NuGet package directory.

-c|--configuration {Debug|Release}

Legt die Buildkonfiguration fest.Defines the build configuration. Der Standardwert ist Debug.The default value is Debug.

-tfm|--target-framework

Das zu verwendende Zielframework.Target Framework to use. Beispielsweise net46.For example, net46.

-b|--build-base-path

Der Basispfad für den Build.The build base path.

-h|--help

Druckt eine kurze Hilfe für den Befehl.Prints out a short help for the command.

--no-build

Erstellt das Projekt nicht vor der Ausführung.Doesn't build the project before running. Zudem wird das Flag --no-restore implizit festgelegt.It also implicitly sets the --no-restore flag.

-p|--project <PATH>

Gibt den Pfad der auszuführenden Projektdatei an (Ordnername oder vollständiger Pfad).Specifies the path of the project file to run (folder name or full path). Wenn nicht angegeben, wird standardmäßig das aktuelle Verzeichnis gewählt.If not specified, it defaults to the current directory.

GeneratoroptionenGenerator options

In den folgenden Abschnitte werden die verfügbaren Optionen für die unterstützten Generatoren vorgestellt:The following sections detail the options available for the supported generators:

  • BereichArea
  • ControllerController
  • Identity
  • RazorpageRazorpage
  • AnsichtView

BereichsoptionenArea options

Dieses Tool ist für ASP.NET Core-Webprojekte mit Controllern und Ansichten vorgesehen.This tool is intended for ASP.NET Core web projects with controllers and views. Es ist nicht für Razor Pages-Apps gedacht.It's not intended for Razor Pages apps.

Verwendung: dotnet aspnet-codegenerator area AreaNameToGenerateUsage: dotnet aspnet-codegenerator area AreaNameToGenerate

Der oben gezeigte Befehl generiert die folgenden Ordner:The preceding command generates the following folders:

  • BereicheAreas
    • AreaNameToGenerateAreaNameToGenerate
      • ControllerControllers
      • DataData
      • ModelsModels
      • AnsichtenViews

ControlleroptionenController options

Die folgende Tabelle zeigt die Optionen für aspnet-codegenerator controller und razorpage:The following table lists options for aspnet-codegenerator controller and razorpage:

OptionOption BeschreibungDescription
--model oder -m--model or -m Die Modellklasse, die verwendet werden soll.Model class to use.
--dataContext oder -dc--dataContext or -dc Die DbContext-Klasse, die verwendet werden soll.The DbContext class to use.
--bootstrapVersion oder -b--bootstrapVersion or -b Gibt die Bootstrap-Version an.Specifies the bootstrap version. Gültige Werte sind 3 und 4.Valid values are 3 or 4. Der Standardwert ist 4.Default is 4. Falls benötigt und noch nicht vorhanden, wird ein wwwroot-Verzeichnis erstellt, das die Bootstrap-Dateien der angegebenen Version enthält.If needed and not present, a wwwroot directory is created that includes the bootstrap files of the specified version.
--referenceScriptLibraries oder -scripts--referenceScriptLibraries or -scripts Verweist auf Skriptbibliotheken in den erstellten Ansichten.Reference script libraries in the generated views. Fügt _ValidationScriptsPartial zum Bearbeiten und Erstellen von Seiten hinzu.Adds _ValidationScriptsPartial to Edit and Create pages.
--layout oder -l--layout or -l Benutzerdefinierte Layoutseite, die verwendet werden soll.Custom Layout page to use.
--useDefaultLayout oder -udl--useDefaultLayout or -udl Verwendet das Standardlayout für die Ansichten.Use the default layout for the views.
--force oder -f--force or -f Überschreibt vorhandene Dateien.Overwrite existing files.
--relativeFolderPath oder -outDir--relativeFolderPath or -outDir Der relative Ausgabeordnerpfad des Projekts, in dem die Dateien erstellt werden.The relative output folder path from project where the file are generated. Wenn dieser nicht angegeben wird, werden die Dateien im Projektordner erstellt.If not specified, files are generated in the project folder.

Die folgende Tabelle zeigt die Optionen für aspnet-codegenerator controller:The following table lists options unique to aspnet-codegenerator controller:

OptionOption BeschreibungDescription
--controllerName oder -name--controllerName or -name Der Name des Controllers.Name of the controller.
--useAsyncActions oder -async--useAsyncActions or -async Generiert asynchrone Controlleraktionen.Generate async controller actions.
--noViews oder -nv--noViews or -nv Generiert keine Ansichten.Generate no views.
--restWithNoViews oder -api--restWithNoViews or -api Generiert einen Controller mit einer API im REST-Stil.Generate a Controller with REST style API. noViews wird vorausgesetzt, und ansichtsbezogene Optionen werden ignoriert.noViews is assumed and any view related options are ignored.
--readWriteActions oder -actions--readWriteActions or -actions Generiert einen Controller mit Lese-/Schreibaktionen ohne Modell.Generate controller with read/write actions without a model.

Verwenden Sie den Schalter -h, um Hilfe zum aspnet-codegenerator controller-Befehl zu erhalten:Use the -h switch for help on the aspnet-codegenerator controller command:

dotnet aspnet-codegenerator controller -h

Unter Erstellen des Gerüsts für das Filmmodell finden Sie ein Beispiel für dotnet aspnet-codegenerator controller.See Scaffold the movie model for an example of dotnet aspnet-codegenerator controller.

RazorpageRazorpage

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.Razor Pages can be individually scaffolded by specifying the name of the new page and the template to use. Folgende Vorlagen werden unterstützt:The supported templates are:

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

Beispielsweise verwendet der folgende Befehl die Bearbeitungsvorlage, um MyEdit.cshtml und MyEdit.cshtml.cs zu generieren:For example, the following command uses the Edit template to generate MyEdit.cshtml and MyEdit.cshtml.cs:

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:Typically, the template and generated file name is not specified, and the following templates are created:

  • Create
  • Edit
  • Delete
  • Details
  • List

Die folgende Tabelle zeigt die Optionen für aspnet-codegenerator razorpage und controller:The following table lists options for aspnet-codegenerator razorpage and controller:

OptionOption BeschreibungDescription
--model oder -m--model or -m Die Modellklasse, die verwendet werden soll.Model class to use.
--dataContext oder -dc--dataContext or -dc Die DbContext-Klasse, die verwendet werden soll.The DbContext class to use.
--bootstrapVersion oder -b--bootstrapVersion or -b Gibt die Bootstrap-Version an.Specifies the bootstrap version. Gültige Werte sind 3 und 4.Valid values are 3 or 4. Der Standardwert ist 4.Default is 4. Falls benötigt und noch nicht vorhanden, wird ein wwwroot-Verzeichnis erstellt, das die Bootstrap-Dateien der angegebenen Version enthält.If needed and not present, a wwwroot directory is created that includes the bootstrap files of the specified version.
--referenceScriptLibraries oder -scripts--referenceScriptLibraries or -scripts Verweist auf Skriptbibliotheken in den erstellten Ansichten.Reference script libraries in the generated views. Fügt _ValidationScriptsPartial zum Bearbeiten und Erstellen von Seiten hinzu.Adds _ValidationScriptsPartial to Edit and Create pages.
--layout oder -l--layout or -l Benutzerdefinierte Layoutseite, die verwendet werden soll.Custom Layout page to use.
--useDefaultLayout oder -udl--useDefaultLayout or -udl Verwendet das Standardlayout für die Ansichten.Use the default layout for the views.
--force oder -f--force or -f Überschreibt vorhandene Dateien.Overwrite existing files.
--relativeFolderPath oder -outDir--relativeFolderPath or -outDir Der relative Ausgabeordnerpfad des Projekts, in dem die Dateien erstellt werden.The relative output folder path from project where the file are generated. Wenn dieser nicht angegeben wird, werden die Dateien im Projektordner erstellt.If not specified, files are generated in the project folder.

Die folgende Tabelle zeigt die Optionen für aspnet-codegenerator razorpage:The following table lists options unique to aspnet-codegenerator razorpage:

OptionOption BeschreibungDescription
--namespaceName oder -namespace--namespaceName or -namespace Der Name des Namespace, der für das generierte PageModel verwendet wird.The name of the namespace to use for the generated PageModel
--partialView oder -partial--partialView or -partial Generiert eine Teilansicht.Generate a partial view. Die Layoutoptionen -l und -udl werden ignoriert, wenn diese Option angegeben wird.Layout options -l and -udl are ignored if this is specified.
--noPageModel oder -npm--noPageModel or -npm Schalter, um keine PageModel-Klasse für eine leere Vorlage zu generieren.Switch to not generate a PageModel class for Empty template

Verwenden Sie den Schalter -h, um Hilfe zum aspnet-codegenerator razorpage-Befehl zu erhalten:Use the -h switch for help on the aspnet-codegenerator razorpage command:

dotnet aspnet-codegenerator razorpage -h

Unter Erstellen des Gerüsts für das Filmmodell finden Sie ein Beispiel für dotnet aspnet-codegenerator razorpage.See Scaffold the movie model for an example of dotnet aspnet-codegenerator razorpage.

Identity

Siehe Gerüst IdentitySee Scaffold Identity