AI 助理
备案控制台
开发者社区 人工智能 文章 正文

基于OEA框架的客户化设计（一） 总体设计

2017-11-16 890
版权
版权声明：
本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《 阿里云开发者社区用户服务协议》和 《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写 侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。
简介：

设计目标

  1. 支持实体类的扩展。
  2. 支持实体扩展包的动态加载。
  3. 支持界面扩展及界面扩展包的动态加载。
  4. 各版本间自定义界面元素，可以基于现有的特定版本修改一些内容。
  5. 各版本间支持自定义内容文件，如果没有使用，则使用默认版本的内容文件。（内容文件是指：图片、帮助文档等。）

    解释一下，基于OEA框架的GIX4项目是以领域实体为中心的架构。主版本中的领域实体，代表了产品功能“7、2、1”中的7和2 。7是所有版本都应该有的领域实体，2是可以进行配置以说明是否具备的领域实体，而1就是在主干之外，为特定版本开发的实体。所以以上目标中，支持对“2”的定制和对“1”的扩展是最重要的。

    由于时间仓促，目前只能以上述内容为目标，以后可能还会添加一些内容。如，枚举值的客户化，DailyBuild客户化等。

方案设计

    本次设计经过组内讨论，确定了具体的设计方向。这里主要对最重要的两项进行详细的叙述。

配置？

    一般来说，要实现客户化，使用配置可能是最直接的想法。一开始我想也没想就觉得可能客户化的内容需要存储在配置文件中，可能是一个自定义的XML文档。但是，后来和朋友聊天过程中灵光一闪，真的要采用配置吗？这里根本不需要在运行时动态改变应用程序的行为，只要在编译期能够编译出不同的版本即可，所以我决定使用“应用程序定义”的方式来完成“配置”。而“定义”与配置不同点在于，定义是用代码写死的，程序运行期间不可更改。编译期根据定义编译不同的版本。

    其实后来知道，产品线工程中的重点之一就是对产品的“可变性”进行管理。而可变性的实现机制有很多种，主要分三类：适配、替换、扩展，具体内容见：《软件产品线工程方法：如何在OpenExpressApp做客户化工作》。

    设计之初，我认为客户化的应用程序配置应该满足：

  1. 可以有公共的配置，子配置如果设置了同样的项，则重写公共的配置。
  2. 简单可用的配置API

    最后，我定出了以下的实现目标：

主干版本中有应用程序定义类ConfigMain，客户A和客户B分别有自定义的配置类ConfigA，ConfigB。

各客户的版本中，分别把他自己的配置类和主配置类结合，然后以配置文件的方式注入到整个应用程序中。

当应用程序读取某个配置项时，直接从注入的配置类中获取；此时，按照一定的寻找顺序，定位该配置项。如客户A的配置类为ConfigA + ConfigMain，则在寻找时，应该先在ConfigA中寻找，如果找不到，则在ConfigMain中寻找。

 

文件组织方式

    各客户版本需要不同的文件来运行，这些文件主要是一些内容文件，如图片，xml，也包含少量的DLL。毫无疑问地，客户化工作需要对它们进行管理。

    DLL文件的组织比较简单，只需要各客户版本把自己的DLL放在一个版本特定的目录下，程序动态加载就行了。

    这里我定出了以下规则：所有需要客户化的DLL都放在客户各自的文件夹根目录下。

    但是这里需要注意，这些代码文件需要在应用程序定义被加载之后，才会被应用程序加载。所以应用程序定义类需要被直接DI进来，这样，客户版本信息就可以在这些DLL加载之前被访问到，也就可以继续加载这些DLL了。

    内容文件的组织不同于代码，这些文件很可能在运行时也需要被替换。所以这里的策略不能再使用“定义”的方式。需要有一定的文件寻址算法。以下是暂定方案：

    所有需要客户化的文件都放在/Files/中。版本通用文件，则直接放在/Files/Common/中。各客户有自己的文件夹，如客户A有文件夹/Files/A/。文件夹名在配置类中标明。
程序中，可以文件寻找引擎指定要使用的文件的相对路径，如使用LOGO，则指定/Images/Logo.jpg。如果客户A在A中已经建立了/Files/A/Images/Logo.jpg文件，则返回此文件；否则返回的应该是/Files/Common/Images/Logo.jpg。

 

