第 4 部分，将模型添加到 ASP.NET Core MVC 应用

作者：Rick Anderson 和 Jon P Smith。

在本教程中，添加了用于管理数据库中的电影的类。 这些类是 MVC 应用的“Model”部分。

这些模型类与 Entity Framework Core (EF Core) 一起使用来处理数据库。 EF Core 是一个对象关系映射 (ORM) 框架，可以简化需要编写的数据访问代码。

创建的模型类称为 POCO 类，它的全称为“Plain Old CLR Object（普通旧 CLR 对象）”。 POCO 类对 EF Core 没有任何依赖性。 它们只定义数据库中存储的数据属性。

在本教程中，首先要创建模型类，然后 EF Core 将创建数据库。

添加数据模型类

Visual Studio

右键单击 Models 文件夹 >“添加”>“类”。 命名文件 Movie.cs。

Visual Studio Code

将名为 Movie.cs 的文件添加到“Models”文件夹。

使用以下代码更新 Models/Movie.cs 文件：

using System.ComponentModel.DataAnnotations;

namespace MvcMovie.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 字段，数据需要该字段作为主键。

ReleaseDate 上的 DataType 特性指定了数据的类型 (Date)。 通过此特性：

• 用户无需在日期字段中输入时间信息。
• 仅显示日期，而非时间信息。

DataAnnotations 会在后续教程中介绍。

string 后的问号表示属性可为空。 有关详细信息，请参阅可为空引用类型。

添加 NuGet 包

Visual Studio

Visual Studio 会自动安装所需的包。

生成项目以检查编译器错误。

Visual Studio Code

运行以下 .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 基架工具。
• EF Core 的设计时工具
• EF Core SQLite 提供程序，它将 EF Core 包作为依赖项进行安装。
• 基架需要的包：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) 在不调试的情况下运行应用。

在编辑器区域下面的面板中，选择“问题”选项卡，或者从“视图”菜单中选择“问题”（如果当前不在视图中）。 验证没有编译错误。

基架电影页面

使用基架工具为电影模型生成 Create、Read、Update 和 Delete (CRUD) 页面。

Visual Studio

在“解决方案资源管理器”中，右键单击 Controllers 文件夹，并选择“添加”>“新搭建基架的项目”。

在“添加新基架项”对话框中：

• 在左窗格中，选择“已安装”>“常用”>“MVC”。
• 选择“视图使用实体框架的 MVC 控制器”。
• 选择 添加 。

完成“使用实体框架添加包含视图的 MVC 控制器”对话框中的内容：

• 在“模型类”下拉列表中，选择“Movie (MvcMovie.Models)”。
• 在“数据上下文类”行中，选择 +（加号）。
  • 在“添加数据上下文”对话框中，将生成类名 MvcMovie.Data.MvcMovieContext。
  • 选择 添加 。
• 在“数据库提供程序”下拉列表中，选择“SQL Server”。
• “视图”和“控制器名称”：保留默认值。
• 选择 添加 。

如果收到错误消息，请再次选择“添加”以重试。

基架添加以下包：

• Microsoft.EntityFrameworkCore.SqlServer
• Microsoft.EntityFrameworkCore.Tools
• Microsoft.VisualStudio.Web.CodeGeneration.Design

基架创建以下内容：

