Часть 2. Добавление модели в приложение Razor Pages в ASP.NET Core

В этом учебнике добавляются классы для управления фильмами в базе данных. Классы моделей приложения используют Entity Framework Core (EF Core) для работы с базой данных. EF Core — это реляционная схема объектов (O/RM), которая упрощает доступ к данным. Сначала вы записываете классы модели и EF Core создаете базу данных.

Классы модели называются классами POCO (от P lain-O ld CLR O bjects), так как они не имеют зависимостиEF Core. Эти классы определяют свойства данных, которые хранятся в базе данных.

Добавление модели данных

Visual Studio

1. В Обозреватель решений щелкните правой кнопкой мыши проект> RazorPagesMovie Add>New Folder. Назовите папку Models.

2. Щелкните правой кнопкой мыши папку Models. Выберите Добавить>Класс. Присвойте классу имя Movie.

3. Добавьте в класс Movie следующие свойства:

   using System.ComponentModel.DataAnnotations;
   
   namespace RazorPagesMovie.Models;
   
   public class Movie
   {
       public int Id { get; set; }
       public string? Title { get; set; }
       [DataType(DataType.Date)]
       public DateTime ReleaseDate { get; set; }
       public string? Genre { get; set; }
       public decimal Price { get; set; }
   }
   

Класс Movie содержит:

• Поле ID является обязательным для первичного ключа базы данных.

• Атрибут [DataType], указывающий тип данных в свойстве ReleaseDate. С этим атрибутом:

  • Пользователю не требуется вводить сведения о времени в поле даты.
  • Отображается только дата, а не время.

• Знак вопроса после string указывает, что свойство допускает значение NULL. Дополнительные сведения см. в статье Ссылочные типы, допускающие значение NULL.

DataAnnotations рассматриваются в следующем руководстве.

Выполните сборку проекта, чтобы убедиться в отсутствии ошибок компиляции.

Visual Studio Code

1. Добавьте папку с именем Models.
2. Добавьте класс в папку Models с именем Movie.cs.

Добавьте в класс Movie следующие свойства:

using System.ComponentModel.DataAnnotations;

namespace RazorPagesMovie.Models;

public class Movie
{
    public int Id { get; set; }
    public string? Title { get; set; }
    [DataType(DataType.Date)]
    public DateTime ReleaseDate { get; set; }
    public string? Genre { get; set; }
    public decimal Price { get; set; }
}

Класс Movie содержит:

• Поле ID, в котором предоставляется первичный ключ для базы данных.

• Атрибут [DataType], указывающий тип данных в поле ReleaseDate. С этим атрибутом:

  • пользователю не требуется вводить сведения о времени в поле даты.
  • Отображается только дата, а не время.

• Знак вопроса после string указывает, что свойство допускает значение NULL. Дополнительные сведения см. в статье Ссылочные типы, допускающие значение NULL.

DataAnnotations рассматриваются в следующем руководстве.

Добавление пакетов NuGet и средств EF

Выполните следующие команды интерфейса командной строки .NET:

dotnet tool uninstall --global dotnet-aspnet-codegenerator
dotnet tool install --global dotnet-aspnet-codegenerator
dotnet tool uninstall --global dotnet-ef
dotnet tool install --global dotnet-ef
dotnet add package Microsoft.EntityFrameworkCore.Design --prerelease
dotnet add package Microsoft.EntityFrameworkCore.SQLite --prerelease
dotnet add package Microsoft.VisualStudio.Web.CodeGeneration.Design --prerelease
dotnet add package Microsoft.EntityFrameworkCore.SqlServer --prerelease
dotnet add package Microsoft.EntityFrameworkCore.Tools --prerelease

Приведенные выше команды добавляют следующие компоненты:

• Средства интерфейса командной строки (CLI) дляEF Core
• средство формирования шаблонов;
• Средства разработки времени для EF Core
• EF Core Поставщик SQLite, который устанавливает EF Core пакет в качестве зависимости.
• Пакеты, необходимые для формирования шаблонов: Microsoft.VisualStudio.Web.CodeGeneration.Design и Microsoft.EntityFrameworkCore.SqlServer.

Рекомендации по конфигурации нескольких сред, позволяющей приложению настраивать свои контексты баз данных в среде, см. в разделе Использование нескольких сред в ASP.NET Core.

Примечание.

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

В Visual Studio Code нажмите клавиши CTRL+F5 (Windows) или «+F5(macOS), чтобы запустить приложение без отладки.

В области редактора под областью редактора выберите вкладку "ПРОБЛЕМЫ" или в меню "Вид", выберите "Проблемы", если он не находится в режиме. Убедитесь, что ошибки компиляции отсутствуют.