方案总结

    使用定义而不使用配置的方式，防止了不必要的程序代码的开发。但是要注意定义的API的简便和易用性。

    文件组织方式使得各客户文件完全分离，简化了Buid 版本的代码开发。这里主要注意路径寻址的实现。

具体设计

应用程序定义类的实现

    为支持属性值的重写和融合，应用程序定义类直接使用OO的继承实现，通用的定义类作为基类，分支版本直接从它派生下来并重写新的属性。使用OO的方式可以很好地实现属性值扩展，例如，我们可以使用装饰模式来实现复杂的属性定义。

    应用程序定义类中，应该组合一些分支对象，来进行更细粒度的定义。

    下图是本次客户化中应用程序定义类的结构：

image

图1 应用程序定义类的结构

    Freeable表示所有定义都是可以被冻结的。这些定义在一开始被设置好版本的值后，将会被冻结，所以内容不再改变，变为“不可变类”。一，这是其运行期不需要改变的体现；二，不可变类是高效的类。

    PathDefinition是所有内容文件的路径定义，它使用了PathProvider类来为其提供内容文件路径寻址算法，同时，它使用内容文件的相对路径从PathProvider中获取真实路径。

    UIInfo是视图信息的载体，该类是定义的重点，留待下一篇中介绍。

    AppDefinition是整个应用程序定义类的基类，以DI实现单例模式，作为全局唯一的访问点。目前，它包含了一个UIInfo对象来提供视图信息和一个PathDefinition来提供文件路径。

   

以下主要给出AppDefinition类具体的代码：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
/// <summary>
/// 应用程序的主干版本定义。
/// 同时，也是分支版本定义的基类。
/// </summary>
public  abstract  class  AppDefinition : Definition
{
     #region SingleTon
 
     private  static  AppDefinition _instance;
 
     /// <summary>
     /// 提供一个静态字段，作为全局唯一的访问地址。
     /// 注意：本类并没有直接设计为单例模式！
     /// </summary>
     public  static  AppDefinition Instance
     {
         get
         {
             if  (_instance == null ) throw  new  InvalidOperationException( "请先设置该属性。" );
             return  _instance;
         }
         set
         {
             if  (value == null ) throw  new  ArgumentNullException( "value" );
             if  (_instance != null ) throw  new  InvalidOperationException( "该属性只能被设置一次。" );
             _instance = value;
         }
     }
 
     #endregion
 
     /// <summary>
     /// 查找文件路径的查找算法提供器。
     /// </summary>
     private  PathProvider _pathProvider;
 
     /// <summary>
     /// 在使用所有属性前，需要主动调用此方法来进行初始化。
     /// </summary>
     protected  override  void  InitCore()
     {
         base .InitCore();
 
         this .CheckUnFrozen();
 
         this ._pathProvider = new  PathProvider();
         if  (! string .IsNullOrWhiteSpace( this .BranchAppName))
         {
             this ._pathProvider.AddBranch( this .BranchAppName);
         }
 
         //初始化所有文件路径
         this .Pathes = this .CreatePathes();
         this .Pathes.SetPathProvider( this ._pathProvider);
         this .Pathes.Initialize();
 
         //创建元数据库
         this .UIInfo = this .DefineUI();
         this .UIInfo.Initialize();
     }
 
     protected  override  void  OnFrozen()
     {
         base .OnFrozen();
 
         FreezeChildren( this .UIInfo, this .Pathes);
     }
 
     /// <summary>
     /// 分支版本名。
     /// 同时，这个也是客户化文件夹的名字。
     /// 分支版本定义，需要重写这个属性。
     /// </summary>
     protected  virtual  string  BranchAppName
     {
         get
         {
             return  null ;
         }
     }
 
     #region 文件
 
     /// <summary>
     /// 创建所有路径的定义。
     /// 子类重写此方法，用于添加更多的路径信息定义。
     /// </summary>
     /// <returns></returns>
     protected  virtual  PathDefinition CreatePathes()
     {
         return  new  PathDefinition();
     }
 
     /// <summary>
     /// 应用程序中所有使用到的需要客户化的路径集。
     /// </summary>
     public  PathDefinition Pathes { get ; private  set ; }
 
     #endregion
 
     #region DLL
 
