《OEA - 实体扩展属性系统 - 设计方案说明书》

先说属性扩展：我们一般会对产品中定义好的类的属性进行以下扩展：添加一个属性、删除一个属性、修改一个属性。（所以，扩展并不只是意味着添加。）添加属性意味着我们需要为已经定义完成的类添加一个额外的属性，这个属性可以映射到数据库，可以在产品界面中显示，行为和直接定义的属性是一致的。删除属性则意味着，数据库中不再有对应的字段，界面不再显示。修改属性一般只会修改属性的各种元数据，例如，修改它映射数据库的字段元数据，修改它在界面中显示的列的元数据等；这些修改其实已经在元数据的设计方案中解决，相关内容可以查看：《基于OEA框架的客户化设计（一）总体设计》、《基于OEA框架的客户化设计（二）元数据设计》以及《基于OEA框架的客户化设计（三） “插件式”DLL》。

实体的扩展一般可以通过继承的方法实现，当继承出新的子类后，在元数据中用它将原来的父类进行覆盖即可。有些时候，我们还会为某个类扩展一些聚合父子关系，例如：我们可以为某一个建设项目扩展出其相关的合同列表，这样，原来只显示项目的界面中，就能紧接着显示每一个项目相应的合同列表。而这种聚合父子关系的扩展，虽然是实体级别的添加，但是实质上是对实体添加新的一对多关系。也就是说，这种实体的扩展，可以转换为属性扩展，即在原有实体的基础上扩展一个一对多关系的属性。

基于以上分析，我们知道，一个可扩展的属性系统，几乎是客户化软件产品运行时的最基础设施。

在 2.6 版本之前的 OEA，属性扩展主要使用继承的方式来实现。简单地说，就是继承需要扩展的实体，添加新的属性，然后使用这个实体替换掉原来的类。该方案主要是为了实现属性的添加，但是属性的删除以及修改都是通过修改属性的元描述来实现的。这样的方式导致了许多问题：属性的删除只是删除了界面，而数据库、运行时实体也都还存在该属性；属性的修改不能修改属性中的行为代码；重点说下属性的添加造成的缺点：

经常需要对某个类扩展一两个属性，而现在只能继承出子类，同时把父类隐藏起来，或者直接覆盖父类，用进来比较复杂; 同时，类型变多，开发人员的学习成本，维护成本都随之变大。

更重要的是，.NET 中 CLR 单继承体系的限制，使得通过继承无法实现这样的扩展: 两个独立的扩展包“2”以可选的形式对主包“7”进行扩展，也就是说，产品 721 客户化开发中，两个“2”的扩展包是两个单独的程序集，但是单继承的限制，我们不能同时使用它们。对于这种情况，我们目前的处理方式是把两个“2”的包都放到了主包中，而使用元数据的方式对不需要的功能来进行隐藏，这种实现方式是临时的、错误的。

1.2 实体动态列

软件开发中常常遇到动态列的需求：表格中的数据的列是根据数据本身自动生成的，这对于基于领域实体类型、基于非动态类型的技术框架来开发的系统来说，要实现动态列基本上不可能。所以往往应用程序会另辟捷径，使用 DataTable 来重新组装数据后再显示。这导致两种模式同时存在于一个系统中，同样的代码会重复出现，增加维护成本。界面的代码不一致，也加大了界面自动生成的困难。

如果有了扩展属性，我们则可以在任意实体上扩展各种新的属性，界面也就相应地成了“动态”列。

1.3 分离只读/视图属性

实体设计中常常会添加一些只读的属性，它的值是使用实体当前的值经过计算后得出。在 OEA 中，实体被设计为分布式对象（简单地说，就是客户端和服务端重用一套实体代码。可以参见CSLA框架设计书籍《Expert C# 2008 Business Objects》。），这些分布式对象被直接绑定到界面上。为了界面显示的需要，常常会为它们添加许多只读的视图属性，这样就导致了视图属性过多，混杂在领域实体的代码中，污染了代码，加大维护难度。

如果有了扩展属性，我们则可以把这个只读属性都放到一个单独的类中去为这个实体做扩展，这样，就可以得到更简洁、结构更清晰的代码。

