Entity Framework

Entity Framework (又称ADO.NET Entity Framework) 是微软以 ADO.NET 为基础所发展出来的物件关联对应 (O/R Mapping) 解决方案，早期被称为 ObjectSpace，包含在 .NET Framework中发表。从版本6开始独立发布。

## 背景

长久以来，程序员和数据库总是保持着一种微妙的关系，在商用应用程序中，数据库一定是不可或缺的元件，这让程序员一定要为了连接与存取数据库而去学习 SQL 指令，因此在资讯业中有很多人都在研究如何将程式设计模型和数据库整合在一起，物件关联对应 (Object-Relational Mapping) 的技术就是由此而生，像Hibernate或NHibernate都是这个技术下的产物，而微软虽然有了ADO.NET这个资料存取的利器，但却没有像NHibernate这样的物件对应工具，因此微软在.NET Framework 2.0发展时期，就提出了一个ObjectSpace的概念，ObjectSpace可以让应用程序可以用完全物件化的方法连接与存取数据库，其技术概念与NHibernate相当类似，然而ObjectSpace工程相当大，在.NET Framework 2.0完成时仍无法全部完成，因此微软将ObjectSpace纳入下一版本的.NET Framework中，并且再加上一个设计的工具（Designer），构成了现在的 ADO.NET Entity Framework。

Entity Framework是ADO.NET之上支持面向数据应用程序开发，使得开发者工作于领域相关的对象和属性的数据级，如客户、客户地址等，不必关注存储数据的底层表、列。这种在更高层次上创建、维护面向数据的应用程序可以大大节约编码量。

Entity Framework 利用了抽象化资料结构的方式，将每个数据库物件都转换成应用程序物件 (entity)，而资料字段都转换为属性 (property)，关联则转换为结合属性 (association)，让数据库的 E/R 模型完全的转成物件模型，如此让程序员能用最熟悉的程式语言来呼叫存取。而在抽象化的结构之下，则是高度整合与对应结构的概念层、对应层和储存层，以及支援 Entity Framework 的资料提供者 (provider)，让资料存取的工作得以顺利与完整的进行。

- 概念层：负责向上的物件与属性显露与存取。
- 对应层：将上方的概念层和底下的储存层的资料结构对应在一起。
- 储存层：依不同数据库与资料结构，而显露出实体的资料结构体，和 Provider 一起，负责实际对数据库的存取和 SQL 的产生。

## 历史

2008年8月11日，Entity Framework的第一版(EFv1)随.NET Framework 3.5 Service Pack 1和Visual Studio 2008 Service Pack 1发布。该版受到了广泛的批评。

2010年4月12日，Entity Framework第2版，称为Entity Framework 4.0 (EFv4)发布，解决了第一版的很多问题。该版本完全包含在.NET Framework中。

2011年4月12日发布了Entity Framework第3个版本，称为version 4.1，开始支持Code First。2011年7月25日发布了Entity Framework 4.1 Update 1。

2012年2月29日发布了version 4.3.1。

2012年8月11日发布了Version 5.0.0。与.NET framework 4.5配套。

2013年10月17日发布了Version 6.0。并成为开源软件，使用Apache License v2. 类似于ASP.NET MVC，开源发布于GitHub。This version has a number of improvements for code-first support.Entity Framework 6.0、6.1、6.2、6.3 和 6.4 完全作为NuGet包提供。

2014年5月19日，微软决定为了让其.NET能跨平台，下一版Entity Framework将完全重写。2016年6月27日，发布了Entity Framework Core 1.0, 伴随着ASP.NET Core 1.0 和 .NET Core 1.0.本来其命名为Entity Framework 7，但为了突出其是完全重写而不是替换EF6所以重新命名。

## 架构

<image>

ADO.NET Entity Framework架构，从底向上包括：