     /// <summary>
     /// 获取所有此版本中需要加载的实体类Dll集合。
     /// </summary>
     /// <returns></returns>
     public  string [] GetEntityDlls()
     {
         return  this ._pathProvider.MapAllPathes( "Library" , true );
     }
 
     /// <summary>
     /// 获取所有此版本中需要加载的模块Dll集合。
     /// </summary>
     /// <returns></returns>
     public  string [] GetModuleDlls()
     {
         return  this ._pathProvider.MapAllPathes( "Module" , false );
     }
 
     #endregion
 
     #region UIInfo
 
     /// <summary>
     /// 应用程序中所有可用的视图信息。
     /// </summary>
     public  UIInfo UIInfo { get ; private  set ; }
 
     /// <summary>
     /// 子类重写此方法，用于初始化产品视图定义。
     /// 重点实现！
     /// </summary>
     /// <returns></returns>
     protected  virtual  UIInfo DefineUI()
     {
         return  new  UIInfo();
     }
 
     #endregion
}

 

    子版本的定义需要重写父类的DefineUI方法进行自己的版本信息定义，如，通用版本的实现：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
namespace  Common.Definition
{
     /// <summary>
     /// 通用版本的产品定义
     /// </summary>
     public  class  AppDefinition : OpenExpressApp.MetaModel.Customizing.AppDefinition
     {
         /// <summary>
         /// 子类重写此属性以指定是否包含合同。
         /// </summary>
         protected  virtual  bool  IncludeContract
         {
             get
             {
                 return  true ;
             }
         }
 
         /// <summary>
         /// 这里加入东方版本需要的特定的视图信息
         /// </summary>
         /// <returns></returns>
         protected  override  UIInfo DefineUI()
         {
             var  ui = base .DefineUI();
 
             ui.Entity<CBFGQBQItemTitle>()
                 .EntityProperty(t => t.Code).ShowInLookup().ShowInList().Set_ListMinWidth(200);
 
             ui.Entity<CBSummary>()
                 .EntityProperty(t => t.PBSId).Show().Set_ListMinWidth(500);
 
             ui.Entity<CBNormSummary>()
                 .EntityProperty(t => t.PBSId).Show().Set_ListMinWidth(100);
 
             //在基类上定义视图信息，这个类的所有子类如果没有显式设置其它的值，则会使用基类的属性。
             ui.Entity( typeof (BQNormItemTitleBase))
                 .EntityProperty( "AllCode" ).Show().Set_ListMinWidth(200);
 
             this .DefineContractDll(ui);
 
             return  ui;
         }
 
         /// <summary>
         /// 定义合同模块的显示。
         /// </summary>
         /// <param name="ui"></param>
         private  void  DefineContractDll(UIInfo ui)
         {
             if  ( this .IncludeContract)
             {
                 ui.Entity<ContractBudget>().UnVisible();
                 ui.Entity<RealContractBudget>().Visible();
                 ui.UnVisible(
                     CCN.ShowPCIBQitemCommand, CCN.EntityShowBQCommand,
                     CCN.MeasureShowBQCommand, CCN.ResourceShowBQCommand,
                     CCN.ProjectIndicatorsCalculationCommand
                     );
             }
             else
             {
                 ui.UnVisible(
                     typeof (RealContractBudget), typeof (ContractSubjectType),
                     typeof (ProjectContractSubject), typeof (ContractIndicatorQueryObject)
                     );
                 ui.UnVisible(
                     CCCN.ShowPCIBQitemCommand, CCCN.EntityShowBQCommand,
                     CCCN.MeasureShowBQCommand, CCCN.ResourceShowBQCommand
                     );
             }
         }
     }
}

 

程序在启动时，从配置中注入AppDefinition，然后调用其初始化操作和冻结方法即可：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
public  partial  class  App : Application
{
     public  App()
     {
         this .InitAppDefinition();
     }
 
     /// <summary>
     /// 定义软件运行时版本
     /// </summary>
     private  void  InitAppDefinition()
     {
         var  appDefType = Type.GetType(AppConfig.Instance.AppDefinitionClass, true , true );
 
         AppDefinition.Instance = Activator.CreateInstance(appDefType) as  AppDefinition;
         AppDefinition.Instance.Initialize();
         AppDefinition.Instance.Freeze();
     }

配置文件：

1
< add  key="AppDefinitionClass" value="Common.Definition.AppDefinition, Common.Definition"/>

 