1.4 提升框架性能

对于框架开发来说，常常需要在框架中对实体的属性做统一的处理，来向应用层提供强大的功能支持。如果使用一般的实体设计，那么属性值的获取、设置都不可避免地要使用到反射。而大量的属性值操作将会意味着较差的性能。如果有了托管属性，则在框架层面能够使用和应用一致的属性 API 来操作属性，不再使用反射，速度可以有不少提升。

1.5 支持 WPF 绑定

一般情况下，我们使用 WPF 绑定时，都是直接绑定到 CLR 托管属性上。但是，如果使用扩展属性的话，并不是所有属性都会有一个 CLR 属性封装器。所以，这些扩展属性必须支持 WPF 绑定也是我们的需求之一。

1.6 其它需求

l 支持属性反扩展

在产品 721 开发中，常常在 “1” 的客户化版本中需要删除 “2”版本中为“7”扩展的属性，这时，需要支持属性的反扩展（或叫反注册）。

l 获取属性值来源

由于目前 OEA 框架中的实体是分布式对象，我们常常需要在实体属性改变时分辨属性值的来源：是数据库，还是UI界面，还是来自程序中的其它代码。

l 定制序列化的数据

实体属性被框架管理后，可以很轻易地实现各种数据格式的序列化。

l 需要支持属性值的验证、强制、更改通知等事件通知。

l 元数据重载

属性的一切行为都将以回调的形式存放在元数据中。而元数据是可以被重载的。这样，子类就才重写这些行为。同时，我们就可以在进行产品客户化的时候，为属性重新定制这些行为。

最后，可以看一下在《实体扩展属性方案分析脑图》脑图文档中整理出来的需求概况图，这些需求都是历史版本中所不能支持的：

图1. 实体扩展属性需求列表

2 分析

由于前面已经把需求整理得比较明朗了。那么这里，我们首先要分析出主要需求、约束及相关的风险等。（关于框架设计的整个过程，可以参考这篇文章：《框架模块设计经验总结》。）

2.1 主要功能需求

其实在图一中已经把需求按照优先级别进行了划分，后面的整个设计将会围绕这些需求进行。其中，最主要的功能性需求是以下三个。而设计目标则是至少实现以下三个需求，其它需求则按优先级尽可能实现。

l 721客户化开发中的属性扩展

l 属性托管（受框架管理）
意思是需要为上层框架提供统一维护属性值的功能。

l 动态列

2.2 非功能需求分析

l 运行时性能

实体属性可以说是实体设计中最重要的部分。而它的性能好坏则关系到系统中每一个实体的每一个属性，这些属性都直接关系到应用的性能。简单地说，如果属性系统慢，上层应用的性能必然会慢。换句话说，属性系统的代码开发是对性能十分敏感的，在核心代码上需要十分谨慎。

2.5 版本的OEA框架使用的属性主要还是 .NET 中的原生 CLR属性系统 + CSLA 开源框架中的属性系统。主要是为了支持属性的统一管理。而本次设计，可以对系统带来许多的新功能和支持，加之原有系统的属性性能并没有构成应用层开发的性能问题，所以，一定的性能消耗是可以接受的。

对这项的要求是：

使用同样的代码，和历史属性系统进行属性测试对比，耗时不能超过原有的120%。

比较简单，也比较严格。一旦不满足此项，整个设计不可以被使用。

l 独立性

虽然实体扩展属性系统是作为 OEA 框架的一个重要组成部分，但是托管属性、扩展属性的需求在开发过程中常常会碰到。所以我们需要把实体扩展属性系统设计为一个独立的 DLL，这样，它就可以在非 OEA平台的环境中使用。

l 可扩展性

EMPS的可扩展性并不是指该系统带来的属性的可扩展性（这其实是EMPS的功能需求），而是指属性系统本身需要进行一些扩展。

