Часть 4. Razor Страницы с EF Core миграцией в ASP.NET Core

Авторы: Том Дайкстра (Tom Dykstra), Йон П. Смит (Jon P Smith) и Рик Андерсон (Rick Anderson)

Веб-приложение Contoso University демонстрирует создание Razor веб-приложений Pages с помощью EF Core Visual Studio. Сведения о серии руководств см. в первом руководстве серии.

При возникновении проблем, которые вам не удается устранить, скачайте готовое приложение и сравните его код с тем, который вы создали в процессе работы с этим руководством.

В этом руководстве представлена EF Core функция миграции для управления изменениями модели данных.

При разработке нового приложения модель данных часто изменяется. При каждом изменении нарушается синхронизация модели с базой данных. Вы начали работу с этой серией учебников с настройки платформы Entity Framework для создания базы данных, если она еще не существует. При каждом изменении модели данных базу данных необходимо удалять. При следующем запуске приложения вызов EnsureCreated повторно создает базу данных в соответствии с новой моделью данных. Затем выполняется класс DbInitializer для заполнения новой базы данных.

Такой подход к обеспечению синхронизации базы данных с использованием модели данных хорошо работает, пока приложение не нужно развертывать в рабочей среде. Приложение, выполняющееся в рабочей среде, обычно содержит данные. Приложение не может запускаться с тестовой базой данных каждый раз при внесении изменений (например, при добавлении столбца). Функция EF Core миграции решает эту проблему, позволяя EF Core обновить схему базы данных вместо создания новой базы данных.

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

Примечание.

Ограничения SQLite

В этом руководстве используется функция миграции Entity Framework Core, где это возможно. Во время миграции обновляется схема базы данных в соответствии с изменениями в модели данных. Однако миграции могут вносить только такие изменения, которые поддерживает ядро СУБД, а возможности изменения схемы SQLite ограничены. Например, добавление столбца поддерживается, но удаление столбца не поддерживается. Если миграция создается для удаления столбца, команда ef migrations add выполняется успешно, а команда ef database update — нет.

Обходной путь для ограничений SQLite — вручную написать код миграции для перестроения таблицы в случае изменений. Код для миграции находится в методах Up и Down и выполняет следующие действия:

• Создание новой таблицы.
• Копирование данных из старой таблицы в новую.
• Удаление старой таблицы.
• Переименование новой таблицы.

Написание кода такого рода для конкретной базы данных выходит за рамки данного учебника. Вместо этого в данном учебнике база данных удаляется и создается повторно, когда попытка применить миграцию завершается сбоем. Дополнительные сведения см. на следующих ресурсах:

• Ограничения поставщика базы данных SQLite EF Core
• Настройка кода миграции
• Присвоение начальных значений данных
• Инструкция по ALTER TABLE SQLite

Удалите базу данных:

Visual Studio

Используйте обозреватель объектов SQL Server, чтобы удалить базу данных, или выполните следующую команду в консоли диспетчера пакетов (PMC):

Drop-Database

Visual Studio Code

• Чтобы установить CLI EF, выполните в командной строке следующую команду:

  dotnet tool install --global dotnet-ef
  

Примечание.

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

• В командной строке перейдите к папке проекта. Папка проекта содержит ContosoUniversity.csproj файл.

• CU.db Удалите файл или выполните следующую команду:

  dotnet ef database drop --force
  

Создание первоначальной миграции

Visual Studio

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

Add-Migration InitialCreate
Update-Database

Visual Studio Code

Убедитесь в том, что в командной строке выбрана папка проекта, и выполните следующие команды:

dotnet ef migrations add InitialCreate
dotnet ef database update

Удаление EnsureCreated

Эта серия учебников началась с использования EnsureCreated. Метод EnsureCreated не создает таблицу журнала миграций и поэтому не может использоваться с функцией миграций. Он предназначен для тестирования или быстрого создания прототипов, когда часто требуется удалять и повторно создавать базу данных.

Начиная с этого момента в учебниках будут использоваться миграции.

Удалите Program.csследующую строку:

context.Database.EnsureCreated();

Запустите приложение и убедитесь в том, что база данных заполняется.

Методы Up и Down

Команда EF Coremigrations add создала код для создания базы данных. Код миграций содержится в файле Migrations\<timestamp>_InitialCreate.cs. Метод Up класса InitialCreate создает таблицы базы данных, соответствующие наборам сущностей модели данных. Метод Down удаляет их, как показано в следующем примере:

using System;
using Microsoft.EntityFrameworkCore.Metadata;
using Microsoft.EntityFrameworkCore.Migrations;

