Narzędzie do generowania kodu ASP.NET Core (aspnet-codegenerator)

Polecenie dotnet aspnet-codegenerator uruchamia aparat szkieletów platformy ASP.NET Core. Uruchomienie polecenia jest wymagane do utworzenia dotnet aspnet-codegenerator szkieletu z wiersza polecenia lub w przypadku korzystania z programu Visual Studio Code. Polecenie nie jest wymagane do używania szkieletów w programie Visual Studio, który domyślnie zawiera aparat tworzenia szkieletów.

Instalowanie i aktualizowanie narzędzia generatora kodu

Zainstaluj zestaw .NET SDK.

dotnet aspnet-codegenerator to narzędzie globalne, które należy zainstalować. Następujące polecenie instaluje najnowszą stabilną wersję narzędzia generatora kodu platformy ASP.NET Core:

dotnet tool install -g dotnet-aspnet-codegenerator

Note

Domyślnie architektura plików binarnych platformy .NET do zainstalowania reprezentuje obecnie uruchomioną architekturę systemu operacyjnego. Aby określić inną architekturę systemu operacyjnego, zobacz dotnet tool install, --arch option(Instalacja narzędzia dotnet). Aby uzyskać więcej informacji, zobacz problem z usługą GitHub dotnet/AspNetCore.Docs #29262.

Jeśli narzędzie jest już zainstalowane, następujące polecenie aktualizuje narzędzie do najnowszej stabilnej wersji dostępnej z zainstalowanych zestawów SDK platformy .NET:

dotnet tool update -g dotnet-aspnet-codegenerator

Odinstalowywanie narzędzia generatora kodu

W celu rozwiązania problemów może być konieczne odinstalowanie narzędzia generatora kodu ASP.NET Core. Jeśli na przykład zainstalowano wersję zapoznawcza narzędzia, odinstaluj je przed zainstalowaniem wydanej wersji.

Następujące polecenia odinstalowują narzędzie generatora kodu ASP.NET Core i instalują najnowszą stabilną wersję:

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

Synopsis

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

Description

Globalne dotnet aspnet-codegenerator polecenie uruchamia generator kodu ASP.NET Core i aparat tworzenia szkieletów.

Arguments

generator

Generator kodu do uruchomienia. Dostępne generatory przedstawiono w poniższej tabeli.

Generator	Operation
area	Szkielety obszaru.
blazor	Szkielety Blazor tworzą, odczytują, aktualizują, usuwają i wyświetlają strony.
blazor-identity	Generuje BlazorIdentity pliki.
controller	Szkielety kontrolera.
identity	Szkielety Identity.
minimalapi	Generuje plik punktów końcowych (z punktami końcowymi interfejsu API CRUD) na podstawie modelu i opcjonalnego kontekstu bazy danych.
razorpage	Razor szkieletów.
view	Szkielety widoku.

Opcje

-b|--build-base-path

Ścieżka podstawowa kompilacji.

-c|--configuration {Debug|Release}

Definiuje konfigurację kompilacji. Domyślna wartość to Debug.

-h|--help

Wyświetla krótką pomoc dla polecenia .

-n|--nuget-package-dir

Określa katalog pakietów NuGet.

--no-build

Nie kompiluje projektu przed uruchomieniem. Przekazywanie --no-build również niejawnie ustawia flagę --no-restore .

-p|--project <PATH>

Określa ścieżkę pliku projektu do uruchomienia (nazwa folderu lub pełna ścieżka). Jeśli nie zostanie określony, narzędzie zostanie domyślnie ustawione na bieżący katalog.

-tfm|--target-framework

Platforma docelowa do użycia.

Opcje generatora

W poniższych sekcjach opisano opcje dostępne dla obsługiwanych generatorów:

• Obszar (area)
• Kontroler (controller)
• Blazor (blazor)
• Blazor Identity (blazor-identity)
• Identity (identity)
• Minimalny interfejs API (minimalapi)
• Razor page (razorpage)
• Widok (view)

Opcje obszaru

Użycie: dotnet aspnet-codegenerator area {AREA NAME}

