一个关于解决序列化问题的编程技巧

在前一篇文章中我曾经说过,现在正在做一个小小的框架以实现采用统一的API实现对上下文(Context)信息的统一管理。这个框架同时支持Web和GUI应用,并支持跨线程传递和跨域传递(这里指在WCF服务调用中实现客户端到服务端隐式传递),以及对上下文项目(ContextItem)的读写控制。关键就在于后面两个特性的支持上面,出现一个小小的关于序列化的问题。解决方案只需要改动短短的一行代码,结果却让我折腾了老半天。

一、问题重现

为了重现我实际遇到的问题,我特意将问题简化,为此我写了一个简单的例子(你可以从这里下载)。在下面的代码片断中,我创建了一个名称为ContextItem的类型,代表一个需要维护的上下文项。由于需要在WCF服务调用实现自动传递,我将起定义成DataContract。ContextItem包含Key,Value和ReadOnly三个属性,不用说ReadOnly表示该ContextItem可以被修改。注意Value属性Set方法的定义——如果ReadOnly则抛出异常。

   1: [DataContract(Namespace = "http://www.artech.com")]
   2: public class ContextItem
   3: {
   4:     private object value = null;
   5:     [DataMember]
   6:     public string Key { get; private set; }
   7:     [DataMember]
   8:     public object Value
   9:     {
  10:         get
  11:         {
  12:             return this.value;
  13:         }
  14:         set
  15:         {
  16:             if (this.ReadOnly)
  17:             {
  18:                 throw new InvalidOperationException("Cannot change the value of readonly context item.");
  19:             }
  20:             this.value = value;
  21:         }
  22:     }
  23:     [DataMember]
  24:     public bool ReadOnly { get; set; }
  25:     public ContextItem(string key, object value)
  26:     {
  27:         if (string.IsNullOrEmpty(key))
  28:         {
  29:             throw new ArgumentNullException("key");
  30:         }
  31:         this.Key = key;
  32:         this.Value = value;
  33:     }
  34: }

为了演示序列化和反序列化,我写了如下两个静态的帮助方法。Serialize和Deserialize分别用于序列化和反序列化,前者将对象序列成成XML并保存到指定的文件中,后者则从文件读取XML并反序列化成相应的对象。

   1: public static T Deserialize<T>(string fileName)
   2: {
   3:     DataContractSerializer serializer = new DataContractSerializer(typeof(T));
   4:     using (XmlReader reader = new XmlTextReader(fileName))
   5:     {
   6:         return (T)serializer.ReadObject(reader);
   7:     }
   8: }
   9:  
  10: public static void Serialize<T>(T instance, string fileName)
  11: {
  12:     DataContractSerializer serializer = new DataContractSerializer(typeof(T));
  13:     using (XmlWriter writer = new XmlTextWriter(fileName, Encoding.UTF8))
  14:     {
  15:         serializer.WriteObject(writer, instance);
  16:     } 
  17:     Process.Start(fileName);
  18: }

我们的程序很简单。从如下的代码片断中,我们先创建一个ContextItem对象,然后将ReadOnly属性设置成true。然后调用Serialize方法将对象序列化成XML并保存在一个名称为context.xml的文件中。然后调用Deserialize方法,读取该文件进行反序列化。

   1: static void Main(string[] args)
   2: {
   3:     var contextItem1 = new ContextItem("__userId", "Foo");
   4:     contextItem1.ReadOnly = true;
   5:     Serialize<ContextItem>(contextItem1, "context.xml");
   6:     var contextItem2 = Deserialize<ContextItem>("context.xml");           
   7: }

序列化操作能够正常执行,但当程序执行到Deserialize的时候抛出如下一个InvalidOperationException异常。

image

二、问题分析

从上面给出的截图,我们不难看出,异常是在给ContextItem对象的Value属性赋值的时候抛出的。如果对DataContractSerializer序列化器的序列化/反序列化规则的有所了解的话,应该知道:对于数据契约(DataContract)基于属性(Property)的数据成员(DataMember),序列器在反序列化的时候是通过调用Set方法对其进行初始化的。在本例中,由于ReadOnly是True,在对Value进行反序列化的时候必然会调用Set方法。但是,只读的ContextItem却不能对其赋值,所以异常抛出。