- Data source specific providers, ADO.NET抽象接口连接到数据库。
- Map provider, 特定数据库的provider，翻译Entity SQL命令树到数据库本地SQL方言查询。包括Store-specific bridge，负责把一般命令树翻译为存储特定的命令树。
- EDM parser and view mapping, 把数据模型的特定的SDL规范和如何映射到关系模型。从关系模式角度，它创建了对应于概念模型的数据views。它聚合（aggregate）多张表的信息成为一个实体（entity），把一个到实体的修改（update）分割为到多个表的修改。
- Query and update pipeline, 处理查询、过滤器、修改等请求，转化为经典命令树。
- Metadata services, 处理实体、关系、映射的所有元数据。
- Transactions, 集成基础存储的事务能力。如果基础存储不支持事务，则在这个层次上实现事务。
- Conceptual layer API, 提供了概念模式下的编程接口。遵从ADO.NET模式，使用Connection对象引用map provider, 使用Command对象发送查询，返回EntityResultSets 或 EntitySets 以包含结果。
- Disconnected components, ADO.NET Entity Framework使用的本地缓存数据集和实体集，在偶尔连接环境。
- Embedded database: ADO.NET Entity Framework包含一个轻量嵌入数据库用于客户端缓存和查询关系数据库。
- Design tools, 如Mapping Designer, ADO.NET Entity Framework包含的用于简化映射从概念模式到关系模式，指出实体类型的哪些属性映射到数据库的哪个表。
- Programming layer, 暴露EDM作为编程结构，可被编程语言使用
- Object services, 自动产生CLR类代码，把同一属性作为一个实体，允许实体实例作为.NET 对象.
- Web services, 暴露web服务的实体
- High-level services, 如工作在实体上的报告服务。

### 概念层结构

概念层结构定义了物件模型 (Object Model)，让上层的应用程序码可以如物件导向的方式般存取资料，概念层结构是由 CSDL (Conceptual Schema Definition Language) 所撰写。

一份概念层结构定义如下所示：

```xml
<?xml version="1.0" encoding="utf-8"?>
<Schema Namespace="Employees" Alias="Self" xmlns="http://schemas.microsoft.com/ado/2006/04/edm">
  <EntityContainer Name="EmployeesContext">
    <EntitySet Name="Employees" EntityType="Employees.Employees" />
  </EntityContainer>
  <EntityType Name="Employees">
    <Key>
      <PropertyRef Name="EmployeeId" />
    </Key>
    <Property Name="EmployeeId" Type="Guid" Nullable="false" />
    <Property Name="LastName" Type="String" Nullable="false" />
    <Property Name="FirstName" Type="String" Nullable="false" />
    <Property Name="Email" Type="String" Nullable="false" />
  </EntityType>
</Schema>
```

### 对应层结构

对应层结构负责将上层的概念层结构以及下层的储存体结构中的成员结合在一起，以确认资料的来源与流向。对应层结构是由 MSL (Mapping Specification Language) 所撰写。

一份对应层结构定义如下所示：

```xml
<?xml version="1.0" encoding="utf-8"?>
<Mapping Space="C-S" xmlns="urn:schemas-microsoft-com:windows:storage:mapping:CS">

  <EntityContainerMapping StorageEntityContainer="dbo" CdmEntityContainer="EmployeesContext">
    <EntitySetMapping Name="Employees" StoreEntitySet="Employees" TypeName="Employees.Employees">

      <ScalarProperty Name="EmployeeId" ColumnName="EmployeeId" />
      <ScalarProperty Name="LastName" ColumnName="LastName" />
      <ScalarProperty Name="FirstName" ColumnName="FirstName" />
      <ScalarProperty Name="Email" ColumnName="Email" />

    </EntitySetMapping>
  </EntityContainerMapping>
</Mapping>
```

### 储存层结构

储存层结构是负责与数据库管理系统（DBMS）中的资料表做实体对应 (Physical Mapping)，让资料可以输入正确的资料来源中，或者由正确的资料来源取出。它是由 SSDL (Storage Schema Definition Language) 所撰写。

一份储存层结构定义如下所示：

```xml
<?xml version="1.0" encoding="utf-8"?>
<Schema Namespace="Employees.Store" Alias="Self"
    Provider="System.Data.SqlClient"
    ProviderManifestToken="2005"
    xmlns="http://schemas.microsoft.com/ado/2006/04/edm/ssdl">
  <EntityContainer Name="dbo">
    <EntitySet Name="Employees" EntityType="Employees.Store.Employees" />
  </EntityContainer>
  <EntityType Name="Employees">
    <Key>
      <PropertyRef Name="EmployeeId" />
    </Key>
    <Property Name="EmployeeId" Type="uniqueidentifier" Nullable="false" />
    <Property Name="LastName" Type="nvarchar" Nullable="false" MaxLength="50" />
    <Property Name="FirstName" Type="nvarchar" Nullable="false" />
    <Property Name="Email" Type="nvarchar" Nullable="false" />
  </EntityType>
</Schema>
```