Symbol {AREA NAME} zastępczy to nazwa obszaru do wygenerowania.

Poprzednie polecenie generuje następujące foldery:

• Areas
  • {AREA NAME}
    • Controllers
    • Data
    • Models
    • Views

-h|--help Użyj opcji , aby uzyskać pomoc:

dotnet aspnet-codegenerator area -h

Blazor Opcje

Razor Składniki mogą być oddzielnie szkieletowe dla Blazor aplikacji, określając nazwę szablonu do użycia. Obsługiwane szablony to:

• Empty
• Create
• Edit
• Delete
• Details
• List
• CRUD: CRUD to skrót od tworzenia, odczytu, aktualizacji i usuwania. Szablon CRUD tworzy Createskładniki , Edit, Delete, Detailsi Index (List) dla aplikacji.

Opcje generatora blazor przedstawiono w poniższej tabeli.

Option	Description
-dbProvider|--databaseProvider	Dostawca bazy danych do użycia. Opcje obejmują sqlserver (ustawienie domyślne), sqlite, cosmoslub postgres.
-dc|--dataContext	Klasa kontekstu bazy danych do użycia.
-m|--model	Klasa modelu do użycia.
-ns|--namespaceName	Określ nazwę przestrzeni nazw, która ma być używana dla wygenerowanego pliku punktów końcowych.
--relativeFolderPath|-outDir	Względna ścieżka folderu wyjściowego. Jeśli nie zostanie określony, pliki są generowane w folderze projektu.

Poniższy przykład:

• Używa szablonu Edit do generowania Edit składnika (Edit.razor) w Components/Pages/MoviePages folderze aplikacji. MoviePages Jeśli folder nie istnieje, narzędzie automatycznie utworzy folder.
• Używa dostawcy bazy danych SQLite.
• Używa BlazorWebAppMovies.Data.BlazorWebAppMoviesContext dla kontekstu bazy danych.
• Movie Używa modelu.

dotnet aspnet-codegenerator blazor Edit -dbProvider sqlite -dc BlazorWebAppMovies.Data.BlazorWebAppMoviesContext -m Movie -outDir Components/Pages

-h|--help Użyj opcji , aby uzyskać pomoc:

dotnet aspnet-codegenerator blazor -h

Aby zapoznać się z przykładem korzystającym z generatorablazor, zobacz Tworzenie Blazor aplikacji bazy danych filmów (omówienie).

Aby uzyskać więcej informacji, zobacz ASP.NET Core Blazor "QuickGrid" składnik.

Blazor Identity Opcje

Składniki szkieletu IdentityRazor w Blazor aplikacji z generatorem blazor-identity .

Opcje szablonu blazor-identity są wyświetlane w poniższej tabeli.

Option	Description
-dbProvider|--databaseProvider	Dostawca bazy danych do użycia. Opcje obejmują sqlserver (ustawienie domyślne) i sqlite.
-dc|--dataContext	Klasa kontekstu bazy danych do użycia.
-f|--force	Użyj tej opcji, aby zastąpić istniejące pliki.
-fi|--files	Lista rozdzielonych średnikami plików do szkieletu. -lf|--listFiles Użyj opcji , aby wyświetlić dostępne opcje.
-lf|--listFiles	Wyświetla listę plików, które mogą być szkieletowe przy użyciu -fi|--files opcji .
-rn|--rootNamespace	Główna przestrzeń nazw do użycia do generowania Identity kodu.
-u|--userClass	Nazwa klasy użytkownika do wygenerowania.

-h|--help Użyj opcji , aby uzyskać pomoc:

dotnet aspnet-codegenerator blazor-identity -h

Opcje kontrolera

Opcje ogólne przedstawiono w poniższej tabeli.