Создание модели фильма

В этом разделе создается модель фильма. То есть средство формирования шаблонов создает страницы для операций создания, чтения, обновления и удаления для модели фильма.

Visual Studio

1. Создайте папку Pages/Movies.

   1. Щелкните правой кнопкой мыши папку Pages и выберите Добавить>New Folder (Новая папка).
   2. Назовите папку Movies.

2. Щелкните правой кнопкой мыши папку Pages/Movies и выберите Добавить>New Scaffolded Item (Создать шаблонный элемент).

   

3. В диалоговом окне Добавление шаблона щелкните Razor Pages на основе Entity Framework (CRUD)>Добавить.

   

4. Заполните поля в диалоговом окне Добавление Razor Pages на основе Entity Framework (CRUD):

   1. В раскрывающемся списке Класс модели выберите Фильм (RazorPagesMovie.Models).
   2. В строке Класс контекста данных щелкните знак плюса (+).
      1. В диалоговом окне Добавление контекста данных будет сгенерировано имя класса RazorPagesMovie.Data.RazorPagesMovieContext.
      2. В раскрывающемся списке поставщика базы данных выберите SQL Server.
   3. Выберите Добавить.

   

Файл appsettings.json обновляется с указанием строки подключения, используемой для подключения к локальной базе данных.

Visual Studio Code

• Откройте в командной оболочке папку проекта, которая содержит файлы Program.cs и .csproj. Выполните следующую команду:

  dotnet aspnet-codegenerator razorpage -m Movie -dc RazorPagesMovie.Data.RazorPagesMovieContext -udl -outDir Pages/Movies --referenceScriptLibraries --databaseProvider sqlite
  

В следующей таблице представлены параметры генератора кода ASP.NET Core:

Вариант	Описание
-m	Имя модели.
-dc	Класс, используемый DbContext , включая пространство имен.
-udl	Использование макета по умолчанию
-outDir	Относительный путь к папке выходных данных для создания представлений
--referenceScriptLibraries	Добавляет _ValidationScriptsPartial для страниц редактирования и создания

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

dotnet aspnet-codegenerator razorpage -h

См. подробнее о dotnet aspnet-codegenerator.

Использование SQLite для среды разработки и SQL Server для рабочей среды

Если выбрана SQLite, код, созданный шаблоном, будет готов к разработке. В следующем коде демонстрируется выбор строки подключения SQLite в среде разработки и SQL Server в рабочей среде.

using Microsoft.EntityFrameworkCore;

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddRazorPages();

if (builder.Environment.IsDevelopment())
{
    builder.Services.AddDbContext<RazorPagesMovieContext>(options =>
        options.UseSqlite(builder.Configuration.GetConnectionString("RazorPagesMovieContext")));
}
else
{
    builder.Services.AddDbContext<RazorPagesMovieContext>(options =>
        options.UseSqlServer(builder.Configuration.GetConnectionString("ProductionMovieContext")));
}

var app = builder.Build();

if (!app.Environment.IsDevelopment())
{
    app.UseExceptionHandler("/Error");
    app.UseHsts();
}

app.UseHttpsRedirection();
app.UseStaticFiles();

app.UseRouting();

app.UseAuthorization();

app.MapRazorPages();

app.Run();

В приведенном выше коде не осуществляется вызов UseDeveloperExceptionPage в среде разработки, поскольку WebApplication вызывает UseDeveloperExceptionPage в режиме разработки.

Предупреждение

В этой статье используется локальная база данных, которая не требует проверки подлинности пользователя. Рабочие приложения должны использовать самый безопасный поток проверки подлинности. Дополнительные сведения о проверке подлинности для развернутых тестовых и рабочих приложений см. в разделе "Безопасные потоки проверки подлинности".

Созданные и обновленные файлы

В процессе формирования шаблонов создаются указанные ниже файлы.

• Pages/Movies: Create, Delete, Details, Edit и Index.
• Data/RazorPagesMovieContext.cs

В следующем учебнике приводится описание созданных файлов.

Процесс формирования шаблонов добавляет в файл следующий выделенный Program.cs код:

Visual Studio

using Microsoft.EntityFrameworkCore;
using Microsoft.Extensions.DependencyInjection;
using RazorPagesMovie.Data;
var builder = WebApplication.CreateBuilder(args);

// Add services to the container.
builder.Services.AddRazorPages();
builder.Services.AddDbContext<RazorPagesMovieContext>(options =>
    options.UseSqlServer(builder.Configuration.GetConnectionString("RazorPagesMovieContext") ?? throw new InvalidOperationException("Connection string 'RazorPagesMovieContext' not found.")));