## Entity Data Model

Entity Data Model (EDM) 给出数据的概念模型(CSDL)，这所使用的建模技术被称为Entity Data Model, 是实体-关系模型的扩展版。数据模型主要描述了实体和其涉及的关联（Association）。EDM模式用Schema Definition Language (SDL)表述，这事XML的一种应用。此外，从概念模式(CSDL)到存储模式(SSDL)的映射(MSL)也必须用XML表示。

Visual Studio提供了Entity Designer 可视化创建EDM和映射规范。该工具输出XML文件(*.edmx)来描述这种模式和映射。Edmx文件包含EF元数据(CSDL/MSL/SSDL内容)。也可手工编辑这3个文件(csdl, msl, ssdl)。

### Mapping

Visual Studio的Entity Data Model Wizard在大部分情况下最初产生数据库模式和概念模式的1对1映射。关系模式下，表和主键、外键组成元素。“实体类型”定义了概念模式下的数据。

实体类型是多个类型字段的聚合，每个字段映射到数据库的特定列，可以包含来自多个物理表的信息。实体类型可以彼此有关系，且独立于物理模式内的关系。相关的实体可以通过字段的名字表示这种关系，以代替从数据库的列获取值，通过这种字段可以遍历相关的实体，返回一个实体或实体集合。

实体类型形成了对象的类，实体是整个类型的实例。实体是应用程序的单个对象，用一个键索引。

ADO.NET Entity Framework使用Entity Data Model (EDM)表示这种映射。

ADO.NET Entity Framework使用eSQL，SQL的一个派生，来执行查询、集合论操作、修改实体及其关系。

### 实体

实体是“实体类型”的实例，表示单个对象的实例（如“客户”、“订单”）。ADO.NET Entity Framework中的实体属性是完全类型化的，完全兼容于DBMS的类型系统和.NET Framework的Common Type System。属性可以是SimpleType或ComplexType或多值的。所有EntityType属于某个命名空间，并包含一个EntityKey属性。

所有实体实例在EntityContainers中。每个项目有一个或多个EntityContainers。

EDM基础类型(简单类型):

EDM 类型｜CLR 类型映射

Edm.Binary｜Byte

Edm.Boolean｜Boolean

Edm.Byte｜Byte

Edm.DateTime｜DateTime

Edm.DateTimeOffset｜DateTimeOffset

Edm.Decimal｜Decimal

Edm.Double｜Double

Edm.Guid｜Guid

Edm.Int16｜Int16

Edm.Int32｜Int32

Edm.Int64｜Int64

Edm.SByte｜SByte

Edm.Single｜Single

Edm.String｜String

Edm.Time｜TimeSpan

### 关系

任何两个实体类型可以是相关的，或者是Association关系或者Containment关系。用Relationship Type来表示。

关系类型用degree (arity)和multiplicity刻画。ADO.NET Entity Framework支持二元双向关系，multiplicity包括一对一、一对多、多对多。实体间的关系是有名的，称为Role。定义了关系的目的。

关系类型可以有Operation或Action。例如，删除一个实体，其关联的关系可以采取：

- Cascade：删除关系实例和所有相关联的实体实例。
- None.

### 模式定义语言

ADO.NET Entity Framework使用基于XML的数据定义语言称为 Schema Definition Language (SDL)定义EDM Schema。SDL定义了SimpleTypes类似于CTS基础类型，包括String, Int32, Double, Decimal, Guid, 和 DateTime等等。枚举类型定义了基础值和其名字的映射，也被认为是简单类型。ComplexTypes为其他类型的聚合。属性的集合定义了实体类型。写为巴恩斯瑙尔范式：