当前，OEA框架中以产品元数据为整个框架的基础设施。也就是说，OEA 框架中有管理应用中所有元数据的功能。而由图1中的需求列表可以看到，EMPS也需要元数据的支持，例如属性的默认值。但是，独立性中已经要求EMPS被设计为一个完全独立的模块，也就是说EMPS完全不依赖 OEA。那么，这些属性的元数据如何支持使用 OEA 来进行保存呢？这，同样是EMPS 设计过程中需要特殊考虑的一个扩展点。

l 易用性

此项为框架设计必须考虑的一个非功能需求。

2.3 约束

l ORM功能的修改

原来的OEA的ORM中支持使用OEAORM及EntityFramework4.1（CodeFirst）两种模式，但是这两种ORM当前无疑都只支持对CLR属性的映射。而扩展属性是没有CLR属性包装器的，但是这些扩展属性同样需要映射数据库。

也就是说：如果EMPS开发完成，要映射新的扩展属性，必须要修改当前OEAORM模块。同时，无法再支持EntityFramework4.1了（EFCodeFirst基于CLR属性来进行映射）。

l 原有属性功能的兼容

2.5 版本的OEA使用的属性主要还是 .NET 中的原生 CLR属性系统 + CSLA 开源框架中的属性系统。这些属性中已经写了非常多的代码。属性的 Get 获取器及 Set 设置器中的代码，可谓五花八门。这些都必须在新的属性系统中被完全兼容，否则，必须导致业务功能出现问题。

l 大量历史代码的修改

由于本次设计本质上是一次在历史版本上的重构，而产品开发截止到目前，已经产生了几万行的历史代码，其中的实体属性也是几千个。重构如此底层的设计，在尽量保证应用层 API 不变的前提下，也必然会造成较多的修改，同时，很可能会引起比较多的BUG。这是一个必须考虑的约束条件。

2.4 风险

l 属性性能

由非功能需求的描述中知道，性能是至关重要的。关系到整个设计是否可用。但是，最终开发出来的模块性能，在设计时很难测量的。对于这个风险的规避使用以下方案：分析历史属性系统的关键性能影响点，在设计稿完成后，理论上检查这些关键点是否能在新设计出来的属性系统下运行良好。

l 支持WPF绑定

这是一个技术难关。

当前我们只是使用了 WPF 中直接绑定CLR属性的方案。如何能让我们在客户化版本的程序集中扩展的扩展属性也支持WPF绑定，成为了一个技术上的难题。

对这点的规避很简单，在整个设计开始之前，先分析WPF绑定中的内部机制，解决这个问题后，才能开始其它的设计。

3 设计方案

3.1 一些决策

由于本系统的设计比较复杂。所以先对兼容性约束做了一个决策：

在设计过程中尽量考虑功能上与原属性系统保持兼容，接口上保持一致。但是当无法兼容或者无法保持一致的接口时，可以不兼容。但是这些不兼容的设计点，都需要记录下来，当设计完成后，逐个修改。如果改动较大，则使用组内的重构工具完成。

3.2 风险点验证

3.2.1 支持 WPF 绑定

经过查阅MSDN及搜索出的网络资源，发现WPF中的绑定机制支持绑定DataTable数据表类型，而表中的字段则是动态的，根据结果数据的变化而变化。所以只要搞清楚DataTable是如何被WPF绑定支持的，那么EMPS也可以使用同样的机制进行绑定。

以下是WPF中DataTable的绑定机制分析：

图2. WPF中DataTable支持绑定的核心类型分析

图3. WPF中为DataTable生成视图模型的流程图

重点在于DataTable 实现 IListSource接口，并构造动态的视图动态类型 DataRowView并使其实现ICustomTypeDescriptor。（详细过程参见这篇文章：《OEA 扩展属性系统 - 任意适配 WPF Binding 的设计分析》，以及本系列中的文档：《任意适配 WPF Binding 的设计分析》。）

搞清楚了整个设计及创建流程，那么其实在设计EMPS时，支持这个机制就可以了。

3.2.2 性能关键点

需要分析，历史框架中的属性系统（CSLA托管属性系统）在做到托管属性的同时，是如何保证性能的呢？

其实，它其中属性的核心重点在于使用强类型的FieldData<T>来存储每一个属性，并使用定长的属性值的数组来存放：