那么,如何来解决这个问题呢?我最初的想法是这样:在序列化的时候将ReadOnly属性设置成False,然后添加另一个属性专门用于保存真实的值。在进行反序列的时候,由于ReadOnly为false,所以不会出现异常。当反序列化完成之后,在将ReadOnly的初始值赋上。虽然上述的方案能够解决问题,但是为此对ContextItem添加一个只在序列化和反序列化的过程中在有用的属性,总觉得很丑陋。

我们不妨换一种思路:异常产生于对Value属性凡序列化时发现ReadOnly非True的情况。那么怎样采用避免这种情况的发生呢?如果Value属性先于ReadOnly属性被序列化,那么ReadOnly的初始值就是False,这个问题不就解决了吗?这就是我们的第一个解决方案。

三、解决方案一:通过控制属性反序列化顺序

那么,如果控制那么属性先被反序列化,那么后被序列化呢?这就是要了解DataContractSerializer序列化器的序列化和发序列化规则了。在默认的情况下,DataContractSerializer是按照数据成员的名称的顺序进行序列化的。这可以从生成出来的XML的结构看出来。而XML元素的先后顺序决定了反序列化的顺序。

   1: <ContextItem xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.artech.com">
   2:     <Key>__userId</Key>
   3:     <ReadOnly>true</ReadOnly>
   4:     <Value xmlns:d2p1="http://www.w3.org/2001/XMLSchema" i:type="d2p1:string">Foo</Value>
   5: </ContextItem>

在上面的例子中,ContextItem的ReadOnly排在Value的前面,会先被序列化。那么,是不是我们要更新Value或者ReadOnly的数据成员(DataMember,不是属性名称)呢?这肯定不是我们想要的解决方案。在SOA的世界中,DataMember是契约的一部分,往往是不容许更改的。

如果在不更改数据成员名称的前提下让属性Value先于ReadOnly被序列化,需要用到DataContractSerializer另一条反序列化规则:我们可以通过DataMemberAttribute特性的Order属性控制序列化后的属性在XML元素列表中的位置。

为此,我们有了答案,我们只需要将ContextItem稍加改动就可以了。在如下的代码中,在为Value和ReadOnly两个属性应用DataMemberAttribute的时候,将Order属性分别设置成1和2,这样就能使ContextItem对象在被序列化的时候,Value和ReadOnly属性对应的XML元素将永远会有前后之分。这里还需要注意的是,在Value属性的Set方法中,判断是否只读,采用的不是ReadOnly属性,而是对应的readonly字段。这一点非常重要,如果调用ReadOnly属性将会迫使该属性被反序列化。

   1: [DataContract(Namespace = "http://www.artech.com")]
   2: public class ContextItem
   3: {
   4:     private object value = null;
   5:     private bool readOnly;
   6:     [DataMember]
   7:     public string Key { get; private set; }
   8:  
   9:     [DataMember(Order = 1)]
  10:     public object Value
  11:     {
  12:         get
  13:         {
  14:             return this.value;
  15:         }
  16:         set
  17:         {
  18:             if (this.readOnly)
  19:             {
  20:                 throw new InvalidOperationException("Cannot change the value of readonly context item.");
  21:             }
  22:             this.value = value;
  23:         }
  24:     }
  25:     [DataMember(Order =2)]
  26:     public bool ReadOnly
  27:     {
  28:         get
  29:         {
  30:             return readOnly;
  31:         }
  32:         set
  33:         {
  34:             readOnly = value;
  35:         }
  36:     }
  37:     //Others
  38: }

有兴趣的读者可以亲自试试看,如果我们进行了如上的更改,前面的程序就能正常运行了。到这里,有的读者可以要问了,你不是说仅仅有一行代码的变化吗,我看上面改动的不止一行嘛。没有错,我们完全可以作更少的更改来解决问题。

四、解决方案二:将数据成员定义在字段上而不是属性上

我们再换一种思维,之所以出现异常是在反序列化的时候调用Value属性的Set方法所致。如果在反序列化的时候不调用这个方法不就得了吗?那么,如何才能避免对Value属性的Set方法的调用呢?方法很简单,那就是将数据成员定义在字段上,而不是属性上。基于属性的数据成员在反序列化的时候不得不通过调用Set方法对数据项进行初始化,而基于字段的数据成员在反序列化的时候只需要直接对其复制就可以了。

