读写XML
|
XML形式 | 处理方法 | 补充说明 |
XmlElement | 定义一个属性 | 属性名与节点名字匹配 |
XmlAttribute | [XmlAttribute] 加到属性上 | |
InnerText | [XmlText] 加到属性上 | 一个类型只能使用一次 |
节点重命名 | 根节点:[XmlType("testClass")] 元素节点:[XmlElement("name")] 属性节点:[XmlAttribute("id")] 列表子元素节点:[XmlArrayItem("Detail")] 列表元素自身:[XmlArray("Items")] |
默认情况下,类型的所有公开的数据成员(属性,字段)在序列化时都会被输出, 如果希望排除某些成员,可以用[XmlIgnore]来指出,例如:
TestIgnore { [XmlIgnore] // 这个属性将不会参与序列化 public int IntValue { get; set; } public string StrValue { get; set; } public string Url; }
序列化调用代码:
TestIgnore c1 = new TestIgnore { IntValue = 3,21)">"Fish Li" }; c1.Url = "http://www.cnblogs.com/fish-li/"; string xml = Console.WriteLine(xml);
输出结果如下:
<?xml version="1.0" encoding="utf-8"?> <TestIgnore xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <Url>http://www.cnblogs.com/fish-li/</Url> <StrValue>Fish Li</StrValue> </TestIgnore>
前面的示例很奇怪,我明明先定义的StrValue,后定义的Url,可是在输出时的顺序并是我期望的。
如果你希望控制序列化的输出顺序,可以参考下面的示例代码(注意红色粗体文字):
XmlIgnore] // 这个属性将不会参与序列化 public int IntValue { get; set; } [XmlElement(Order = 1)] public string StrValue { get; set; } [Order = 2)] public string Url; }
最终的输出结果如下:
<?xml version="1.0" encoding="utf-8"?> <TestIgnore xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <StrValue>Fish Li</StrValue> <Url>http://www.cnblogs.com/fish-li/</Url> </TestIgnore>
由于种种原因,可能需要我们自己控制序列化和反序列化的过程, 对于这种需求, .net framework也是支持的,下面我来演示如何这个过程。
假如我现在有这样的类型定义:
TestClass { public string StrValue { get; set; } public List<int> List { get; set; } } public class ClassB1 { public TestClass Test { get; set; } }
测试代码:
TestClass test = new TestClass { StrValue = "Fish Li",175)">List<int> { 1,2,3,4,5 } }; ClassB1 b1 = new ClassB1 { Test = test }; string xml = XmlHelper.XmlSerialize(b1,21)">"-----------------------------------------------------"); ClassB1 b2 = ClassB1>(xml,21)">"StrValue: " + b2.Test.StrValue); foreach( int n in b2.Test.List ) Console.WriteLine(n);
此时程序的输出结果如下:
<?xml version="1.0" encoding="utf-8"?> <ClassB1 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <Test> <StrValue>Fish Li</StrValue> <List> <int>1</int> <int>2</int> <int>3</int> <int>4</int> <int>5</int> </List> </Test> </ClassB1> ----------------------------------------------------- StrValue: Fish Li 1 2 3 4 5
现在我可能会想:TestClass这个类太简单了,但它输出的XML长度复杂了点,能不能再短小一点,让网络传输地更快呢?
在这里,我想到了自定义序列化行为来实现,请看下面对TestClass的重新定义。
TestClass : IXmlSerializable { public string StrValue { get; set; } public List<int> List { get; set; } public System.Xml.Schema.XmlSchema GetSchema() { return null; } public void ReadXml(XmlReader reader) { StrValue = reader.GetAttribute("s"); string numbers = reader.ReadString(); if( string.IsNullOrEmpty(numbers) == false ) List = (from s in numbers.Split(new char[] { ',' },175)">StringSplitOptions.RemoveEmptyEntries) let n = int.Parse(s) select n).ToList(); } public void WriteXml(XmlWriter writer) { writer.WriteAttributeString("s",StrValue); writer.WriteString(string.Join(",",List.ConvertAll<string>(x => x.ToString()).ToArray())); } }
继续使用前面的测试代码,现在的输出结果如下:
<?xml version="1.0" encoding="utf-8"?> <ClassB1 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <Test s="Fish Li">1,2,3,4,5</Test> </ClassB1> ----------------------------------------------------- StrValue: Fish Li 1 2 3 4 5
很明显,现在的序列化结果要比以前的结果小很多。
而且,测试代码中的反序列化的显示也表明,我们仍然可以通过反序列化来读取它。
在前面的示例中,我们会发现有时很简单的XML在加了命名空间及声明头以后,结构变复杂了,内容也变长了。 有些人看到它们可能总是感觉非常别扭,例如:
能不能只显示成下面这样呢?<ClassB1> <Test s="Fish Li">1,5</Test> </ClassB1>答案是肯定的,按下面的方法修改本文的示例代码:
private static void XmlSerializeInternal(Stream stream,object o,175)">Encoding encoding) { if( o == null ) throw new ArgumentNullException("o"); if( encoding == null ) throw new "encoding"); XmlSerializer serializer = new XmlSerializer(o.GetType()); XmlWriterSettings settings = new XmlWriterSettings(); settings.Indent = true; settings.NewLineChars = "rn"; settings.Encoding = encoding; settings.IndentChars = " "; // 不生成声明头 settings.OmitXmlDeclaration = true; // 强制指定命名空间,覆盖默认的命名空间。 XmlSerializerNamespaces namespaces = new XmlSerializerNamespaces(); namespaces.Add(string.Empty,string.Empty); using( XmlWriter writer = XmlWriter.Create(stream,settings) ) { serializer.Serialize(writer,o,namespaces); writer.Close(); } }说明:去掉XML命名空间及声明头不影响反序列化。
回到顶部 XML的使用建议在服务端,C#代码中:
1. 建议不用使用低级别的XML API来使用XML,除非你是在设计框架或者通用类库。
2. 建议使用序列化、反序列化的方法来生成或者读取XML
3.当需要考虑使用XML时,先不要想着XML结构,先应该定义好数据类型。
4. 列表节点不要使用[XmlElement],它会让所有子节点【升级】,显得结构混乱。
5. 如果希望序列化的XML长度小一点,可以采用[XmlAttribute],或者指定一个更短小的别名。
6. 不要在一个列表中输出不同的数据类型,这样的XML结构的可读性不好。
7. 尽量使用UTF-8编码,不要使用GB2312编码。在客户端,JavaScript代码中,我不建议使用XML,而是建议使用JSON来代替XML,因为:
1. XML文本的长度比JSON要长,会占用更多的网络传输时间(毕竟数据保存在服务端,所以传输是免不了的)
2. 在JavaScritp中使用XML比较麻烦(还有浏览器的兼容问题),反而各种浏览器对JSON有非常好的支持。
点击此处下载示例代码
(编辑:李大同)
【声明】本站内容均来自网络,其相关言论仅代表作者个人观点,不代表本站立场。若无意侵犯到您的权利,请及时与联系站长删除相关内容!