Option	Description
-b|--bootstrapVersion	Określa wersję bootstrap i tworzy wwwroot folder dla zasobów Bootstrap, jeśli folder nie jest obecny.
-dbProvider|--databaseProvider	Dostawca bazy danych do użycia. Opcje obejmują sqlserver (ustawienie domyślne), sqlite, cosmos, postgres.
-dc|--dataContext	Klasa kontekstu bazy danych do użycia lub nazwa klasy do wygenerowania.
-f|--force	Zastąp istniejące pliki.
-l|--layout	Niestandardowa strona układu do użycia.
-m|--model	Klasa modelu do użycia.
-outDir|--relativeFolderPath	Względna ścieżka folderu wyjściowego. Jeśli nie zostanie określony, pliki są generowane w folderze projektu.
-scripts|--referenceScriptLibraries	Odwołania do bibliotek skryptów w wygenerowanych widokach. Dodaje _ValidationScriptsPartial do Edit stron i Create .
-sqlite|--useSqlite	Flaga określająca, czy kontekst bazy danych powinien używać sqlite zamiast programu SQL Server.
-udl|--useDefaultLayout	Użyj domyślnego układu widoków.

Opcje unikatowe controller dla są wyświetlane w poniższej tabeli.

Option	Description
-actions|--readWriteActions	Generowanie kontrolera za pomocą akcji odczytu/zapisu bez modelu.
-api|--restWithNoViews	Generowanie kontrolera przy użyciu REST interfejsu API stylu. noViews przyjmuje się założenie, że wszystkie opcje powiązane z widokiem są ignorowane.
-async|--useAsyncActions	Generuj akcje asynchronicznego kontrolera.
-name|--controllerName	Nazwa kontrolera.
-namespace|--controllerNamespace	Określ nazwę przestrzeni nazw, która ma być używana dla wygenerowanego kontrolera.
-nv|--noViews	Nie generuje żadnych widoków.

-h|--help Użyj opcji , aby uzyskać pomoc:

dotnet aspnet-codegenerator controller -h

Aby zapoznać się z przykładem użycia generatora controller , zobacz Część 4, dodawanie modelu do aplikacji ASP.NET Core MVC.

Identity Opcje

Aby uzyskać więcej informacji, zobacz Szkielet Identity w projektach ASP.NET Core.

Minimalne opcje interfejsu API

Tworzenie szkieletu minimalnego zaplecza interfejsu API przy użyciu szablonu minimalapi .

Opcje dla minimalapi programu są wyświetlane w poniższej tabeli.

Option	Description
-dbProvider|--databaseProvider	Dostawca bazy danych do użycia. Opcje obejmują sqlserver (ustawienie domyślne), sqlite, cosmoslub postgres.
-dc|--dataContext	Klasa kontekstu bazy danych do użycia.
-e|--endpoints	Klasa punktów końcowych do użycia (a nie nazwa pliku).
-m|--model	Klasa modelu do użycia.
-namespace|--endpointsNamespace	Określ nazwę przestrzeni nazw, która ma być używana dla wygenerowanego pliku punktów końcowych.
-o|--open	Użyj tej opcji, aby włączyć interfejs OpenAPI.
-outDir|--relativeFolderPath	Względna ścieżka folderu wyjściowego. Jeśli nie zostanie określony, pliki są generowane w folderze projektu.
-sqlite|--useSqlite	Flaga określająca, czy kontekst bazy danych powinien używać sqlite zamiast programu SQL Server.

Poniższy przykład:

• Generuje klasę punktów końcowych o nazwie SpeakersEndpoints z punktami końcowymi interfejsu API, które mapuje na operacje bazy danych przy użyciu ApplicationDbContext klasy kontekstu bazy danych i BackEnd.Models.Speaker modelu.
• Dodaje app.MapSpeakerEndpoints(); element do Program pliku (Program.cs), aby zarejestrować klasę punktów końcowych.

dotnet aspnet-codegenerator minimalapi -dc ApplicationDbContext -e SpeakerEndpoints -m BackEnd.Models.Speaker -o

-h|--help Użyj opcji , aby uzyskać pomoc:

dotnet aspnet-codegenerator minimalapi -h

Razor opcje strony

Razor Strony można oddzielnie szkieletować, określając nazwę nowej strony i szablon do użycia. Obsługiwane szablony to:

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

Zazwyczaj szablon i wygenerowana nazwa pliku nie są określone, co powoduje utworzenie następujących szablonów:

• Create
• Edit
• Delete
• Details
• List