```ebnf
EntityType ::= 
  ENTITYTYPE entityTypeName [BASE entityTypeName]
    [ABSTRACT true|false] KEY propertyName [, propertyName]*
    {(propertyName PropertyType [PropertyFacet]*) +}

PropertyType ::= (
  (PrimitiveType [PrimitiveTypeFacets]*)
    | (complexTypeName)
    | RowType

  PropertyFacet ::= (
    [NULLABLE true | false]
    | [DEFAULT defaultVal] 
    | [MULTIPLICITY [1|*]]
  )

  PropertyTypeFacet ::= 
    MAXLENGTH | PRECISION | SCALE 
    | UNICODE | FIXEDLENGTH | COLLATION
    | DATETIMEKIND | PRESERVESECONDS

  PrimitiveType ::= 
    BINARY | STRING | BOOLEAN
    | SINGLE | DOUBLE | DECIMAL | GUID
    | BYTE | SBYTE | INT16 | INT32 | INT64
    | DATETIME | DATETIMEOFFSET | TIME
)
```

Facets用于描述属性的元数据，如是否为可空、缺省值、为单值或多值。

```XML
<ComplexType Name="Addr">
    <Property Name="Street" Type="String" Nullable="false" />
    <Property Name="City" Type="String" Nullable="false" />
    <Property Name="Country" Type="String" Nullable="false" />
    <Property Name="PostalCode" Type="Int32" />
</ComplexType>
<EntityType Name="Customer">
    <Key>
        <PropertyRef Name="Email" />
    </Key>
    <Property Name="Name" Type="String" />
    <Property Name="Email" Type="String" Nullable="false" />
    <Property Name="Address" Type="Addr" />
</EntityType>
```

关系类型，如客户和订单是1对多关系。

```XML
<Association Name="CustomerAndOrders">
    <End Type="Customer" Multiplicity="1" />
    <End Type="Orders" Multiplicity="*">
        <OnDelete Action="Cascade" />
    </End>
</Association>
```

## 查询物件

ADO.NET 实体资料模型工具会产生从 ObjectContext (代表概念模型中所定义的实体容器) 衍生而来的类别。ObjectContext 类别支援针对将实体当成物件传回之概念模型进行查询，也支援建立、更新和删除实体物件。Entity Framework 支援针对概念模型进行物件查询。这些查询可以使用 Entity SQL、Language-Integrated Query (LINQ) 和物件查询产生器方法来撰写。

### Entity SQL

Entity Client 是 ADO.NET Entity Framework 中的原生用户端 (Native Client)。它的物件模型和 ADO.NET 的其他用户端非常相似，一样有 Connection, Command, DataReader 等物件，但最大的差异就是，它有自己的 SQL 指令 (Entity SQL)，可以用 SQL 的方式存取 EDM。但没有明确的joins。简单的说，就是把 EDM 当成一个实体数据库。

查询管线分析Entity SQL查询为一棵命令树， query into a command tree, 分开多个表上的查询，再移交EntityClient provider。EntityClient provider使用Connection对象初始化。EntityClient provider再把Entity SQL命令树转化为数据库的本地SQL查询。查询返回Entity SQL ResultSet，但不限于一个表的结果。

```csharp
// Initialize the EntityConnectionStringBuilder.
EntityConnectionStringBuilder entityBuilder = new EntityConnectionStringBuilder();

// Set the provider name.
entityBuilder.Provider = providerName;

// Set the provider-specific connection string.
entityBuilder.ProviderConnectionString = providerString;

// Set the Metadata location.
entityBuilder.Metadata =  @"res://*/AdventureWorksModel.csdl|
                            res://*/AdventureWorksModel.ssdl|
                            res://*/AdventureWorksModel.msl";

Console.WriteLine(entityBuilder.ToString());                                                                                                                     

using (EntityConnection conn = new EntityConnection(entityBuilder.ToString()))
{
    conn.Open();
    Console.WriteLine("Just testing the connection.");
    conn.Close();
}
```

#### Entity SQL经典函数

Entity Framework兼容的data providers都支持的函数，可用于Entity SQL查询。LINQ to Entities的大部门扩展方法都翻译为经典函数。ADO.NET data provider会把经典函数翻译为期望的SQL语句。

类别｜经典函数

聚类函数｜Avg, BigCount, Count, Max, Min, StDev, StDevP, Sum, Var, VarP

数学函数｜Abs, Ceiling, Floor, Power, Round, Truncate

字符串函数日期时间函数

