波斯马BOSSMA Information Technology

模型数据变更比较利器:ModelDataCompare

发布时间:2015年3月19日 / 分类:DOTNET / 10,350 次浏览 / 评论

引言

在业务系统的开发需求中经常需要记录数据的变更日志,并显示给管理人员查看,可能的需求包括:

1、记录每一次的数据修改、数据中的每一项变更:变更时间、变更人、变更项等。

2、在页面中显示数据中的每一项变更:变更项的名称、变更前后的值。

这里边隐含了一些不太明显的需求,比如:

1、数据中某些项不需要记录变更,比如:修改时间。

2、数据中保存的是内部编号,需要显示可读的描述信息给管理人员,比如:城市ID。

3、数据项一般都是英文名称,需要显示中文信息给管理人员,比如:Gender。

另外有时候由于设计方面的原因,某个业务模型可能包含多个或者多级子类型,这时候进行比较就会涉及到嵌套的问题,比较复杂。

如果没有一个较好的处理模式或者处理工具,这个任务将带来不小的工作量,有时候甚至需要在前后台进行大量的关于此项的工作。当然如果不存在这些隐含的需求,或者这些需求可以被忽略,那就没有这么多事了,但是开发人员一般都是被指挥的。

ModelDataCompare

ModelDataCompare 提供了一组方法用于比较同一个类型的两个实例之间的数据差异。 常用于计算某种业务数据的变更,比如“用户信息”修改后计算修改了哪些用户的属性、属性修改前后的新旧值。

重要的是ModelDataCompare是完全免费并开源的,中文注释,提供详细的测试用例,在这里可以下载:
https://github.com/bosima/ModelDataCompare

下边就来先熟悉下这个工具:

ModelDataCompare中数据变更的结果通过ChangeItem定义:

 

ModelDataCompare 不仅仅是简单的数据比对,还提供了若干增强支持:

1、嵌套类型比较:

如下定义的模型类,其中的User属性也是一个复杂数据类型,ModelDataCompare 可以对User中的每一个属性进行比较。

 

2、集合类型比较:

ModelDataCompare 可以比较集合中对应索引位置的同一个类型的实例,还支持集合元素数量不相等的比较。

 

3、数据属性友好名称

程序中的属性一般使用英文名称,对于业务系统的使用用户来说可读性较差,ModelDataCompare 支持为属性提供一个友好的可读名称。

 

4、数据属性值友好描述

属性对应的值可能只是一个系统内部使用的编号,对于业务系统的使用用户来说看不懂,ModelDataCompare 支持通过特性的方式转换相应的内部值为一个用户可读的值。

目前特性支持两种方式:枚举、方法。

5、排除无关项

排序不关心或者不重要的数据属性,比如:数据修改时间。

以上5点基本解决了各种独特的需求。

ModelDataCompare 内部采用了反射的方式用于获取类型的属性、获取属性的特性,以及获取相关方法和属性的值,这对性能会造成一定的影响。为了解决这个问题,ModelDataCompare 内部对相关反射获取到的数据进行了缓存,可以提升一些性能。

有需要的朋友赶紧去GitHub看看吧。

本博客所有文章如无特别注明均为原创。
复制或转载请以超链接形式注明转自波斯马,原文地址《模型数据变更比较利器:ModelDataCompare

关键字:

建议订阅本站,及时阅读最新文章!
【上一篇】 【下一篇】

发表评论