基于这样的思路,我们对原来的ContextItem进行简单的改动——将DataMemberAttribute特性从Value属性移到value字段上。需要注意的,为了符合于原来的Schema,需要将DataMemberAttribute特性的Name属性设置成“Value”。

   1: [DataContract(Namespace = "http://www.artech.com")]
   2: public class ContextItem
   3: {
   4:     [DataMember]
   5:     public string Key { get; private set; }
   6:  
   7:     [DataMember(Name = "Value")]
   8:     private object value = null;
   9:     public object Value
  10:     {
  11:         get
  12:         {
  13:             return this.value;
  14:         }
  15:         set
  16:         {
  17:             if (this.ReadOnly)
  18:             {
  19:                 throw new InvalidOperationException("Cannot change the value of readonly context item.");
  20:             }
  21:             this.value = value;
  22:         }
  23:     }
  24:     [DataMember]
  25:     public bool ReadOnly { get; set; }     
  26:      //Others
  27:     }
  28: }

总结

虽然这仅仅是一个很小的问题,解决的方案看起来也是如此的简单。但是,这并不意味着这是一个可以被忽视的问题,背后隐藏对DataMemberAttribute序列化的序列化规则的理解。


作者:蒋金楠
微信公众账号:大内老A
微博:www.weibo.com/artech
如果你想及时得到个人撰写文章以及著作的消息推送,或者想看看个人推荐的技术资料,可以扫描左边二维码(或者长按识别二维码)关注个人公众号(原来公众帐号蒋金楠的自媒体将会停用)。
本文版权归作者和博客园共有,欢迎转载,但未经作者同意必须保留此段声明,且在文章页面明显位置给出原文连接,否则保留追究法律责任的权利。
原文链接

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/news/257174.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

踩坑之路anaconda创建虚拟环境

浑浑噩噩的过了三年渣硕生涯&#xff0c;虽然说自己是搞图像的&#xff0c;但基本是一些机器视觉的东西&#xff0c;最近突然想好好搞搞深度学习这方面&#xff0c;想着那就先搭搭环境跑个demo吧&#xff0c;经历了好多莫名其妙的踩坑操作&#xff0c;demo跑的终于没bug了&…

IP多播技术及其应用

随着全球互联网&#xff08;Internet&#xff09;的迅猛发展&#xff0c;上网人数正以几何级数快速增长&#xff0c;以因特网技术为主导的数据通信在通信业务总量中的比列迅速上升&#xff0c;因特网业务已成为多媒体通信业中发展最为迅速、竞争最为激烈的领域。Internet网络传…

【转载】恼人的函数指针(一)

本文转载自: http://www.cnblogs.com/AnnieKim/archive/2011/11/20/2255813.html#undefined> 这篇是为了加深记忆所写。发现&#xff0c;很多知识若不经过反复的琢磨和动手实践&#xff0c;是很难记得住的。 1&#xff09; 函数指针的初始化。 函数如下&#xff1a; int Com…

dns服务器未响应

昨天还好好的&#xff0c;今天打开电脑显示DNS服务器为响应。 解决办法&#xff1a;右击电脑下方图标栏——打开Windows任务管理器——服务——服务&#xff08;s&#xff09;——找到DNS client和DHCP client——右击重启

php分页原理

<?php 1.分页原理所需数据&#xff1a; 总记录数&#xff1a; $records mysql_num_rows() 每页显示&#xff1a; $pagesize 人为定义10 总页数&#xff1a; $pages $records/$pagesize 当前页&#xff1a; $page 自己选择2.分页的sql语句&#xff1a; SELECT * F…

从客户端(CourseIssueContent=P财务审计师岗位认证招生简章BR...)中检测到有潜在危险的 Request.Form 值。...

说明: 请求验证过程检测到有潜在危险的客户端输入值&#xff0c;对请求的处理已经中止。该值可能指示危及应用程序安全的尝试&#xff0c;如跨站点的脚本攻击。通过在 Page 指令或 配置节中设置 validateRequestfalse 可以禁用请求验证。但是&#xff0c;在这种情况下&#xff…

ubuntu安装pytorch镜像修改及下载

ubuntu安装pytorch镜像修改及下载 下载pytorch下载太慢&#xff0c;搞了很长时间&#xff0c;终于改好镜像能快速下载了&#xff0c;记录以下。 1.在/home/用户名/ 下找到/.condarc 文件&#xff0c;可能需要你右击鼠标显示隐藏文件才能显示&#xff0c; 2.把内容修改为清华等镜…

R--线性回归诊断(一)

线性回归诊断--R 【转载时请注明来源】&#xff1a;http://www.cnblogs.com/runner-ljt/ Ljt 勿忘初心 无畏未来 作为一个初学者&#xff0c;水平有限&#xff0c;欢迎交流指正。 在R中线性回归&#xff0c;一般使用lm函数就可以得到线性回归模型&#xff0c;但是得到的模型…

