Asp.netCore3.1 Web应用

在 ASP.NET Core 中向 Razor Pages 应用添加模型

在本节中，添加了用于管理跨平台 SQLite 数据库中的电影的类。从 ASP.NET Core 模板创建的应用使用 SQLite 数据库。应用的模型类配合 Entity Framework Core (EF Core)（SQLite EF Core 数据库提供程序）使用，以处理数据库。 EF Core 是一种对象关系映射 (ORM) 框架，可以简化数据访问。

模型类称为 POCO 类（源自“简单传统 CLR 对象”），因为它们与 EF Core 没有任何依赖关系。它们定义数据库中存储的数据属性。

查看或下载示例代码（如何下载）。

添加数据模型

Visual Studio
右键单击“RazorPagesMovie” 项目 >“添加” > “新建文件夹” 。将文件夹命名为“Models” 。

右键单击“Models”文件夹。选择“添加” > “类” 。将类命名“Movie” 。

向 Movie 类添加以下属性：
```
using System;
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(DataType.Date)]：DataType 属性指定数据的类型（日期）。通过此特性：
  - 用户无需在数据字段中输入时间信息。
  - 仅显示日期，而非时间信息。
DataAnnotations 会在后续教程中介绍。

Visual Studio Code

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

向 Movie 类添加以下属性：

using System;
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(DataType.Date)]：DataType 属性指定数据的类型（日期）。通过此特性：
- 用户无需在数据字段中输入时间信息。
- 仅显示日期，而非时间信息。

DataAnnotations 会在后续教程中介绍。

添加数据库上下文类

在 RazorPagesMovie 项目中，创建名为“数据”的新文件夹。将以下 RazorPagesMovieContext 类添加到“Data”文件夹：

using Microsoft.EntityFrameworkCore;

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

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

前面的代码为实体集创建 DbSet 属性。在 Entity Framework 中，实体集通常与数据表相对应，具体实体与表中的行相对应。直至在后续步骤中添加依赖项，代码才可编译。

添加数据库连接字符串

向 appsettings.json 文件添加一个连接字符串，如以下突出显示的代码所示：

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

添加 NuGet 包和 EF 工具

运行以下 .NET Core CLI 命令：

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

上述命令添加：

aspnet-codegenerator 基架工具。
适用于 .NET Core CLI 的 Entity Framework Core 工具。
EF Core SQLite 提供程序将 EF Core 包作为依赖项进行安装。
基架需要的包：Microsoft.VisualStudio.Web.CodeGeneration.Design 和 Microsoft.EntityFrameworkCore.SqlServer。

有关允许应用按环境配置其数据库上下文的多个环境配置指南，请参阅在 ASP.NET Core 中使用多个环境。

如果出现基架错误，请验证目标框架名字对象 (TFM) 是否与项目文件中的 NuGet 包版本相匹配。例如，以下项目文件包含适用于 .NET Core 的版本 3.1 和所列的 NuGet 包：

<Project Sdk="Microsoft.NET.Sdk.Web">

  <PropertyGroup>
    <TargetFramework>netcoreapp3.1</TargetFramework>
  </PropertyGroup>

  <ItemGroup>
    <PackageReference Include="Microsoft.AspNetCore.Diagnostics.EntityFrameworkCore" Version="3.1.0" />
    <PackageReference Include="Microsoft.AspNetCore.Identity.EntityFrameworkCore" Version="3.1.0" />
    <PackageReference Include="Microsoft.AspNetCore.Identity.UI" Version="3.1.0" />
    <PackageReference Include="Microsoft.EntityFrameworkCore.Design" Version="3.1.0" />
    <PackageReference Include="Microsoft.EntityFrameworkCore.SqlServer" Version="3.1.0" />
    <PackageReference Include="Microsoft.EntityFrameworkCore.Tools" Version="3.1.0" />
    <PackageReference Include="Microsoft.VisualStudio.Web.CodeGeneration.Design" Version="3.1.0" />
  </ItemGroup>

</Project>

注册数据库上下文

将以下 using 语句添加到 Startup.cs 顶部：

using RazorPagesMovie.Data;
using Microsoft.EntityFrameworkCore;

使用 Startup.ConfigureServices 中的依赖关系注入容器注册数据库上下文。

public void ConfigureServices(IServiceCollection services)
{
    services.AddRazorPages();

    services.AddDbContext<RazorPagesMovieContext>(options =>
        options.UseSqlite(Configuration.GetConnectionString("MovieContext")));
}

{
  "Logging": {
    "LogLevel": {
      "Default": "Warning"
    }
  },
  "AllowedHosts": "*",
  "ConnectionStrings": {
    "MovieContext": "Data Source=MvcMovie.db"
  }
}

添加所需的 NuGet 包

运行以下 .NET Core CLI 命令，将 SQLite 和 CodeGeneration.Design 添加到项目中：

dotnet add package Microsoft.EntityFrameworkCore.SQLite
dotnet add package Microsoft.VisualStudio.Web.CodeGeneration.Design
dotnet add package Microsoft.EntityFrameworkCore.Design

Microsoft.VisualStudio.Web.CodeGeneration.Design 包对基架是必需的。

注册数据库上下文

将以下 using 语句添加到 Startup.cs 顶部：

using RazorPagesMovie.Models;
using Microsoft.EntityFrameworkCore;

使用 Startup.ConfigureServices 中的依赖关系注入容器注册数据库上下文。

public void ConfigureServices(IServiceCollection services)
{
    services.Configure<CookiePolicyOptions>(options =>
    {
        // This lambda determines whether user consent for 
        // non-essential cookies is needed for a given request.
        options.CheckConsentNeeded = context => true;
        options.MinimumSameSitePolicy = SameSiteMode.None;
    });

    services.AddDbContext<RazorPagesMovieContext>(options =>
        options.UseSqlite(Configuration.GetConnectionString("MovieContext")));

    services.AddMvc().SetCompatibilityVersion(CompatibilityVersion.Version_2_2);
}

生成项目以检查错误。

Visual Studio for Mac
- 在 Solution Pad 中，右键单击“RazorPagesMovie” 项目，然后选择“添加” >“新建文件夹...” 。将文件夹命名为“Models” 。
- 右键单击“Models” 文件夹，然后选择“添加” >“新建文件...” 。
- 在“新建文件”对话框中：
  - 在左侧窗格中，选择“常规” 。
  - 在中间窗格中，选择“空类” 。
  - 将此类命名为“Movie” ，然后选择“新建” 。
向 Movie 类添加以下属性：
```
using System;
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(DataType.Date)]：DataType 属性指定数据的类型（日期）。通过此特性：
  - 用户无需在数据字段中输入时间信息。
  - 仅显示日期，而非时间信息。