Bitwise 函数｜BitWiseAnd, BitWiseNot, BitWiseOr, BitWiseXor

其他函数｜NewGuid

### LINQ to Entities

实作 IEnumerable 泛型界面或 IQueryable 泛型界面的资料来源可以透过 LINQ 进行查询。实作泛型 IQueryable 界面之泛型 ObjectQuery 类别的执行个体会当做 LINQ to Entities 查询的资料来源。ObjectQuery 泛型类别表示传回零个或多个具型别物件之集合的查询。使用 C# 的 var 关键字 (在 Visual Basic 中为 Dim)，您也可以让编译器推断实体类型。

```csharp
using (AdventureWorksEntities AWEntities = new AdventureWorksEntities())
{
    ObjectQuery<Product> products = AWEntities.Products;

    // LINQ Query syntax:
    IOrderedQueryable<Product> query =
        from product in products
        orderby product.Name, product.ListPrice descending
        select product;

    // LINQ Method syntax:
    IOrderedQueryable<Product> query = products
        .OrderBy(product => product.Name)
        .ThenByDescending(product => product.ListPrice);
}
```

### 查询产生器方法

ObjectQuery 类别支援对概念模型进行 LINQ to Entities 和 Entity SQL 查询。ObjectQuery 也会实作一组查询产生器方法，这些方法可用来循序建构与 Entity SQL 相等的查询命令。由于 ObjectQuery 会实作 IQueryable 和 IEnumerable，所以将 ObjectQuery 所实作的查询产生器方法结合 LINQ 特定的标准查询运算子方法 (如 First 或 Count) 是可行的。LINQ 运算子并不会传回 ObjectQuery，与查询产生器方法不同。

```csharp
// Get the contacts with the specified name.
ObjectQuery<Contact> contactQuery = context.Contact
    .Where("it.LastName = @ln AND it.FirstName = @fn",
    new ObjectParameter("ln", lastName), 
    new ObjectParameter("fn", firstName));
```

## 开发工具

目前 ADO.NET Entity Framework 的开发，在 Visual Studio 2008 中有充分的支援，在安装 Visual Studio 2008 Service Pack 1 后，档案范本中即会出现 ADO.NET 实体资料模型 (ADO.NET Entity Data Model) 可让开发人员利用 Entity Model Designer 来设计 EDM，EDM 亦可由Windows记事本等文字编辑器所编辑。

## 衍生服务

微软特别针对了网络上各种不同的应用程序（例如 AJAX，Silverlight，Mashup 应用程序）开发了一个基于 ADO.NET Entity Framework 之上的服务，称为 ADO.NET Data Services（专案代号为 Astoria），并与 ADO.NET Entity Framework 一起包装在 .NET Framework 3.5 Service Pack 1 中发表。

## 支援厂商

目前已有数个数据库厂商或元件开发商宣布要支援 ADO.NET Entity Framework:

- Mircosoft，支持MsSQL.
- Core Lab，支援Oracle、MySQL、PostgreSQL 与 SQLite 数据库。
- IBM，实作 DB2 使用的 LINQ Provider。
- MySQL，发展 MySQL Server 所用的 Provider。
- Npqsql，发展 PostgreSQL 所用的 Provider。
- OpenLink Software，发展支援多种数据库所用的 Provider。
- Phoenix Software International，发展支援 SQLite 数据库的 Provider。
- Sybase，将支援 Anywhere 数据库。
- VistaDB Software，将支援 VistaDB 数据库。
- DataDirect Technologies，发展支援多种数据库所用的 Provider。
- Firebird，支援 Firebird 数据库。

## 外部链接

- MSDN Library : ADO.NET Entity Framework
- 读写 ADO.NET Entity Framework
- 整合 ADO.NET Entity Framework 到应用程序中
- 首次接触 ADO.NET Entity Framework
- ADO.NET Entity Framework 概观
- Recent ADO.NET Entity Framework provider news - Demos and downloads

## 基本资料

- 作者：Microsoft
- 开发者：.NET Foundation
- 发行日期：2008年8月11日
- 源代码库：https://github.com/dotnet/ef6、https://github.com/dotnet/efcore
- 编程语言：C#
- 平台：.NET Framework、.NET Core
- 类型：对象关系映射(ORM)
- 许可协议：Apache License 2.0