第 2 部分：在 ASP.NET Core 中將模型新增至 Razor Pages 應用程式

在本教學課程中，您可以新增類別來管理資料庫中的電影。 應用程式的模型類別會使用 Entity Framework Core (EF Core) 來處理資料庫。 EF Core 是可簡化資料存取的物件關聯式對應工具 (O/RM)。 您可先撰寫模型類別，然後 EF Core 會建立資料庫。

模型類別稱為 POCO 類別 (來自「純舊 CLR 物件」)，因為它們對 EF Core 沒有任何相依性。 它們會定義資料儲存在資料庫中的屬性。

新增資料模型

Visual Studio

1. 在 方案總管中，以滑鼠右鍵按一下 RazorPagesMovie 專案 >新增>新增資料夾。 將資料夾命名為 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. 將類別新增至名為 Movie.cs 的 Models 資料夾。

將下列屬性新增至 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 CLI 命令：

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

上述命令會新增：

• 適用於 EF Core 的命令列介面 (CLI) 工具
• aspnet-codegenerator Scaffolding 工具。
• 適用於 EF Core 的設計階段工具
• EF Core SQLite 提供者，該提供者會將 EF Core 套件作為相依性安裝。
• Scaffolding Microsoft.VisualStudio.Web.CodeGeneration.Design 和 Microsoft.EntityFrameworkCore.SqlServer 需要的套件。

如需允許應用程式依環境設定其資料庫內容的多個環境設定指引，請參閱在 ASP.NET Core 中使用多個環境。

注意

根據預設，要安裝的 .NET 二進位檔架構代表目前執行的 OS 架構。 若要指定不同的 OS 架構，請參閱 dotnet tool install, --arch option。 如需詳細資訊，請參閱 GitHub 問題 dotnet/AspNetCore.Docs #29262。

在 Visual Studio Code 中，按 Ctrl+F5 (Windows) 或 ⌘+F5 (macOS)，以執行應用程式而不進行偵錯。

在編輯器區域下方的 [面板] 中選取 [問題] 索引標籤，或從 [檢視] 功能表中選取 [問題] (如果目前不在檢視中)。 確認沒有編譯錯誤。

Scaffold 影片模型

在本節中會 scaffold 影片模型。 亦即 Scaffolding 工具會產生影片模型的建立、讀取、更新和刪除 (CRUD) 作業頁面。

Visual Studio

1. 建立 Pages/Movies 資料夾：

   1. 以滑鼠右鍵按一下 Pages 資料夾 >[新增]>[新增資料夾]。
   2. 將資料夾命名為 Movies。

2. 以滑鼠右鍵按一下 Pages/Movies 資料夾 >[新增]>[新增 Scaffolded 項目]。

   

3. 在 [新增 Scaffold] 對話方塊中，選取 [使用 Entity Framework (CRUD) 的 Razor Pages]>[新增]。

   

4. 完成 [使用 Entity Framework (CRUD) 新增 Razor Pages] 對話方塊：

   1. 在 [模型類別] 下拉式清單中選取 [Movie (RazorPagesMovie.Models)] \(影片 (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 新增至 Edit 和 Create 頁面

使用 -h 選項取得 dotnet aspnet-codegenerator razorpage 命令的說明：

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。

警告

本文使用本機資料庫，其不需要使用者進行驗證。 實際執行應用程式應該使用可用的最安全驗證流程。 如需已部署測試與實際執行應用程式驗證的詳細資訊，請參閱安全驗證流程。

建立和更新的檔案

Scaffold 處理序會建立下列檔案：

• Pages/Movies：建立、刪除、詳細資料、編輯和索引。
• Data/RazorPagesMovieContext.cs

下一個教學課程將說明建立的檔案。

Scaffold 程序會將下列醒目提示的程式碼新增至 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 引數可用來命名移轉。 您可以使用任何名稱，但依照慣例，會選取描述移轉的名稱。

畫面上顯示下列警告，在稍後的步驟中會解決此問題：

沒有為實體型別 'Movie' 上的十進位資料行 'Price' 指定型別。 如果它們不符合預設的有效位數和小數位數，會導致以無訊息模式截斷這些值。 使用 'HasColumnType()' 明確指定可容納所有值的 SQL 伺服器資料行型別。

• 在 PMC 中，輸入下列命令：

  Update-Database
  

  Update-Database 命令會在尚未套用的移轉中執行 Up 方法。 在此情況下，命令會在 Migrations/<time-stamp>_InitialCreate.cs 檔案中執行 Up 方法，以建立資料庫。

Visual Studio Code

• 以滑鼠右鍵按一下 RazorPagesMovie.csproj 專案，然後選取 在整合式終端開啟。

  [終端機] 視窗會在含有 Program.cs 和 .csproj 檔案的專案目錄開啟命令提示字元。

• 執行下列 .NET CLI 命令：

  dotnet ef migrations add InitialCreate
  

  migrations 命令會產生程式碼來建立初始資料庫結構描述。 結構描述是以 DbContext 中指定的模型為基礎。 InitialCreate 引數用來命名移轉。 您可以使用任何名稱，但依照慣例，會選取描述移轉的名稱。

• 執行下列 .NET CLI 命令：

  dotnet ef database update
  

  update 命令會在尚未套用的移轉中執行 Up 方法。 在此情況下，update 會在 Migrations/<time-stamp>_InitialCreate.cs 檔案中執行 Up 方法，以建立資料庫。

注意

若為 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. 測試新建連結。

   

   注意

   您可能無法在 Price 欄位中輸入小數逗號。 若要對使用逗號 (",") 作為小數點的非英文地區設定和非英文日期格式支援 jQuery 驗證，則必須將應用程式全球化。 如需全球化指示，請參閱此 GitHub 問題 \(英文\)。

3. 測試 Edit、Details 和 Delete 連結。

下一個教學課程說明 Scaffolding 所建立的檔案。

檢查使用相依性插入所註冊的內容

ASP.NET Core 內建相依性插入。 服務 (例如 EF Core 資料庫內容) 是在應用程式啟動期間使用相依性插入來註冊。 需要這些服務的元件 (例如 Razor Pages) 會透過建構函式參數提供。 取得資料庫內容執行個體的建構函式程式碼會顯示在本教學課程稍後部分。

Scaffolding 工具會自動建立資料庫內容，並向相依性插入容器註冊。 Scaffolder 會將下列醒目提示的程式碼新增至 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();

使用已完成的範例進行疑難排解

若您遇到無法解決的問題，請將您的程式碼與已完成的專案進行比較。 檢視或下載已完成的專案 (如何下載)。

下一步

上一步：開始使用下一步：Scaffold Razor Pages