var app = builder.Build();

// Configure the HTTP request pipeline.
if (!app.Environment.IsDevelopment())
{
    app.UseExceptionHandler("/Error");
    // The default HSTS value is 30 days. You may want to change this for production scenarios, see https://aka.ms/aspnetcore-hsts.
    app.UseHsts();
}

app.UseHttpsRedirection();

app.UseRouting();

app.UseAuthorization();

app.MapStaticAssets();
app.MapRazorPages();

app.Run();

Visual Studio Code

using Microsoft.EntityFrameworkCore;
using Microsoft.Extensions.DependencyInjection;
using RazorPagesMovie.Data;
var builder = WebApplication.CreateBuilder(args);

// Add services to the container.
builder.Services.AddRazorPages();
builder.Services.AddDbContext<RazorPagesMovieContext>(options =>
    options.UseSqlite(builder.Configuration.GetConnectionString("RazorPagesMovieContext") ?? throw new InvalidOperationException("Connection string 'RazorPagesMovieContext' not found.")));

var app = builder.Build();

// Configure the HTTP request pipeline.
if (!app.Environment.IsDevelopment())
{
    app.UseExceptionHandler("/Error");
    // The default HSTS value is 30 days. You may want to change this for production scenarios, see https://aka.ms/aspnetcore-hsts.
    app.UseHsts();
}

app.UseHttpsRedirection();
app.UseStaticFiles();

app.UseRouting();

app.UseAuthorization();

app.MapStaticAssets();
app.MapRazorPages();

app.Run();

Изменения Program.cs описаны далее в этом руководстве.

Создание начальной схемы базы данных с помощью функции миграции EF

Функция миграции в Entity Framework Core предоставляет следующие возможности:

• Создание начальной схемы базы данных.
• Поэтапное обновление схемы базы данных, чтобы она соответствовала модели данных приложения. Существующие данные в базе данных сохраняются.

Visual Studio

В этом разделе окно Консоль диспетчера пакетов (PMC) используется для выполнения следующих действий:

• Добавления первоначальной миграции.

• Обновления базы данных с помощью первоначальной миграции.

• В меню Сервис последовательно выберите пункты Диспетчер пакетов NuGet>Консоль диспетчера пакетов.

  

• В PMC введите следующую команду:

  Add-Migration InitialCreate
  

• Команда Add-Migration формирует код для создания схемы исходной базы данных. Схема создается на основе модели, указанной в DbContext. Аргумент InitialCreate используется для присвоения имен миграции. Можно использовать любое имя, однако по соглашению выбирается имя, которое описывает миграцию.

Появится следующее предупреждение, которое будет устранено на следующем шаге:

"Для десятичного столбца Price в типе сущности Movie не указан тип. Это приведет к тому, что значения будут усекаться без вмешательства пользователя, если они не помещаются в значения точности и масштаба по умолчанию. С помощью метода HasColumnType() явно укажите тип столбца SQL Server, который может вместить все значения".

• В PMC введите следующую команду:

  Update-Database
  

  Команда Update-Database выполняет метод Up в миграциях, которые не были применены. В этом случае команда запускает Up метод в Migrations/<time-stamp>_InitialCreate.cs файле, который создает базу данных.

Visual Studio Code

• Щелкните правой кнопкой мыши проект RazorPagesMovie.csproj и выберите "Открыть в интегрированном терминале".

  Откроется окно терминала с командной строкой в каталоге проекта, который содержит файлы Program.cs и .csproj.

• Выполните следующую команду CLI .NET:

  dotnet ef migrations add InitialCreate
  

  Команда migrations формирует код для создания схемы исходной базы данных. Схема создается на основе модели, указанной в DbContext. Аргумент InitialCreate используется для присвоения имен миграциям. Можно использовать любое имя, однако по соглашению выбирается имя, которое описывает миграцию.

• Выполните следующую команду CLI .NET:

  dotnet ef database update
  

  Команда update выполняет метод Up в миграциях, которые не были применены. В этом случае update выполняет метод Up в файле Migrations/<time-stamp>_InitialCreate.cs, который создает базу данных.

Примечание.

Для SQLite для типа столбца для поля Price задается значение TEXT. Это будет решено на более позднем этапе.

Контекст данных RazorPagesMovieContext:

• Получается из Microsoft.EntityFrameworkCore.DbContext.
• Указывает сущности, которые включаются в модель данных.
• Координаты EF Core функций, таких как создание, чтение, обновление и удаление модели Movie .

Класс RazorPagesMovieContext в созданном файле Data/RazorPagesMovieContext.cs:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using Microsoft.EntityFrameworkCore;
using RazorPagesMovie.Models;