Opcje ogólne przedstawiono w poniższej tabeli.

Option	Description
-b|--bootstrapVersion	Określa wersję bootstrap i tworzy wwwroot folder dla zasobów Bootstrap, jeśli folder nie jest obecny.
-dbProvider|--databaseProvider	Dostawca bazy danych do użycia. Opcje obejmują sqlserver (ustawienie domyślne), sqlite, cosmos, postgres.
-dc|--dataContext	Klasa kontekstu bazy danych do użycia lub nazwa klasy do wygenerowania.
-f|--force	Zastąp istniejące pliki.
-l|--layout	Niestandardowa strona układu do użycia.
-m|--model	Klasa modelu do użycia.
-outDir|--relativeFolderPath	Względna ścieżka folderu wyjściowego. Jeśli nie zostanie określony, pliki są generowane w folderze projektu.
-scripts|--referenceScriptLibraries	Odwołania do bibliotek skryptów w wygenerowanych widokach. Dodaje _ValidationScriptsPartial do Edit stron i Create .
-sqlite|--useSqlite	Flaga określająca, czy kontekst bazy danych powinien używać sqlite zamiast programu SQL Server.
-udl|--useDefaultLayout	Użyj domyślnego układu widoków.

Opcje unikatowe razorpage dla są wyświetlane w poniższej tabeli.

Option	Description
-namespace|--namespaceName	Nazwa przestrzeni nazw do użycia dla wygenerowanej PageModel klasy.
-npm|--noPageModel	Nie generuj PageModel klasy dla szablonu Empty .
-partial|--partialView	Generowanie widoku częściowego. Opcje -l układu i -udl są ignorowane, jeśli jest to określone.

W poniższym przykładzie użyto szablonu Edit do wygenerowania CustomEditPage.cshtml i CustomEditPage.cshtml.cs w folderze Pages/Movies :

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

-h|--help Użyj opcji , aby uzyskać pomoc:

dotnet aspnet-codegenerator razorpage -h

Aby zapoznać się z przykładem użycia generatora razorpage , zobacz Część 2, dodawanie modelu.

Opcje wyświetlania

Widoki można oddzielnie szkieletować, określając nazwę widoku i szablonu. Obsługiwane szablony to:

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

Opcje ogólne przedstawiono w poniższej tabeli.

Option	Description
-b|--bootstrapVersion	Określa wersję bootstrap i tworzy wwwroot folder dla zasobów Bootstrap, jeśli folder nie jest obecny.
-dbProvider|--databaseProvider	Dostawca bazy danych do użycia. Opcje obejmują sqlserver (ustawienie domyślne), sqlite, cosmos, postgres.
-dc|--dataContext	Klasa kontekstu bazy danych do użycia lub nazwa klasy do wygenerowania.
-f|--force	Zastąp istniejące pliki.
-l|--layout	Niestandardowa strona układu do użycia.
-m|--model	Klasa modelu do użycia.
-outDir|--relativeFolderPath	Względna ścieżka folderu wyjściowego. Jeśli nie zostanie określony, pliki są generowane w folderze projektu.
-scripts|--referenceScriptLibraries	Odwołania do bibliotek skryptów w wygenerowanych widokach. Dodaje _ValidationScriptsPartial do Edit stron i Create .
-sqlite|--useSqlite	Flaga określająca, czy kontekst bazy danych powinien używać sqlite zamiast programu SQL Server.
-udl|--useDefaultLayout	Użyj domyślnego układu widoków.

Opcje unikatowe view dla są wyświetlane w poniższej tabeli.

Option	Description
-namespace|--controllerNamespace	Określ nazwę przestrzeni nazw, która ma być używana dla wygenerowanego kontrolera.
-partial|--partialView	Generowanie widoku częściowego. Inne opcje układu (-l i -udl) są ignorowane, jeśli jest określony.

W poniższym przykładzie użyto szablonu Edit do wygenerowania CustomEditView.cshtml w folderze Views/Movies :

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

-h|--help Użyj opcji , aby uzyskać pomoc:

dotnet aspnet-codegenerator view -h