自定义对象(实体框架)
ADO.NET 实体框架 提供了相应的工具,以便根据 实体数据模型 (EDM) 的概念性架构定义语言 (CSDL) 文件自动生成对象层。可以对这些数据类进行不同程度的自定义,具体取决于应用程序的要求。您也可以修改自己的自定义数据类,以将其用于 EDM。当您从现有应用程序升级数据类以使用 实体框架 时,或者当您希望对创建数据类的方式进行更多控制时,这很有用。
扩展分部数据类
EDM 中定义的类型不像面向对象编程中使用的类那样具有关联的方法。相反,它们只包含 EDM 中定义的属性。您可以通过扩展已生成的分部数据类向对象中添加功能。在通过 实体数据模型 工具生成数据类时,将以分部类的形式实现这些数据类。分部类将类的定义拆分到两个或更多个源文件中。每个源文件包含类定义的一部分,当编译应用程序时,将组合所有部分。有关更多信息,请参见分部 (Visual Basic) 或分部(类型)(C# 参考)。
拥有分部类后,您能够用单独源文件中的自定义方法和属性扩展这些类,而无需担心在已生成的文件刷新时丢失您的自定义。有关更多信息,请参见如何:自定义生成的数据对象(实体框架)。
自定义业务逻辑
在使用生成的数据类时,可以在某些对象服务操作(例如,更改属性或关系)过程中调用自定义业务逻辑。此业务逻辑可能包括在更改属性或调用 SaveChanges 时创建附加验证或登录。通过处理由对象服务引发的事件,或者通过定义在更改属性时调用的自定义分部方法,可以调用自定义业务逻辑。
下面列出了用于调用自定义业务逻辑的事件和方法:
- On属性Changing 和 On属性Changed 分部方法
生成的数据类上的一对分部方法,由对象服务在更改属性时调用。在分部数据类中扩展这些方法,可实现属性更改时执行的代码。有关更多信息,请参见如何:在属性更改过程中执行业务逻辑(实体框架)。
- SavingChanges 事件
一个事件,在对象上下文中缓存的更改即将保存到数据源时引发。处理此事件可在 SaveChanges 操作启动时实现自定义业务逻辑。有关更多信息,请参见如何:在保存更改时执行业务逻辑(实体框架)。
- OnContextCreated 方法
Entity Data Model 工具在表示该模型的 EntityContainer 并从 ObjectContext 类继承的类中生成一个 OnContextCreated 分部方法。每当实例化 ObjectContext 时,就会调用此分部方法。在代码中实现此分部方法可以为 SavingChanges 事件注册一个处理程序。有关更多信息,请参见如何:在保存更改时执行业务逻辑(实体框架)。
- AssociationChanged 事件
一个事件,在两个对象之间的关系更改时引发。处理此事件可在关系更改时实现自定义业务逻辑。有关更多信息,请参见如何:更改对象间的关系(实体框架)。
自定义数据类
有某些情况下,只通过添加方法和属性来扩展分部类可能无法提供足够的灵活性。假定现有一个 .NET Framework 应用程序使用 ADO.NET 将数据库中的数据加载到 CLR 对象中,以供该应用程序使用。这些对象可能包含必须保留在对象层中的有价值的自定义和业务逻辑。这些自定义可能会妨碍您将应用程序迁移为使用 实体框架。您可能还希望对实体类型进行更多的控制,而不仅仅是扩展生成的分部类。
将自定义数据类与 EDM 一起使用的建议方式是从 EntityObject 继承。Entity Framework 提供了一组接口,如果不能从 EntityObject 继承,或需要比框架更多的独立性时,可以实现这些接口以将自定义数据类用于 EDM。有关更多信息,请参见实现自定义数据类接口(实体框架)。在使用自定义数据类时,必须向自定义数据类和属性应用属性,并且在更改属性时通知对象上下文。
从 EntityObject 继承
生成的数据类从 EntityObject 或 ComplexObject 继承。如果您必须将自定义数据类与 EDM 一起使用,建议的方式是修改您的数据类,以便从这两个基类继承。通过这种方式,自定义数据类将受益于 EntityObject 所提供的更改跟踪和关系管理功能。
在从 EntityObject 和 ComplexObject 继承时,请记住以下要点:
类和属性名称必须与 EDM 的概念性架构定义语言 (CSDL) 文件中定义的实体类型和属性名称相匹配。如果这些名称不匹配,您必须更改数据类和属性的名称,或者更新 CSDL 和关联的映射规范文件 (MSL) 中的名称。有关更多信息,请参见如何:自定义实体数据模型以使用自定义对象(实体框架)。
CSDL 中定义的实体类型的每个属性,都必须在自定义数据类中有一个关联的属性。自定义数据类可以具有其他未映射到 CSDL 中定义的属性的属性。
您必须向自定义数据类和属性应用属性。这些属性在对象和 CSDL 之间提供显式映射。有关更多信息,请参见对象-实体映射属性(实体框架) 和如何:将自定义对象映射到实体(实体框架)。
若要使对象服务能够跟踪对自定义对象进行的更改,必须使用 EntityObject 更改报告方法按照特定模式报告这些更改。有关更多信息,请参见报告自定义数据类中的更改(实体框架)。
Entity Framework 工具还生成其他能够简化对象编程的类。对自定义数据类使用此代码很有用。有关更多信息,请参见如何:将对象服务用于自定义对象(实体框架)。
在从 EntityObject 继承时,必须通过从 ComplexObject 继承来实现复杂类型。有关更多信息,请参见复杂类型对象(实体框架)。
下面的示例定义了自定义数据类 Order,该类从 EntityObject 继承:
<EdmEntityTypeAttribute(NamespaceName:="Microsoft.Samples.Edm", Name:="Order")> _
Public Class Order
Inherits EntityObject
[EdmEntityTypeAttribute(NamespaceName="Microsoft.Samples.Edm",Name="Order")]
public class Order : EntityObject
有关更多信息,请参见如何:从 EntityObject 和 ComplexObject 基类继承(实体框架)。