DataAnnotations 会在后续教程中介绍。

生成项目以验证没有任何编译错误。

搭建“电影”模型的基架

在此部分，将搭建“电影”模型的基架。确切地说，基架工具将生成页面，用于对“电影”模型执行创建、读取、更新和删除 (CRUD) 操作。

Visual Studio
创建“Pages/Movies”文件夹：
- 右键单击“Pages” 文件夹 >“添加” >“新建文件夹” 。
- 将文件夹命名为“Movies”
右键单击“Pages/Movies” 文件夹 >“添加” >“新搭建基架的项目” 。

在“添加基架” 对话框中，依次选择“使用实体框架的 Razor Pages (CRUD)” >“添加” 。

完成“使用实体框架(CRUD)添加 Razor Pages”对话框：
- 在“模型类”下拉列表中，选择“Movie (RazorPagesMovie.Models) 。
- 在“数据上下文类”行中，选择 +（加号）并将生成的名称从 RazorPagesMovie.Models .RazorPagesMovieContext 更改为 RazorPagesMovie.Data .RazorPagesMovieContext 。不需要此更新。它创建具有正确命名空间的数据库上下文类。
- 选择“添加” 。
appsettings.json 文件通过用于连接到本地数据的连接字符串进行更新。

Visual Studio Code