namespace RazorPagesMovie.Data
{
    public class RazorPagesMovieContext : DbContext
    {
        public RazorPagesMovieContext (DbContextOptions<RazorPagesMovieContext> options)
            : base(options)
        {
        }

        public DbSet<RazorPagesMovie.Models.Movie> Movie { get; set; } = default!;
    }
}

Представленный выше код создает свойство DbSet<Movie> для набора сущностей. В терминологии Entity Framework набор сущностей обычно соответствует таблице базы данных. Сущность соответствует строке в таблице.

Имя строки подключения передается в контекст путем вызова метода для объекта DbContextOptions. При локальной разработке система конфигурации считывает строку подключения из файла appsettings.json.

Тестирование приложения

1. Запустите приложение и добавьте /Movies к URL-адресу в браузере (http://localhost:port/movies).

   Если вы получите следующую ошибку:

   SqlException: Cannot open database "RazorPagesMovieContext-GUID" requested by the login. The login failed.
   Login failed for user 'User-name'.
   

   Вы пропустили шаг миграции.

2. Протестируйте ссылку Create New (Создать).

   

   Примечание.

   В поле Price нельзя вводить десятичные запятые. Чтобы обеспечить поддержку проверки jQuery для других языков, кроме английского, используйте вместо десятичной точки запятую (,), а для отображения данных в форматах для других языков, кроме английского, выполните глобализацию приложения. Инструкции по глобализации см. на сайте GitHub.

3. Проверьте ссылки Изменить, Сведения и Удалить.

В следующем учебнике рассматриваются файлы, созданные с помощью формирования шаблонов.

Проверка контекста, зарегистрированного с помощью внедрения зависимостей

ASP.NET Core поддерживает внедрение зависимостей. Службы, такие как EF Core контекст базы данных, регистрируются при внедрении зависимостей во время запуска приложения. Затем компоненты, которые используют эти службы (например, Razor Pages), предоставляются через параметры конструктора. Код конструктора, который получает экземпляр контекста базы данных, приведен далее в этом руководстве.

Средство формирования шаблонов автоматически создает контекст базы данных и регистрирует его с использованием контейнера внедрения зависимостей. Следующий выделенный код добавляется в Program.cs файл шаблоном:

Visual Studio

using Microsoft.EntityFrameworkCore;
using Microsoft.Extensions.DependencyInjection;
using RazorPagesMovie.Data;
var builder = WebApplication.CreateBuilder(args);

// Add services to the container.
builder.Services.AddRazorPages();
builder.Services.AddDbContext<RazorPagesMovieContext>(options =>
    options.UseSqlServer(builder.Configuration.GetConnectionString("RazorPagesMovieContext") ?? throw new InvalidOperationException("Connection string 'RazorPagesMovieContext' not found.")));

var app = builder.Build();

// Configure the HTTP request pipeline.
if (!app.Environment.IsDevelopment())
{
    app.UseExceptionHandler("/Error");
    // The default HSTS value is 30 days. You may want to change this for production scenarios, see https://aka.ms/aspnetcore-hsts.
    app.UseHsts();
}

app.UseHttpsRedirection();

app.UseRouting();

app.UseAuthorization();

app.MapStaticAssets();
app.MapRazorPages();

app.Run();

Visual Studio Code

using Microsoft.EntityFrameworkCore;
using Microsoft.Extensions.DependencyInjection;
using RazorPagesMovie.Data;
var builder = WebApplication.CreateBuilder(args);

// Add services to the container.
builder.Services.AddRazorPages();
builder.Services.AddDbContext<RazorPagesMovieContext>(options =>
    options.UseSqlite(builder.Configuration.GetConnectionString("RazorPagesMovieContext") ?? throw new InvalidOperationException("Connection string 'RazorPagesMovieContext' not found.")));

var app = builder.Build();

// Configure the HTTP request pipeline.
if (!app.Environment.IsDevelopment())
{
    app.UseExceptionHandler("/Error");
    // The default HSTS value is 30 days. You may want to change this for production scenarios, see https://aka.ms/aspnetcore-hsts.
    app.UseHsts();
}

app.UseHttpsRedirection();
app.UseStaticFiles();

app.UseRouting();

app.UseAuthorization();

app.MapStaticAssets();
app.MapRazorPages();

app.Run();

Устранение неполадок с завершенным примером

Если вы столкнулись с проблемой, которую не можете решить, сравните свой код с кодом готового проекта. Просмотрите или скачайте завершенный проект (порядок загрузки).

Следующие шаги

Предыдущая статья: Начало работыследующим: шаблонные Razor страницы