ASP.NET Core - Entity Framework Core 连接现有数据库

本文适用于 EF Core，并非 EF 6.x 及以下。

在本演练中，您将构建一个使用 Entity Framework 执行基本数据访问的 ASP.NET Core MVC 应用程序。您将使用逆向工程基于现有数据库创建实体框架模型。

创建一个新项目

• 打开 Visual Studio 2017

• 文件 -> 新建 -> 项目...

• 从左侧菜单中选择 已安装 -> 模板 -> Visual C＃ -> Web

• 选择 ASP.NET Core Web应用程序（.NET Core）项目模板

• 输入项目名称，然后单击确定

• 在 ASP.NET Core 1.1 选择 Web 应用程序

• 确保“身份验证”设置为“不进行身份验证”

• 点击确定

安装 Entity Framework

要使用 EF Core，请安装目标数据库提供程序的软件包。本演练使用 SQL Server。有关可用提供程序的列表，请参阅 Database Providers（从打开页面的左侧菜单选择相应的数据库）。

• 工具 -> NuGet 包管理器 -> 管理解决方案的 NuGet 程序包

• 在“浏览”选项卡中搜索并安装 Microsoft.EntityFrameworkCore.SqlServer

我们将使用一些 Entity Framework 命令从数据库创建模型。所以我们也将安装工具包。

• 安装 Microsoft.EntityFrameworkCore.SqlServer.Design

• 安装 Microsoft.EntityFrameworkCore.Tools

模型的反向工程

现在是根据现有数据库创建 EF 模型的时候了。

• 工具 -> NuGet 包管理器 -> 程序包管理器控制台

• 运行 Scaffold-DbContext "数据库连接字符串" Microsoft.EntityFrameworkCore.SqlServer -OutputDir Models

数据库连接字符串可以从 服务器资源管理器 -> 数据连接，在要连接的数据库上右击属性来获得。

如果您收到以下错误说明，请关闭并重新打开 Visual Studio 后重试。

The term 'Scaffold-DbContext' is not recognized as the name of a cmdlet

逆向工程过程基于现有数据库的模式创建实体类（表名.cs）和派生上下文（库名Context.cs）。

实体类是简单的 C# 对象，表示要查询和保存的数据。

上下文表示与数据库的会话，并允许您查询和保存实体类的实例。

使用依赖注入注册上下文

依赖注入的概念是ASP.NET Core的核心。服务（例如数据库 Context）在应用程序启动期间使用依赖注入进行注册。然后，需要这些服务的组件（例如您的 MVC 控制器）通过构造函数参数或属性提供这些服务。

删除内联上下文配置

• 打开 Models\库名Context.cs

• 删除方法 OnConfiguring(...)

• 添加以下构造函数，这将允许通过依赖注入将配置传递到上下文中

public 库名Context(DbContextOptions<库名Context> options)
    : base(options)
{ }

在 Startup.cs 中注册和配置上下文

为了使我们的 MVC 控制器使用数据库Context，我们将它注册为一个服务。

• 打开 Startup.cs

• 使用 using 语句在文件的开头添加以下内容

using 项目命名空间.Models;
using Microsoft.EntityFrameworkCore;

现在我们可以使用 AddDbContext（...）方法将其注册为服务。

• 找到 ConfigureServices（...）方法

• 添加以下代码以将上下文注册为服务

// This method gets called by the runtime. Use this method to add services to the container.
public void ConfigureServices(IServiceCollection services)
{
    // Add framework services.
    services.AddMvc();

    var connection = @"连接字符串";
    services.AddDbContext<库名Context>(options => options.UseSqlServer(connection));
}

在实际应用程序中，通常将连接字符串放在配置文件中。为了简单起见，我们在代码中定义它。查看如何将连接字符串配置到 appsettings.json 文件中

创建一个控制器

接下来，我们将在我们的项目中启用基架。

• 右键单击解决方案资源管理器中的 Controllers 文件夹，然后选择添加 -> 控制器...

• 选择 Full Dependencies（完全依赖），然后单击添加

• 您可以忽略打开的 ScaffoldingReadMe.txt 文件中的指令

现在基架已启用，我们可以为数据表实体构建控制器。

• 右键单击解决方案资源管理器中的 Controllers 文件夹，然后选择添加 -> 控制器...

• 选择“视图使用 Entity Framework 的 MVC 控制器”并单击“添加”

• 设置模型类和数据上下文类

• 单击添加

运行应用程序

您现在可以运行应用程序以查看它的操作。

• 调试 -> 开始执行(不调试)

• 应用程序将在 Web 浏览器中构建和打开

• 导航到相应的路径 /控制器名

• 单击 Create New

• 填写表单并单击 Create

EF Core for MySQL

• 截至 Visual Studio 2017 正式版发布（2017年3月7日），MySQL for Visual Studio（支持）尚不支持 Visual Studio 2017，因此 Visual Studio 2017 的服务器资源管理器不能连接数据源为 MySQL 的数据库，也无法创建和更新可视化模型（.edmx）

• NuGet 包 MySql.Data.EntityFrameworkCore 还没有找到 Database First 的 PM 命令，因此不能由 MySQL 数据库生成实体类和上下文

• 综上，要连接 MySQL 只能用 VS2015，要生成 MySQL 实体类和上下文就不能用 EF Core，暂时使用 EF 6.x 代替（创建 ASP.NET MVC 项目）

EF Core 1.1 未实现

• EF Core 1.1 未实现：可视化模型，以查看基于代码的模型的图形表示。

• EF Core 1.1 未实现：用于逆向工程的 Visual Studio 向导，允许您在从现有数据库创建模型时可视化地配置连接，选择表等。

• EF Core 1.1 未实现：从数据库更新模型，允许从数据库以前反向工程的模型使用对模式所做的更改进行刷新。

补充

如果我们在创建新项目时选择 ASP.NET Core Web应用程序（.NET Framework）项目模板，那么完全按照 Core 的方式来开始（比如选择 NuGet 包的版本），而发布必须是 .NET Framework 环境，而非跨平台。

参考

ASP.NET Core - Existing Database

Compare EF Core & EF6.x