介绍 Entity Framework Core 6.0 编译模型

07/21/2021 23:06:36 | China Standard Time

最近发布的 Entity Framework Core 6.0 Preview 5 带来了全新的编译模型，如果你比较关注应用程序启动时的性能，或者你的模型中包含数量巨大的属性和关系，编译模型可以给你带来巨大的性能提升，这篇文章将会简单介绍一下 EF Core 6.0 编译模型。

## 使用编译模型需要注意什么？

- 编译模型大大减少了应用程序的启动时间。
- 模型是生成的（类似于迁移的方式），因此在模型更改时应该刷新它们。
- 有些功能目前不受已编译模型的支持，因此在试用时请注意其局限性。

## 巨大的性能提升

在一个带有 DbContext 的示例项目（其中包含 449 个实体类型、6390 个属性和 720 个关系）循环创建了几次 DbContext 的新实例，并加载了一组没有过滤器或顺序的实体。测试中，第一次运行的启动时间大约为 2 秒，随后的缓存实例大约为 1.5 秒，以下是运行的输出：

```pwsh
$ dotnet run -c Release
Model has:
  449 entity types
  6390 properties
  720 relationships
Instantiating context...
It took 00:00:02.1603163.
Instantiating context...
It took 00:00:01.6268628.
Instantiating context...
It took 00:00:01.7144346.
Instantiating context...
It took 00:00:01.6090380.
Instantiating context...
It took 00:00:01.7049987.
```

接下来使用 EF Core 命令行工具创建编译模型：

```pwsh
dotnet ef dbcontext optimize -output-dir MyCompiledModels --namespace MyCompiledModels
```

工具会指示在 DbContext 配置中添加一行代码：

```pwsh
options.UseModel(MyCompiledModels.BlogsContextModel.Instance);
```

编译并重新运行代码，你会发现，初始模型只需要 257 毫秒就能完成。缓存模型将只需要 10 毫秒：

```pwsh
$ dotnet run -c Release
Model has:
  449 entity types
  6390 properties
  720 relationships
Instantiating context...
It took 00:00:00.2573627.
Instantiating context...
It took 00:00:00.0132345.
Instantiating context...
It took 00:00:00.0119556.
Instantiating context...
It took 00:00:00.0101717.
Instantiating context...
It took 00:00:00.0139057.
```

使用编译模型你可以获得十倍左右的性能提升。

## 查询管道

从您的第一次查询开始，EF Core 执行相当多的工作，我们分解一下来看看 EF Core 到底做了什么。

```csharp
using var myContext = new MyContext();
var results = myContext.MyWidgets.ToList();
```

## DbContext实例化

第一步是创建数据库上下文的实例。第一次创建 DbContext 时，EF Core 将创建并编译委托，来设置你通过 DbSet&lt;Entity&gt; 公开的表属性。

> 提示：你可以使用 context.Set&lt;Entity&gt;() API，来避免 DbSet 初始化的开销。

## DbContext (懒) 初始化

创建 DbContext 之后，EF Core 将进入睡眠状态，直到您使用它为止。当您第一次访问数据库上下文的 API 时（例如导航到实体并返回结果），该上下文将被初始化。这将运行 OnConfiguring 方法来创建数据库连接。

## 服务供应商

EF Core 使用基于服务的体系结构，并且内置了一个依赖注入框架，这个供应商是在内部构建的，但被设计用于和外部的依赖注入解决方案协作（例如 ASP.NET Core 中的 Service Provider）。

> 提示：到目前为止所描述的大部分开销都可以通过使用上下文池来减轻。这将允许重用已经初始化的数据库上下文。

## 模型构建

为了理解域对象（C#类）如何与数据库中的表和关系相关联，EF Core 构建了一个内部模型，该模型表示它在 DbContext 中找到的所有类型、属性、约束和关系。这是一个元数据模型，包括了对 OnModelCreating 的调用，你可以使用 Fluent API 复写该方法来配置模型。

## 查询编译