private IFieldData[] _fieldData;

这样的好处在于强类型保证了没有装箱拆箱操作，同时定长的数组支持了以O(1)的复杂度来查找指定属性：

但是，这样搜索属性的前提是属性值数组定长，而一个实体类型到底有多少个属性，是在编译期已经完全确定下来的。换句话说，在这个数组初始化时必须知道固定的属性个数，这违背了属性可扩展的需求，这也是为什么使用这个属性系统很难做到扩展的原因。

当然，在对其进行较大改动的前提下，也不是不可能。但是考虑到CSLA是个开源框架，其满足需求与我们的需求有较大的区别，代码比较臃肿，也无法实现我们所需要的一些功能，对它做大型的改动不如重新做一个完全符合需求的托管属性框架。

经过之前的分析，可以想到，要得到较高性能的托管属性系统，最好也是使用“强类型存储属性值”加“定长数组”的方案。但是如何支持属性的扩展呢？“划分属性定义期”是个较好的解决方案。之后的主体设计中会对这个方案进行详细的描述。

3.3 方案描述

整个设计中，借鉴了CSLA托管属性以及WPF依赖属性的设计，然后再构建出我们自己的属性系统：

3.3.1 结构说明

图4. EMPS结构说明

脑图比较简单，其中的具体内容可以参考脑图《扩展属性方案》。这里只做简要说明：

l 静态结构

总体上，静态结构比较简单，主要分为两个层次。底层是抽象的属性元数据提供子系统，而另一层则是依赖于前者而构建的EMPS核心：运行时扩展属性子系统。

提取抽象的属性元数据提供系统是为了使元数据的存储、提供都抽象化，后面可以和 OEA 中的元数据存储模块进行适配。

而核心的EMPS则实现了整个的托管属性。后面将会对其以类图的形式重点说明。

l 动态结构

在这里比较特殊地提出了属性生命周期的概念。属性的生命周期规定了属性被定义（或者被反注册）的时期（可能叫定义期会比较正确。），这里主要有编译期、启动期、运行期。

l 编译期

此阶段中定义的属性主要包括使用代码编写的一般属性、扩展属性。当然，也包括“2”和“1”的扩展包中编写的一些对“7”的包中实体类进行扩展的扩展属性。

定义属性时，一同指定它对应的元数据。

l 启动期

此阶段主要以客户化定义的方式来对编译期属性及其相应的元数据进行修改。

l 运行期

该阶段主要用于附加运行时动态属性。

这些动态属性一般只用于显示，它们会影响界面的生成。属性的扩展和删除，要在生成控件之前就能确定，否则，界面没有对应的列。

由于影响界面生成，所以需要为其指定OEA框架中对应的界面元数据。如果不指定，则使用默认元数据。不过这些元数据的设计会在OEA框架中完成，与EMPS的设计无关。

在这个阶段中扩展的附加属性，不会与服务端程序有任何关系。也就是说，不需要为这些扩展属性定义 ORM 等服务端元数据。当然了，这些属性的数据也不需要序列化后在网络上进行传输。

划分出这几个周期的主要原因：使得可以判断出某个实体的编译期、启动期属性列表长度。这是因为，编译期和启动期已经定义、修改或者客户化的属性，当程序进入运行时后是不会再发生改变的。而这些属性占据了应用开发的95%以上。所以我们只要知道了编译期启动期属性的长度，也就意味着可以使用O(1)检索的数组来存放，而不是更慢的List/HashTable，保证了这些属性的性能。而对于运行时属性来说，虽然它的长度不能固定，根据业务场景而变化，但是使用情况较少，可以不考虑性能。

3.3.2 相关UML图

完整的UML图，参见：《实体扩展属性UML设计图》。下面将挑选重点进行说明。

图5.扩展属性核心类结构概要设计图

这张是实现扩展属性的核心类结构概要设计图，其中主要包含ManagedPropertyObject、ManagedProperty、ManagedPropertyField、ManagedPropertyMeta等。由于是概要设计图，其中的方法、属性等相对实现完成后的系统来比，肯定不完整，但是它的作用主要是说明整个设计的核心思想。其中：