• 电影控制器：Controllers/MoviesController.cs
• “创建”、“删除”、“详细信息”、“编辑”和“索引”页面的 Razor 视图文件：Views/Movies/*.cshtml
• 数据库上下文类：Data/MvcMovieContext.cs

基架更新以下内容：

• 在 MvcMovie.csproj 项目文件中插入所需的包引用。
• 在 Program.cs 文件中注册数据库上下文。
• 将数据库连接字符串添加到 appsettings.json 文件。

自动创建这些文件和文件更新被称为“基架”。

尚且不能使用基架页面，因为该数据库不存在。 运行应用并选择“Movie App”链接会导致“无法打开数据库”或“无此类表: Movie”错误消息。

生成应用以验证没有任何错误。

Visual Studio Code

在项目目录中打开命令窗口。 项目目录是包含 Program.cs 和 .csproj 文件的目录。

在 macOS 和 Linux 上，导出基架工具路径：

export PATH=$HOME/.dotnet/tools:$PATH

运行下面的命令：

dotnet aspnet-codegenerator controller -name MoviesController -m Movie -dc MvcMovie.Data.MvcMovieContext --relativeFolderPath Controllers --useDefaultLayout --referenceScriptLibraries --databaseProvider sqlite

下表详细说明了 ASP.NET Core 代码生成器参数：

参数	说明
-M	模型的名称。
-dc	数据上下文。
--relativeFolderPath	用于创建文件的相对输出文件夹路径。
--useDefaultLayout|-udl	应为视图使用默认布局。
--referenceScriptLibraries	向“编辑”和“创建”页面添加 _ValidationScriptsPartial。
--databaseProvider sqlite	指定 DbContext 应使用 SQLite 而不是 SQL Server。

使用 h 开关获取 aspnet-codegenerator controller 命令方面的帮助：

dotnet aspnet-codegenerator controller -h

有关详细信息，请查看 dotnet aspnet-codegenerator

基架创建以下内容：

• 电影控制器：Controllers/MoviesController.cs
• “创建”、“删除”、“详细信息”、“编辑”和“索引”页面的 Razor 视图文件：Views/Movies/*.cshtml
• 数据库上下文类：Data/MvcMovieContext.cs

基架更新以下内容：

• 在 Program.cs 文件中注册数据库上下文
• 将数据库连接字符串添加到 appsettings.json 文件。

自动创建这些文件和文件更新被称为“基架”。

尚且不能使用基架页面，因为该数据库不存在。 运行应用并选择“Movie App”链接会导致“无法打开数据库”或“无此类表: Movie”错误消息。

生成应用以验证没有任何错误。

将 SQLite 用于开发，将 SQL Server 用于生产

Program.cs 中突出显示的以下代码展示了如何在开发中使用 SQLite，以及在生产中使用 SQL Server。

var builder = WebApplication.CreateBuilder(args);

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

初始迁移

使用 EF Core迁移功能来创建数据库。 迁移是可用于创建和更新数据库以匹配数据模型的一组工具。

Visual Studio

从“工具”菜单中，选择“NuGet 程序包管理器”>“包管理器控制台”。

在包管理器控制台 (PMC) 中输入以下命令：

Add-Migration InitialCreate

• Add-Migration InitialCreate：生成 Migrations/{timestamp}_InitialCreate.cs 迁移文件。 InitialCreate 参数是迁移名称。 可以使用任何名称，但是按照惯例，会选择可说明迁移的名称。 因为这是首次迁移，所以生成的类包含用于创建数据库架构的代码。 数据库架构基于在 MvcMovieContext 类中指定的模型。

将显示以下警告，该警告将在后面的步骤中解决：

未对实体类型“Movie”上的十进制属性“Price”指定任何存储类型。 This will cause values to be silently truncated if they do not fit in the default precision and scale. 使用“HasColumnType”显式指定可容纳“OnModelCreating”中所有值的 SQL Server 列类型，使用“HasPrecision”指定精度和小数位数，或者使用“HasConversion”配置值转换器。

在 PMC 中，输入以下命令：

Update-Database

• Update-Database：将数据库更新到上一个命令创建的最新迁移。 此命令在用于创建数据库的 Migrations/{time-stamp}_InitialCreate.cs 文件中运行 Up 方法。

有关 EF Core 的 PMC 工具的详细信息，请参阅 EF Core 工具引用 - Visual Studio 中的 PMC。

Visual Studio Code

运行以下 .NET CLI 命令：

dotnet ef migrations add InitialCreate

• ef migrations add InitialCreate：生成 Migrations/{timestamp}_InitialCreate.cs 迁移文件。 InitialCreate 参数是迁移名称。 可以使用任何名称，但是按照惯例，会选择可说明迁移的名称。 因为这是首次迁移，所以生成的类包含用于创建数据库架构的代码。 数据库架构基于在 MvcMovieContext 类（位于 Data/MvcMovieContext.cs 文件中）中指定的模型。

将显示以下警告，该警告将在后面的步骤中解决：

未对实体类型“Movie”上的十进制属性“Price”指定任何存储类型。 This will cause values to be silently truncated if they do not fit in the default precision and scale. 使用“HasColumnType”显式指定可容纳“OnModelCreating”中所有值的 SQL Server 列类型，使用“HasPrecision”指定精度和小数位数，或者使用“HasConversion”配置值转换器。

运行以下 .NET CLI 命令：

dotnet ef database update

• ef database update：将数据库更新到上一个命令创建的最新迁移。 此命令在用于创建数据库的 Migrations/{time-stamp}_InitialCreate.cs 文件中运行 Up 方法。

若要详细了解如何维护多个提供程序（例如 Microsoft SQL Server 和 SQLite），请参阅使用多个提供程序进行迁移。

测试应用

Visual Studio

运行应用并选择“Movie App”链接。

如果收到类似于以下内容的异常，可能是因为遗漏了迁移步骤中的 Update-Database 命令：

SqlException: Cannot open database "MvcMovieContext-1" requested by the login. The login failed.

Visual Studio Code

运行应用并选择“Movie App”链接。

如果收到类似于以下内容的异常，可能是因为遗漏了迁移步骤中的 dotnet ef database update 命令：

SqliteException: SQLite Error 1: 'no such table: Movie'.

注意

可能无法在 Price 字段中输入十进制逗号。 若要使 jQuery 验证支持使用逗号（“,”）表示小数点的非英语区域设置，以及支持非美国英语日期格式，应用必须进行全球化。 有关全球化的说明，请参阅此 GitHub 问题。

检查生成的数据库上下文类和注册

对于 EF Core，使用模型执行数据访问。 模型由实体类和表示数据库会话的上下文对象构成。 上下文对象允许查询并保存数据。 数据库上下文派生自 Microsoft.EntityFrameworkCore.DbContext 并指定要包含在数据模型中的实体。

基架创建 Data/MvcMovieContext.cs 数据库上下文类：

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

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

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

前面的代码创建一个 DbSet<Movie> 属性，该属性表示数据库中的电影。

依赖项注入

ASP.NET Core 通过依赖关系注入 (DI) 生成。 服务（如数据库上下文）在 Program.cs 中向 DI 注册。 这些服务通过构造函数参数提供给需要它们的组件。

在 Controllers/MoviesController.cs 文件中，构造函数使用依赖关系注入将 MvcMovieContext 数据库上下文注入到控制器中。 数据库上下文将在控制器中的每个 CRUD 方法中使用。

基架在 Program.cs 中生成了以下突出显示的代码：

Visual Studio

var builder = WebApplication.CreateBuilder(args);
builder.Services.AddDbContext<MvcMovieContext>(options =>
    options.UseSqlServer(builder.Configuration.GetConnectionString("MvcMovieContext") ?? throw new InvalidOperationException("Connection string 'MvcMovieContext' not found.")));

Visual Studio Code

var builder = WebApplication.CreateBuilder(args);
builder.Services.AddDbContext<MvcMovieContext>(options =>
    options.UseSqlite(builder.Configuration.GetConnectionString("MvcMovieContext")));

ASP.NET Core 配置系统读取“MvcMovieContext”数据库连接字符串。

检查生成的数据库连接字符串

基架向 appsettings.json 文件添加了一个连接字符串：

Visual Studio

{
  "Logging": {
    "LogLevel": {
      "Default": "Information",
      "Microsoft.AspNetCore": "Warning"
    }
  },
  "AllowedHosts": "*",
  "ConnectionStrings": {
    "MvcMovieContext": "Server=(localdb)\\mssqllocaldb;Database=MvcMovieContext-4ebefa10-de29-4dea-b2ad-8a8dc6bcf374;Trusted_Connection=True;MultipleActiveResultSets=true"
  }
}

Visual Studio Code

{
  "Logging": {
    "LogLevel": {
      "Default": "Information",
      "Microsoft.AspNetCore": "Warning"
    }
  },
  "AllowedHosts": "*",
  "ConnectionStrings": {
    "MvcMovieContext": "Data Source=MvcMovie.db"
  }
}

进行本地开发时，ASP.NET Core 配置系统在 appsettings.json 文件中读取 ConnectionString 键。

InitialCreate 类

检查 Migrations/{timestamp}_InitialCreate.cs 迁移文件：

using System;
using Microsoft.EntityFrameworkCore.Migrations;

#nullable disable

namespace MvcMovie.Migrations
{
    /// <inheritdoc />
    public partial class InitialCreate : Migration
    {
        /// <inheritdoc />
        protected override void Up(MigrationBuilder migrationBuilder)
        {
            migrationBuilder.CreateTable(
                name: "Movie",
                columns: table => new
                {
                    Id = table.Column<int>(type: "int", nullable: false)
                        .Annotation("SqlServer:Identity", "1, 1"),
                    Title = table.Column<string>(type: "nvarchar(max)", nullable: true),
                    ReleaseDate = table.Column<DateTime>(type: "datetime2", nullable: false),
                    Genre = table.Column<string>(type: "nvarchar(max)", nullable: true),
                    Price = table.Column<decimal>(type: "decimal(18,2)", nullable: false)
                },
                constraints: table =>
                {
                    table.PrimaryKey("PK_Movie", x => x.Id);
                });
        }

        /// <inheritdoc />
        protected override void Down(MigrationBuilder migrationBuilder)
        {
            migrationBuilder.DropTable(
                name: "Movie");
        }
    }
}

在上述代码中：

• InitialCreate.Up 创建 Movie 表，并将 Id 配置为主键。
• InitialCreate.Down 还原 Up 迁移所做的架构更改。

控制器中的依赖项注入

打开 Controllers/MoviesController.cs 文件并检查构造函数：

public class MoviesController : Controller
{
    private readonly MvcMovieContext _context;

    public MoviesController(MvcMovieContext context)
    {
        _context = context;
    }

构造函数使用依赖关系注入将数据库上下文 (MvcMovieContext) 注入到控制器中。 数据库上下文将在控制器中的每个 CRUD 方法中使用。

测试“创建”页。 输入并提交数据。

测试“编辑”、“详细信息”和“删除”页 。

强类型模型和 @model 指令

在本教程之前的内容中，已经介绍了控制器如何使用 ViewData 字典将数据或对象传递给视图。 ViewData 字典是一个动态对象，提供了将信息传递给视图的方便的后期绑定方法。

MVC 提供将强类型模型对象传递给视图的功能。 此强类型方法启用编译时代码检查。 基架机制在 MoviesController 类和视图中传递了一个强类型模型。

检查 Controllers/MoviesController.cs 文件中生成的 Details 方法：

// GET: Movies/Details/5
public async Task<IActionResult> Details(int? id)
{
    if (id == null)
    {
        return NotFound();
    }

    var movie = await _context.Movie
        .FirstOrDefaultAsync(m => m.Id == id);
    if (movie == null)
    {
        return NotFound();
    }

    return View(movie);
}

id 参数通常作为路由数据传递。 例如，https://localhost:5001/movies/details/1 的设置如下：

• 控制器被设置为 movies 控制器（第一个 URL 段）。
• 操作被设置为 details（第二个 URL 段）。
• id 被设置为 1（最后一个 URL 段）。

id 可以通过查询字符串传入，如以下示例所示：

https://localhost:5001/movies/details?id=1

在未提供 id 值的情况下，id 参数可定义为可以为 null 的类型 (int?)。

Lambda 表达式会被传入 FirstOrDefaultAsync 方法以选择与路由数据或查询字符串值相匹配的电影实体。

var movie = await _context.Movie
    .FirstOrDefaultAsync(m => m.Id == id);

如果找到了电影，Movie 模型的实例则会被传递到 Details 视图：

return View(movie);

检查 Views/Movies/Details.cshtml 文件的内容：

@model MvcMovie.Models.Movie

@{
    ViewData["Title"] = "Details";
}

<h1>Details</h1>

<div>
    <h4>Movie</h4>
    <hr />
    <dl class="row">
        <dt class = "col-sm-2">
            @Html.DisplayNameFor(model => model.Title)
        </dt>
        <dd class = "col-sm-10">
            @Html.DisplayFor(model => model.Title)
        </dd>
        <dt class = "col-sm-2">
            @Html.DisplayNameFor(model => model.ReleaseDate)
        </dt>
        <dd class = "col-sm-10">
            @Html.DisplayFor(model => model.ReleaseDate)
        </dd>
        <dt class = "col-sm-2">
            @Html.DisplayNameFor(model => model.Genre)
        </dt>
        <dd class = "col-sm-10">
            @Html.DisplayFor(model => model.Genre)
        </dd>
        <dt class = "col-sm-2">
            @Html.DisplayNameFor(model => model.Price)
        </dt>
        <dd class = "col-sm-10">
            @Html.DisplayFor(model => model.Price)
        </dd>
    </dl>
</div>
<div>
    <a asp-action="Edit" asp-route-id="@Model.Id">Edit</a> |
    <a asp-action="Index">Back to List</a>
</div>

视图文件顶部的 @model 语句可指定视图期望的对象类型。 创建影片控制器时，将包含以下 @model 语句：

@model MvcMovie.Models.Movie

此 @model 指令允许访问控制器传递给视图的影片。 Model 对象为强类型对象。 例如，在 Details.cshtml 视图中，代码通过强类型的 Model 对象将每个电影字段传递给 DisplayNameFor 和 DisplayFor HTML 帮助程序。 Create 和 Edit 方法以及视图也传递一个 Movie 模型对象。

检查电影控制器中的 Index.cshtml 视图和 Index 方法。 请注意代码在调用 View 方法时是如何创建 List 对象的。 代码将此 Movies 列表从 Index 操作方法传递给视图：

// GET: Movies
public async Task<IActionResult> Index()
{
    return View(await _context.Movie.ToListAsync());
}

如果数据上下文的 Movie 属性为 null，则代码返回问题详细信息。

创建电影控制器后，基架将以下 @model 语句包含在 Index.cshtml 文件的顶部：

@model IEnumerable<MvcMovie.Models.Movie>

@model 指令允许使用强类型的 Model 对象访问控制器传递给视图的电影列表。 例如，在 Index.cshtml 视图中，代码使用 foreach 语句通过强类型 Model 对象对电影进行循环遍历：

@model IEnumerable<MvcMovie.Models.Movie>

@{
    ViewData["Title"] = "Index";
}

<h1>Index</h1>

<p>
    <a asp-action="Create">Create New</a>
</p>
<table class="table">
    <thead>
        <tr>
            <th>
                @Html.DisplayNameFor(model => model.Title)
            </th>
            <th>
                @Html.DisplayNameFor(model => model.ReleaseDate)
            </th>
            <th>
                @Html.DisplayNameFor(model => model.Genre)
            </th>
            <th>
                @Html.DisplayNameFor(model => model.Price)
            </th>
            <th></th>
        </tr>
    </thead>
    <tbody>
@foreach (var item in Model) {
        <tr>
            <td>
                @Html.DisplayFor(modelItem => item.Title)
            </td>
            <td>
                @Html.DisplayFor(modelItem => item.ReleaseDate)
            </td>
            <td>
                @Html.DisplayFor(modelItem => item.Genre)
            </td>
            <td>
                @Html.DisplayFor(modelItem => item.Price)
            </td>
            <td>
                <a asp-action="Edit" asp-route-id="@item.Id">Edit</a> |
                <a asp-action="Details" asp-route-id="@item.Id">Details</a> |
                <a asp-action="Delete" asp-route-id="@item.Id">Delete</a>
            </td>
        </tr>
}
    </tbody>
</table>

因为 Model 对象为强类型（作为 IEnumerable<Movie> 对象），因此循环中的每个项都被类型化为 Movie。 编译器还有一些其他优势，比如验证代码中使用的类型。

其他资源

• 面向初学者的 Entity Framework Core
• 标记帮助程序
• 全球化和本地化

上一篇：添加视图下一篇：使用 SQL