namespace ContosoUniversity.Migrations
{
    public partial class InitialCreate : Migration
    {
        protected override void Up(MigrationBuilder migrationBuilder)
        {
            migrationBuilder.CreateTable(
                name: "Course",
                columns: table => new
                {
                    CourseID = table.Column<int>(nullable: false),
                    Title = table.Column<string>(nullable: true),
                    Credits = table.Column<int>(nullable: false)
                },
                constraints: table =>
                {
                    table.PrimaryKey("PK_Course", x => x.CourseID);
                });

            migrationBuilder.CreateTable(
                name: "Student",
                columns: table => new
                {
                    ID = table.Column<int>(nullable: false)
                        .Annotation("SqlServer:ValueGenerationStrategy", SqlServerValueGenerationStrategy.IdentityColumn),
                    LastName = table.Column<string>(nullable: true),
                    FirstMidName = table.Column<string>(nullable: true),
                    EnrollmentDate = table.Column<DateTime>(nullable: false)
                },
                constraints: table =>
                {
                    table.PrimaryKey("PK_Student", x => x.ID);
                });

            migrationBuilder.CreateTable(
                name: "Enrollment",
                columns: table => new
                {
                    EnrollmentID = table.Column<int>(nullable: false)
                        .Annotation("SqlServer:ValueGenerationStrategy", SqlServerValueGenerationStrategy.IdentityColumn),
                    CourseID = table.Column<int>(nullable: false),
                    StudentID = table.Column<int>(nullable: false),
                    Grade = table.Column<int>(nullable: true)
                },
                constraints: table =>
                {
                    table.PrimaryKey("PK_Enrollment", x => x.EnrollmentID);
                    table.ForeignKey(
                        name: "FK_Enrollment_Course_CourseID",
                        column: x => x.CourseID,
                        principalTable: "Course",
                        principalColumn: "CourseID",
                        onDelete: ReferentialAction.Cascade);
                    table.ForeignKey(
                        name: "FK_Enrollment_Student_StudentID",
                        column: x => x.StudentID,
                        principalTable: "Student",
                        principalColumn: "ID",
                        onDelete: ReferentialAction.Cascade);
                });

            migrationBuilder.CreateIndex(
                name: "IX_Enrollment_CourseID",
                table: "Enrollment",
                column: "CourseID");

            migrationBuilder.CreateIndex(
                name: "IX_Enrollment_StudentID",
                table: "Enrollment",
                column: "StudentID");
        }

        protected override void Down(MigrationBuilder migrationBuilder)
        {
            migrationBuilder.DropTable(
                name: "Enrollment");

            migrationBuilder.DropTable(
                name: "Course");

            migrationBuilder.DropTable(
                name: "Student");
        }
    }
}

Приведенный выше код предназначен для первоначальной миграции. Код.

• был создан командой migrations add InitialCreate;
• выполняется командой database update;
• создает базу данных для модели данных, заданной классом контекста базы данных.

Параметр имени миграции (в примере это InitialCreate) используется в качестве имени файла. В качестве имени миграции можно использовать любое допустимое имя файла. Рекомендуется выбрать слово или фразу, которые кратко описывают назначение миграции. Например, миграция, обеспечивающая добавление таблицы кафедр, может называться "AddDepartmentTable".

Таблица журнала миграции

• Используйте SSOX или средство SQLite для просмотра базы данных.
• Обратите внимание на добавление таблицы __EFMigrationsHistory. Таблица __EFMigrationsHistory используется для отслеживания миграций, которые были применены к базе данных.
• Просмотрите данные в таблице __EFMigrationsHistory. Вы увидите одну строку для первой миграции.

Моментальный снимок модели данных

Миграции создают моментальный снимок текущей модели данных.Migrations/SchoolContextModelSnapshot.cs После добавления миграции EF определяет изменения, сравнивая текущую модель данных с файлом моментального снимка.

Так как файл моментального снимка отслеживает состояние модели данных, миграцию нельзя удалить, удалив файл <timestamp>_<migrationname>.cs. Чтобы отменить последнюю миграцию, используйте команду migrations remove. migrations remove удаляет миграцию и гарантирует корректный сброс моментального снимка. Дополнительные сведения см. в разделе dotnet ef migrations remove.

См. дополнительные сведения в статье Сброс всех миграций.

Применение миграций в рабочей среде

Для рабочих приложений не рекомендуется вызывать Database.Migrate при запуске приложения. Migrate не следует вызывать из приложения, развернутого в ферме серверов. Если приложение масштабируется в нескольких экземплярах сервера, трудно гарантировать, что изменения схемы базы данных не будут выполняться с нескольких серверов и не будут конфликтовать с обращениями для чтения или записи.

Миграция базы данных должна выполняться контролируемым способом в рамках развертывания. Подход к миграции рабочей базы данных включает следующее:

• Использование миграций для создания сценариев SQL и их использования в развертывании.
• Выполнение dotnet ef database update из контролируемой среды.

Устранение неполадок

Если приложение использует SQL Server LocalDB и выводит следующее исключение:

SqlException: Cannot open database "ContosoUniversity" requested by the login.
The login failed.
Login failed for user 'user name'.

решением может быть выполнение dotnet ef database update из командной строки.

Дополнительные ресурсы

• EF Core CLI.
• Команды CLI для миграций dotnet EF
• Консоль диспетчера пакетов (Visual Studio)

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

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

Предыдущий учебникСледующий учебник