dotnet aspnet-codegenerator

  • Статья

Автор: Рик Андерсон (Rick Anderson)

Команда dotnet aspnet-codegenerator запускает подсистему формирования шаблонов ASP.NET Core. Команда dotnet aspnet-codegenerator нужна только для командной строки. Она не требуется для формирования шаблонов в Visual Studio.

Установка и обновление aspnet-codegenerator

Установите пакет SDK для .NET.

dotnet aspnet-codegenerator — глобальное средство, которое нужно установить. Следующая команда позволяет установить последнюю стабильную версию средства dotnet aspnet-codegenerator:

dotnet tool install -g dotnet-aspnet-codegenerator

Примечание.

По умолчанию архитектура двоичных файлов .NET для установки представляет архитектуру операционной системы. Чтобы указать другую архитектуру ОС, см . параметр dotnet tool install, --arch. Дополнительные сведения см. в статье о проблеме GitHub dotnet/AspNetCore.Docs #29262.

Приведенная ниже команда позволяет обновить dotnet aspnet-codegenerator до последней стабильной версии, доступной из установленных пакетов SDK для .NET Core.

dotnet tool update -g dotnet-aspnet-codegenerator

Удаление aspnet-codegenerator

Для устранения проблем, возможно, потребуется удалить aspnet-codegenerator. Например, если вы установили предварительную версию aspnet-codegenerator, удалите ее перед установкой выпущенной версии.

Следующая команда позволяет удалить средство dotnet aspnet-codegenerator и установить последнюю стабильную версию:

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

Краткие сведения

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]

Description

Глобальная команда dotnet aspnet-codegenerator запускает генератор кода и подсистему формирования шаблонов ASP.NET Core.

Аргументы

generator

Запускаемый генератор кода. Доступны такие генераторы:

Генератор Операция
ожидания Формирует шаблон области
домена Формирует шаблон контроллера
identity Формирует шаблон Identity
razorpage Формирует шаблон страниц Razor Pages
view Формирует шаблон представления

Параметры

-n|--nuget-package-dir

Позволяет указать каталог пакета NuGet.

-c|--configuration {Debug|Release}

Определяет конфигурацию сборки. Значение по умолчанию — Debug.

-tfm|--target-framework

Целевая платформа для использования. Например, net46.

-b|--build-base-path

Базовый путь сборки.

-h|--help

Выводит краткую справку по команде.

--no-build

Не выполняет сборку проекта перед запуском. Он также неявно задает флаг --no-restore.

-p|--project <PATH>

Задает путь к запускаемому файлу проекта (имя папки или полный путь). Если значение не задано, по умолчанию используется текущий каталог.

Параметры генератора

В следующих разделах подробно описаны параметры, доступные для поддерживаемых генераторов.

  • Площадь
  • Контроллер
  • Identity
  • Razorpage
  • Представление

Параметры области

Это средство предназначено для веб-проектов ASP.NET Core с контроллерами и представлениями. Оно не предназначено для приложений Razor Pages.

Использование: dotnet aspnet-codegenerator area AreaNameToGenerate

Приведенная выше команда создает такие папки:

  • Области
    • AreaNameToGenerate
      • Контроллеры
      • Данные
      • Модели
      • Представления

Параметры контроллера

В таблице ниже перечислены параметры для aspnet-codegeneratorrazorpage, controller и view.

Параметр Описание
--model или -m Класс модели, который необходимо использовать.
--dataContext или -dc Класс DbContext, который необходимо использовать, или имя создаваемого класса.
--bootstrapVersion или -b Определяет версию начальной загрузки. Допустимые значения — 3 или 4. По умолчанию — 4. Если требуемая версия отсутствует, создается каталог wwwroot с файлами начальной загрузки этой версии.
--referenceScriptLibraries или -scripts Указание библиотек скриптов в создаваемых представлениях. Добавляет _ValidationScriptsPartial для страниц редактирования и создания.
--layout или -l Страница пользовательского макета, которую необходимо использовать.
--useDefaultLayout или -udl Использовать макет по умолчанию для представлений.
--force или -f Перезаписать существующие файлы.
--relativeFolderPath или -outDir Укажите относительный путь к папке выходных данных из проекта, в котором необходимо создать файл (если он не указан). Файл будет создан в папке проекта
--useSqlite или -sqlite Флаг, который определяет, DbContext следует ли использовать SQLite вместо SQL Server.

В таблице ниже перечислены параметры только для aspnet-codegenerator controller.