ManagedProperty 表示托管属性，每定义一个托管属性，系统都会生成一个此类型的对象用于标记。获取、设置属性的值时，都需要提供此标记来进行检索。

ManagedPropertyMeta 表示托管属性元数据，其中提供了许多信息，例如：默认值、是否只读、属性变更逻辑回调等；这些元数据对属性值的获取、设置的逻辑都有着比较大的影响。

ManagedPropertyField 表示某个对象中某个托管属性对应的值。其实这个类后期在实现时会被定义为泛型类，这样，值的存储就不是object而是强类型的，不需要装箱拆箱操作。

ManagedPropertyObject 表示拥有托管属性的对象基类（实体），其中定义了根据ManagedProperty来获取、设置值的接口，这使得该对象能够象一般对象一样获取、存储各种值。同时，它也提供了统一处理所有托管属性值的接口，此类统一处理的接口在应用开发时很少用到，主要给上层的框架使用。上层框架可以应用这些接口完成以下的框架任务：统一的对象值拷贝、统一的序列化、检索特定类型的值等，这样的值的获取、设置速度，远比反射要快。

图6. 扩展属性仓储概要设计图

这张图说明整个系统中的托管属性都是被系统中的单例对象 ManagedPropertyRepository 给管理起来的，为了给上层提供更方便的查询功能，也方便存储，它使用 TypeIndicators 类来存储某个实体类型的属性列表。TypeIndicators这个类也负责为上层提供查询：某一个类型已经定义好的属性列表、某一类型及其所有父类定义的所有属性的联合属性列表。同时，这个类中的属性都会生成在类型中的属性的索引，这样，在获取属性值时就可以使用这个索引在属性值数组中进行属性值的查找。

图7.扩展属性元数据概要设计图

前面提到过，为了保证 EMPS的独立性，我们需要把托管属性元数据的数据获取方案抽象化，这里的 IPropertyMetaProvider 就是抽象的元数据提供器接口。而上层的OEA框架则会实现自己的提供器 OEAPropertyMetaProvider，并通过自己的元数据模块中的信息（例如图中的OEAPropertyMeta）来为托管属性提供元数据。

图8. 扩展属性实体实现WPF绑定相关概要设计图

这张图看上去会比较眼熟？没错，它和图2中的WPF支持DataTable绑定的类图比较相似。主要也是让 EntityList 实现 IListSource接口，并添加 EntityView类实现 ICustomTypeDescriptor 接口，这样，就可以实现动态属性的WPF绑定了。

3.3.3 如何支撑需求

主要的设计方案及类图看完之后，我们需要考虑，整个方案是否能支撑起前面说到的所有需求。下图是对整个需求的可支撑性进行分析。相关内容可以参见：《实体扩展属性方案分析脑图》,在此不再赘述。

图9. 设计方案对需求的支持度分析。

3.4 重点实现细节

在对需求支持分析之后，再经过召开的设计评审会议，发现这样的方案可以实现基本全部需求。这样，就进入实现环节了。实现环节就关注更多了细节性设计。本文档将会挑选一部分重点进行说明。

首先，先来看看最终完成的代码中，最核心部分的代码结构图：

图10. 核心代码结构图

整个结构的实现与设计相差无几。接下来，说明一些相对重要的代码：

l 先是ManagedPropertyObject中的属性值获取、设置相关代码：

前面的设计方案中提到，这个类主要作为所有实体类的基类，提供值的获取、设置等。而这个类其实是把属性值的管理都放到了内部的一个类ManagedPropertyObjectFieldsManager 中：

并把相关的操作都代理到这个类上：

而 ManagedPropertyObjectFieldsManager则实现了这些逻辑的核心代码。其中，它的私有字段定义如下：

可以看到，编译期、启动期属性值与运行期属性值被分开存放。前者使用数组，构造函数直接初始化，而后者则在需要时才会被序列化。还注意到，它继承自CustomSerializationObject，使得整个属性值列表是可以被自定义序列化的。下面，是泛型的属性值获取与设置逻辑：

internal TPropertyType GetProperty<TPropertyType>(ManagedProperty<TPropertyType> property)