CSS属性(根据继承性分为两类)

一、可继承属性 1》所有标签可继承&#xff1a; visibility:行高 cursor: 2》内联标签可继承&#xff1a; line-height:行高 color:文字颜色 font-family:文字字体 font-size:文字大小 font-weight:文字加粗 text-decoration:文字下划线 3》块级标签可继承&#xff1a; text-in…

妙趣横生的算法--栈和队列

栈 栈的特点是先进后出&#xff0c;一张图简单介绍一下。 #include "stdio.h" #include "math.h" #include "stdlib.h" #define STACK_INIT_SIZE 20 #define STACKINCRE…

win10系统开不了机

电脑装了双系统&#xff0c;从ubuntu切回win10系统后&#xff0c;win10系统开不了机&#xff0c;一直转圈&#xff0c;修复结果是什么C:\WINDOWS\System32\Logfiles\Srt\SrtTrail.txt问题&#xff0c;是了网上的常用方法都没成功。 最后我的解决方案&#xff1a;强制关机后开机…

Android SDK打包

2015年6月18日 14:38:49 星期四 eclipse: 1. 将写好的代码上传版本库 2. 删除 /bin/* 3. eclipse->project->clean... 4. 上一步自动生成 /bin/xx.jar 5. 复制/bin/xx.jar 到 /libs/xx.jar 6. 删除 /src/* 7. 连同demo和刚才的工程文件夹压缩给到对方(这样可以避免包命…

MySQL 5.7.11 重置root密码

1.修改/etc/my.conf&#xff0c;添加参数skip-grant-tables 2.重启mysql service mysqld stop service mysqld start 3.用root 直接登录 [rootbogon ~]# mysql -uroot Welcome to the MySQL monitor. Commands end with ; or \g. Your MySQL connection id is 4 Server versio…

resure挽救笔记本系统和一些相关的操作记录

使用fedora23很久了, 但是感觉不是很流畅, 出现了一些不太稳定的体验, 所以想改到centos7. 因为centos7的很多东西 跟 fedora23 很相近了. 所以应该是无缝过渡是选择32位的系统还是选择64位的系统?还是要使用 32位的 它是90%的人的选择使用, 是普通人的通用选择, 几乎支持linu…

2021-06-08

opencv无法读取mp4文件opencv读取mp4文件时&#xff0c;总是VideoCapture.isopen()返回0,即无法打开cap。解决方法&#xff0c;将opencv安装包的opencv_videoio_ffmpeg451_64文件复制进工程中。

Web网页布局的主要方式

一、静态布局&#xff08;static layout&#xff09; 即传统Web设计&#xff0c;网页上的所有元素的尺寸一律使用px作为单位。 1、布局特点 不管浏览器尺寸具体是多少&#xff0c;网页布局始终按照最初写代码时的布局来显示。常规的pc的网站都是静态&#xff08;定宽度&#xf…

HDU 3966 Aragorn's Story (树链点权剖分,成段修改单点查询)

题目链接&#xff1a;http://acm.hdu.edu.cn/showproblem.php?pid3966 树链剖分的模版&#xff0c;成段更新单点查询。熟悉线段树的成段更新的话就小case啦。 1 //树链剖分 边权修改 单点查询2 #include <iostream>3 #include <cstring>4 #include <algorithm&…

微信分享无响应的解决

微信分享无响应的解决 最近使用友盟的社会化分享&#xff0c;集成到程序中进行分享功能的开发。 可是一开始还是可以正常使用&#xff0c;今天突然发现微信分享&#xff08;好友分享和朋友圈分享&#xff09;均是点击没有响应&#xff0c;也就是点击后&#xff0c;没有任何回馈…

x64电脑连接x32共享打印机

下载64位打印机驱动到64位电脑&#xff0c;在连接32位共享打印机出错时出现在本地寻找相关inf文件&#xff0c;此时将64位打印机驱动解压(不在64位本地安装)并找到相应inf文件&#xff0c;载入即可连接成功。

HTML中的br标签讲解(菜鸟)

br标签&#xff1a;如何在HTML中换行&#xff1f;可以使用br标签 1.br标签作用&#xff1a;换行 2.br标签格式&#xff1a;<br/> 3.br标签的注意点&#xff1a; 3.1多个br标签可以连续使用&#xff0c;使用了多少个br标签就会换多少行 3.2由于HTML的作用就是用来给文本添…