Параметр Описание
--controllerName или -name Имя контроллера.
--useAsyncActions или -async Создание асинхронных действий контроллера.
--noViews или -nv Представления не создаются.
--restWithNoViews или -api Создание контроллера с API в стиле REST. Используется noViews, а все параметры, связанные с представлением, игнорируются.
--readWriteActions или -actions Создание контроллера с действиями чтения и записи без модели.

Чтобы получить справку по команде aspnet-codegenerator controller, используйте параметр -h.

dotnet aspnet-codegenerator controller -h

Пример dotnet aspnet-codegenerator controller см. в разделе Создание модели фильма.

Razorpage

Шаблоны для страниц Razor Pages можно формировать по отдельности. Для этого нужно указать имя новой страницы и используемый шаблон. Поддерживаются такие шаблоны:

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

Например, следующая команда использует шаблон "Изменить" для создания иMyEdit.cshtml.cs:MyEdit.cshtml

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

Создаются следующие шаблоны, а шаблон и имя созданного файла обычно не указываются:

  • Create
  • Edit
  • Delete
  • Details
  • List

В таблице ниже перечислены параметры для aspnet-codegeneratorrazorpage, controller и view.

Параметр Описание
--model или -m Класс модели, который необходимо использовать.
--dataContext или -dc Класс DbContext, который необходимо использовать, или имя создаваемого класса.
--bootstrapVersion или -b Определяет версию начальной загрузки. Допустимые значения — 3 или 4. По умолчанию — 4. Если требуемая версия отсутствует, создается каталог wwwroot с файлами начальной загрузки этой версии.
--referenceScriptLibraries или -scripts Указание библиотек скриптов в создаваемых представлениях. Добавляет _ValidationScriptsPartial для страниц редактирования и создания.
--layout или -l Страница пользовательского макета, которую необходимо использовать.
--useDefaultLayout или -udl Использовать макет по умолчанию для представлений.
--force или -f Перезаписать существующие файлы.
--relativeFolderPath или -outDir Укажите относительный путь к папке выходных данных из проекта, в котором необходимо создать файл (если он не указан). Файл будет создан в папке проекта
--useSqlite или -sqlite Флаг, который определяет, DbContext следует ли использовать SQLite вместо SQL Server.

В таблице ниже перечислены параметры только для aspnet-codegenerator razorpage.

Параметр Описание
--namespaceName или -namespace Имя пространства имен, используемого для созданной модели PageModel.
--partialView или -partial Создание частичного представления. Если указан этот параметр, параметры макета -l и -udl игнорируются.
--noPageModel или -npm Параметр, при использовании которого не создается класс PageModel для пустого шаблона.

Чтобы получить справку по команде aspnet-codegenerator razorpage, используйте параметр -h.

dotnet aspnet-codegenerator razorpage -h

Пример dotnet aspnet-codegenerator razorpage см. в разделе Создание модели фильма.

Представление

Представления можно формировать по отдельности. Для этого нужно указать имя представления и используемый шаблон. Поддерживаются такие шаблоны:

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

Например, следующая команда использует шаблон "Изменить" для создания MyEdit.cshtml:

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

В таблице ниже перечислены параметры для aspnet-codegeneratorrazorpage, controller и view.

Параметр Описание
--model или -m Класс модели, который необходимо использовать.
--dataContext или -dc Класс DbContext, который необходимо использовать, или имя создаваемого класса.
--bootstrapVersion или -b Определяет версию начальной загрузки. Допустимые значения — 3 или 4. По умолчанию — 4. Если требуемая версия отсутствует, создается каталог wwwroot с файлами начальной загрузки этой версии.
--referenceScriptLibraries или -scripts Указание библиотек скриптов в создаваемых представлениях. Добавляет _ValidationScriptsPartial для страниц редактирования и создания.
--layout или -l Страница пользовательского макета, которую необходимо использовать.
--useDefaultLayout или -udl Использовать макет по умолчанию для представлений.
--force или -f Перезаписать существующие файлы.
--relativeFolderPath или -outDir Укажите относительный путь к папке выходных данных из проекта, в котором необходимо создать файл (если он не указан). Файл будет создан в папке проекта
--useSqlite или -sqlite Флаг, который определяет, DbContext следует ли использовать SQLite вместо SQL Server.

В таблице ниже перечислены параметры только для aspnet-codegenerator view.

Параметр Описание
--controllerNamespace или -namespace Укажите имя пространства имен, используемого для созданного контроллера
--partialView или -partial Создайте частичное представление, поскольку, если указан этот параметр, другие параметры макета (-l и -udl) игнорируются

Чтобы получить справку по команде aspnet-codegenerator view, используйте параметр -h.

dotnet aspnet-codegenerator view -h

Identity

См. Формирование шаблонов Identity