    限于篇幅，今天就先总结到此。下一篇主要是把客户化框架的设计讲完，然后再下一篇可能是GIX4项目中分离原有DLL的应用。


本文转自BloodyAngel博客园博客，原文链接：http://www.cnblogs.com/zgynhqf/archive/2010/09/20/1832019.html，如需转载请自行联系原作者

文章标签：
算法
文艺小青年
目录
相关文章
技术mix呢
|
Windows
闲谈可插拔式应用程序的开发
技术mix呢
2335 0
MrRobot
|
7月前
|
关系型数据库 Java 数据库连接
WEBGIS系统数据库设计
WEBGIS系统数据库设计
MrRobot
73 2
a15034260562-24955
|
7月前
深入.net平台的分层开发
深入.net平台的分层开发
a15034260562-24955
107 0
ljking7002-
|
Java 关系型数据库 程序员
【组件设计开发】采用领域驱动设计设计和开发可组装的组件
采用领域驱动设计设计和开发可组装的组件
ljking7002-
27947 7
【组件设计开发】采用领域驱动设计设计和开发可组装的组件
攻城狮寒草
|
API
LowCode + 团队组件设计规范 = 灵光一闪 ？
LowCode + 团队组件设计规范 = 灵光一闪 ？
攻城狮寒草
194 0
青夜之衫
基于软件体系结构和构件技术的开发过程
青夜之衫
1347 0
walb呀
|
数据库 开发框架 关系型数据库
Winform开发框架重构总结
walb呀
1893 0
walb呀
Winform开发框架之简易工作流设计
walb呀
1203 0
文艺小青年
|
XML C# 数据格式
Rafy 领域实体框架 - 领域模型设计器（建模工具）设计方案
文艺小青年
2126 0
技术小牛人
|
算法 关系型数据库 程序员
关于工作流引擎的设计讨论
技术小牛人
1159 0

热门文章

最新文章

  • 1
    使用MaxCompute访问TableStore（OTS） 简明手册
  • 2
    从超模转职成为程序媛是一种怎样的体验
  • 3
    阿里巴巴NACOS（6）- 在k8s上部署Nacos
  • 4
    将任意应用窗口置顶显示，这个工具太强了。
  • 5
    Wi-Fi物联网设备配网的N种方式
  • 6
    WCF分布式安全开发实践(8):消息安全模式之用户名身份验证:Message_UserName_WSHttpBinding
  • 7
    TechED2010与我（二）—— Windows Phone 7 Develop
  • 8
    华尔街认为Twitter出售毫无悬念 只是不会在今年发生
  • 9
    迂者趣事之——下错楼层
  • 10
    Unix Regex
  • 1
    检测指定TCP端口开放状态免费API接口教程
    23
  • 2
    Python 语言：强大、灵活与高效的编程之选
    31
  • 3
    发现一肉鸡接口，快来围攻啦~
    30
  • 4
    深入解析PID控制算法：从理论到实践的完整指南
    32
  • 5
    《C++ 模型训练之早停法：有效预防过拟合的关键策略》
    25
  • 6
    C++构建 GAN 模型：生成器与判别器平衡训练的关键秘籍
    22
  • 7
    通过matlab分别对比PSO,反向学习PSO,多策略改进反向学习PSO三种优化算法
    25
  • 8
    【C语言】宏定义详解
    23
  • 9
    【C语言】进程和线程详解
    19
  • 10
    【C语言】宏定义详解
    26

    • 相关课程

    更多
  • 软件供应商进阶管理实操
  • Java面向对象开发
  • 项目管理与高效沟通协作
  • 微服务架构与混沌工程介绍
  • 软件供应商发布服务实操
  • 软件用户使用服务及供应商进阶管理

    • 相关电子书

    更多
  • 典型业务逻辑漏洞挖掘
  • 《前端智能化实践》——逻辑代码生成
  • 研发过程中的那些反模式

    • 相关实验场景

    更多
  • 高效敏捷开发体验
  • 这样做，项目管理简单高效
  • 基于函数计算快速搭建Zblog等传统应用框架
  • 电商系统中混沌工程实践
    • 下一篇
    阿里云无影云电脑免费试用，最长可试用3个月