打开项目目录（包含 Program.cs 、Startup.cs 和 .csproj 文件的目录）中的命令窗口。

安装基架工具：

dotnet tool install --global dotnet-aspnet-codegenerator

对于 Windows：运行下面的命令：

dotnet aspnet-codegenerator razorpage -m Movie -dc RazorPagesMovieContext -udl -outDir Pages\Movies --referenceScriptLibraries

对于 macOS 和 Linux：运行下面的命令：

dotnet aspnet-codegenerator razorpage -m Movie -dc RazorPagesMovieContext -udl -outDir Pages/Movies --referenceScriptLibraries
dotnet tool install --global dotnet-aspnet-codegenerator

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

参数	说明
-m	模型的名称。
-dc	要使用的 `DbContext` 类。
-udl	使用默认布局。
-outDir	用于创建视图的相对输出文件夹路径。
--referenceScriptLibraries	向“编辑”和“创建”页面添加 `_ValidationScriptsPartial`

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

dotnet aspnet-codegenerator razorpage -h

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

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

选择 SQLite 后，模板生成的代码便可用于开发。下面的代码演示如何将 IWebHostEnvironment 注入到 Startup 中。注入 IWebHostEnvironment，以便 ConfigureServices 可以在开发中使用 SQLite 并在生产中使用 SQL Server。

public class Startup
{
    public Startup(IConfiguration configuration, IWebHostEnvironment env)
    {
        Environment = env;
        Configuration = configuration;
    }

    public IConfiguration Configuration { get; }
    public IWebHostEnvironment Environment { get; }

    public void ConfigureServices(IServiceCollection services)
    {
        if (Environment.IsDevelopment())
        {
            services.AddDbContext<MovieContext>(options =>
            options.UseSqlite(
                Configuration.GetConnectionString("MovieContext")));
        }
        else
        {
            services.AddDbContext<MovieContext>(options =>
            options.UseSqlServer(
                Configuration.GetConnectionString("MovieContext")));
        }

        services.AddRazorPages();
    }

    public void Configure(IApplicationBuilder app)
    {
        if (Environment.IsDevelopment())
        {
            app.UseDeveloperExceptionPage();
            app.UseDatabaseErrorPage();
        }
        else
        {
            app.UseExceptionHandler("/Error");
            app.UseHsts();
        }

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

        app.UseRouting();

        app.UseEndpoints(endpoints =>
        {
            endpoints.MapRazorPages();
        });
    }
}

Visual Studio for Mac
创建“Pages/Movies”文件夹：
- 右键单击“Pages” 文件夹 >“添加” >“新建文件夹” 。
- 将文件夹命名为“Movies”
右键单击“Pages/Movies” 文件夹 >“添加” >“新基架...” 。

在“新基架” 对话框中，依次选择“使用实体框架的 Razor Pages (CRUD)” >“下一步” 。

完成“使用实体框架(CRUD)添加 Razor Pages”对话框：
- 在“模型类”下拉列表中，选择或键入“Movie (RazorPagesMovie.Models)” 。
- 在“数据上下文类”行中，键入新类的名称“RazorPagesMovie.Data.RazorPagesMovieContext”。不需要此更新。它创建具有正确命名空间的数据库上下文类。
- 选择“添加” 。
appsettings.json 文件通过用于连接到本地数据的连接字符串进行更新。

添加 EF 工具

运行以下 .NET Core CLI 命令：
```
dotnet tool install --global dotnet-ef
```
前面的命令将添加适用于 .NET Core CLI 的 Entity Framework Core 工具。

创建的文件