开发人员使用 EF Core 的一个主要原因是它能够将集成查询语言（LINQ）解析为 SQL 。这是一个高级阶段，因为它涉及遍历一个潜在的复杂表达式树并将其转换为 SQL 。一些琐碎的东西，如投影：

```csharp
var projection = myQuery.Select(obj => new { id = obj.EntityId, name = obj.Identifier });
```

似乎很容易翻译：

```sql
SELECT EntityId, Identifier FROM ...
```

但是像这样更复杂的事情呢？

```csharp
var pairs = (from a1 in context.Attendees
	from a2 in context.Attendees
	where a1.Id != a2.Id
	select new
	{
		a1 = a1.Id,
		a1LastName = a1.LastName,
		a1FirstName = a2.FirstName,
		a2 = a2.Id,
		a2LastName = a2.LastName,
		a2FirstName = a2.FirstName,
		sessionCount = 
		a1.Sessions.Select(s => s.Id)
		.Intersect(a2.Sessions.Select(s => s.Id)).Count()
	}).OrderByDescending(shared => shared.sessionCount)
	.Take(5);
```

这最终被解析为原生 SQL。EF Core第一次遇到查询时，会解析查询以确定哪些部分是动态的。然后，编译查询的静态部分并参数化动态部分，以便通过使用 SQL 模板加速 SQL 的转换。

## 运行查询

最后，运行查询，为了避免每次执行这些步骤的开销，EF Core 将缓存 DbSet 属性、内部服务提供者、构造的模型和编译的查询的委托。这样，在第一次运行查询成功后，之后的性能会变得更好。

您可以使用下面的图表来可视化这些步骤（注意缓存框中的删除线表示它在基准测试中被禁用）：

![](https://corehome.oss-accelerate.aliyuncs.com/blogs/8cefc200-fa5a-4539-b778-e908ceec13a9.jpg)

尽管大多数管道已经简化，但我们知道模型编译是一个可以改进的领域。

> 关于源生成器的说明。团队选择的方法是提供一个生成源代码文件的命令，然后将其合并到项目中以构建编译模型。我们经常被问到为什么不选择源生成器。答案是源代码生成器在 VisualStudio 进程中作为用户代码运行。EF Core 必须构建和运行上下文以获取有关模型的信息。如果异常作为进程的一部分抛出，可能会导致 VisualStudio 挂起或崩溃。

与大多数技术一样，编译后的模型也有取舍。让我们看看利弊。

## 利弊

优点应该很清楚。随着您的模型越来越大，您的启动时间仍然很快。下面是基于模型大小的编译模型和非编译模型的启动时间比较。

![](https://corehome.oss-accelerate.aliyuncs.com/blogs/f231485e-385a-4594-9e75-bdc840207661.jpg)

以下是一些需要考虑的缺点：

- 不支持全局查询过滤器。
- 不支持延迟加载代理。
- 不支持更改跟踪代理。
- 不支持自定义IModelCacheKeyFactory实现。
- 模型定义或配置更改时，必须通过重新生成来手动同步模型。

## 总结

如果要现在开始使用编译模型，请获取最新的预览本，并安装最新的 EF Core CLI。

```pwsh
dotnet ef dbcontext optimize -c MyContext -o MyFolder -n My.Namespace
```

在 NuGet 包管理器控制台中，您可以使用以下命令：

```pwsh
Optimize-DbContext -Context MyContext -OutputDir MyFolder -Namespace My.Namespace
```

工具会指示在 DbContext 配置中添加一行代码：

```csharp
opts.UseModel(My.Namespace.MyContextModel.Instance);
```

## 如何获取 EF Core 6.0 preview

EF Core 作为一组 NuGet 包进行分发。例如，要将 SQL Server 提供程序添加到项目中，可以使用以下命令：

```pwsh
dotnet add package Microsoft.EntityFrameworkCore.SqlServer --version 6.0.0-preview.5.21301.9
```

02/14/2022 07:51:24

TOP