{

var useDefault = true;

TPropertyType result = default(TPropertyType);

if (property.IsReadOnly)

{

result = (property as ManagedProperty<TPropertyType>).ProvideReadOnlyValue(this._owner);

useDefault = false;

}

else

{

if (property.LifeCycle == ManagedPropertyLifeCycle.CompileOrSetup)

{

var field = this._compiledFields[property.TypeCompiledIndex] as ManagedPropertyField<TPropertyType>;

if (field != null)

{

result = field.Value;

useDefault = false;

}

else

{

if (this._runtimeFields != null)

{

IManagedPropertyField f;

if (this._runtimeFields.TryGetValue(property, out f))

{

var field = f as ManagedPropertyField<TPropertyType>;

result = field.Value;

useDefault = false;

}

var meta = property.GetMeta(this);

if (useDefault) result = meta.DefaultValue;

result = meta.CoerceGetValue(this._owner, result);

return result;

}

internal void SetProperty<TPropertyType>(ManagedProperty<TPropertyType> property, TPropertyType value, ManagedPropertyChangedSource source)

{

ForceNotReadOnly(property);

var meta = property.GetMeta(this);

bool cancel = meta.RaisePropertyChanging(this._owner, ref value, source);

if (cancel) return;

var hasOldValue = false;

TPropertyType oldValue = default(TPropertyType);

ManagedPropertyField<TPropertyType> field = null;

//这个 if 块中的代码：查找或创建对应 property 的 field，同时记录可能存在的历史值。

if (property.LifeCycle == ManagedPropertyLifeCycle.CompileOrSetup)

{

field = this._compiledFields[property.TypeCompiledIndex] as ManagedPropertyField<TPropertyType>;

if (field == null)

{

//不管是不是默认值，都进行存储。

//不需要检测默认值更加快速，但是浪费了一些小的空间。

//默认值的检测，在 GetNonDefaultPropertyValues 方法中进行实现。

field = property.CreateField();

this._compiledFields[property.TypeCompiledIndex] = field;

}

else

{

oldValue = field.Value;

hasOldValue = true;

}

else

{

if (this._runtimeFields == null)

{

this._runtimeFields = new Dictionary<IManagedProperty, IManagedPropertyField>();

}

else

{

IManagedPropertyField f;

if (this._runtimeFields.TryGetValue(property, out f))

{

field = f as ManagedPropertyField<TPropertyType>;

oldValue = field.Value;

hasOldValue = true;

}

if (field == null)

{

field = property.CreateField();

this._runtimeFields.Add(property, field);

}

field.Value = value;

if (!hasOldValue) { oldValue = meta.DefaultValue; }

if (!object.Equals(oldValue, value))

{

//发生 Meta 中的事件

var args = meta.RaisePropertyChanged(

this._owner, oldValue, value, source

);

//发生事件

this._owner.RaisePropertyChanged(args);

}

可以看到，编译期属性主要通过一维数组进行存放，数组中每一个元素都是强类型的泛型对象 ManagedPropertyField<TPropertyType>。

另外，要注意的是，该类提供了同样的非泛型接口：

非泛型方法主要是为上次框架提供，其中主要考虑装箱拆箱操作的性能消耗。（关于接口加泛型类的底层框架设计方案，参见：《重构实践：体验interface的威力(一)》、《重构实践：体验interface的威力(二)》。）

GetProperty、SetProperty 方法是对性能最敏感的两个方法，其实现必须特别小心，其内部调用的每一个方法，如 ManagedProperty.GetMeta(ManagedPropertyObject owner)、ManagedPropertyMetadata.RaisePropertyChanged等，也都必须要做特别的优化，需要考虑到装箱拆箱、属性检索、不构造多余对象等。具体代码设计参考实际工程中的代码，在此不做过多描述。

l 注册属性（及反注册属性）的方法位于 ManagedPropertyRepository类中。

其主要的职责是构造ManagedProperty对象，并计算它的一些重要属性，例如：用于属性快速Hash的GlobalIndex、用于编译期属性检索值时使用的数组下标TypeIndex等。