Visual Studio
在搭建基架时，会创建并更新以下文件：
- Pages/Movies：“创建”、“删除”、“详细信息”、“编辑”和“索引”。
- Data/RazorPagesMovieContext.cs
已更新
- Startup.cs
创建和更新的文件将在下一节中说明。
Visual Studio for Mac
在搭建基架时，会创建并更新以下文件：
- Pages/Movies：“创建”、“删除”、“详细信息”、“编辑”和“索引”。
- Data/RazorPagesMovieContext.cs
已更新
- Startup.cs
创建和更新的文件将在下一节中说明。
Visual Studio Code
在搭建基架时，会创建以下文件：
- Pages/Movies：“创建”、“删除”、“详细信息”、“编辑”和“索引”。
创建的文件将在下一节中说明。

初始迁移

Visual Studio
在此部分中，程序包管理器控制台 (PMC) 用于：
- 添加初始迁移。
- 使用初始迁移来更新数据库。
从“工具”菜单中，选择“NuGet 包管理器”>“包管理器控制台” 。

在 PMC 中，输入以下命令：
```
Add-Migration InitialCreate
Update-Database
```

Visual Studio Code

运行以下 .NET Core CLI 命令：

dotnet ef migrations add InitialCreate
dotnet ef database update

Visual Studio for Mac

运行以下 .NET Core CLI 命令：

dotnet ef migrations add InitialCreate
dotnet ef database update

前面的命令生成以下警告：“No type was specified for the decimal column 'Price' on entity type 'Movie'. This will cause values to be silently truncated if they do not fit in the default precision and scale. Explicitly specify the SQL server column type that can accommodate all the values using 'HasColumnType()'.”

你可以忽略该警告，它将后面的教程中得到修复。

migrations 命令生成用于创建初始数据库架构的代码。该架构基于在 DbContext 中指定的模型。 InitialCreate 参数用于为迁移命名。可以使用任何名称，但是按照惯例，会选择可说明迁移的名称。

update 命令在尚未应用的迁移中运行 Up 方法。在这种情况下，update 在用于创建数据库的 Migrations/<time-stamp>_InitialCreate.cs 文件中运行 Up 方法。

Visual Studio
检查通过依赖关系注入注册的上下文

ASP.NET Core 通过依赖关系注入进行生成。服务（例如 EF Core 数据库上下文）在应用程序启动期间通过依赖关系注入进行注册。需要这些服务（如 Razor 页面）的组件通过构造函数提供相应服务。本教程的后续部分介绍了用于获取 DB 上下文实例的构造函数代码。

基架工具自动创建 DB 上下文并将其注册到依赖关系注入容器。

检查 Startup.ConfigureServices 方法。基架添加了突出显示的行：
```
public void ConfigureServices(IServiceCollection services)
{
    services.AddRazorPages();

    services.AddDbContext<RazorPagesMovieContext>(options =>
      options.UseSqlServer(Configuration.GetConnectionString("RazorPagesMovieContext")));
}
```
RazorPagesMovieContext 为 Movie 模型协调 EF Core 功能（创建、读取、更新、删除等）。数据上下文 (RazorPagesMovieContext) 派生自 Microsoft.EntityFrameworkCore.DbContext。数据上下文指定数据模型中包含哪些实体。
```
using Microsoft.EntityFrameworkCore;

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

        public DbSet<RazorPagesMovie.Models.Movie> Movie { get; set; }
    }
}
```
前面的代码为实体集创建 DbSet<Movie> 属性。在实体框架术语中，实体集通常与数据表相对应。实体对应表中的行。

通过调用 DbContextOptions 对象中的一个方法将连接字符串名称传递到上下文。进行本地开发时， ASP.NET Core 配置系统在 appsettings.json 文件中读取数据库连接字符串。
Visual Studio Code

检查 Up 方法。
Visual Studio for Mac

检查 Up 方法。

测试应用

运行应用并将 /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'.

缺少迁移步骤。

测试“创建” 链接。

备注

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