XmlIgnore的解释和使用

最新推荐文章于 2024-09-13 14:15:04 发布

原创最新推荐文章于 2024-09-13 14:15:04 发布 · 1.8k 阅读

3 ·

CC 4.0 BY-SA版权

C#xml序列化专栏收录该内容

1 篇文章

订阅专栏

本文深入探讨了XmlIgnore特性在.NET序列化过程中的作用，通过具体代码示例展示了如何使用此特性来控制序列化过程中字段的忽略，对于理解及应用.NET序列化机制具有较高的参考价值。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

XmlIgnore的解释和使用

在网上查看XmlIgnore这个标签的功能，有些解释是：“XmlIgnore是一个自定义属性，用来指明在序列化时是否序列化一个属性”，经过我在本地测试运行得到的结果，我觉得应该为：“XmlIgnore是一个自定义属性，用来指明在序列化时是否忽略序列化一个属性”，详情看代码：

using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Text;
using System.Xml.Serialization;

/// <summary>
/// [XmlIgnore]标签总结：英文单词Ignore的意思是忽略，顾名思义就是加上了这个标签的字段（属性）就不会被序列化，在代码中表现为attrs.XmlIgnore = true的时候被忽略
/// </summary>
namespace XMLIgnore_Student
{
    public class Group
    {
        public string GroupName;
        #region 位置 1
        //[XmlIgnore]  //位置 1
        #endregion
        public string Comments;
    }

    class Program
    {
        static void Main(string[] args)
        {
            //注释位置1和2，解注释位置3
            //结果如下：
            /*
                <?xml version="1.0" encoding="utf-8"?>
                <Group xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
                  <GroupName>.Net</GroupName>
                  <Comments>Microsoft .net 3.5</Comments>
                </Group>
             */
            //结论：GroupName和Comments字段都被序列化了
            //SerializeObject("xml_ignore1.xml");

            //注释位置2，解注释位置1和3
            //结果如下：
            /*
                <?xml version="1.0" encoding="utf-8"?>
                <Group xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
                  <GroupName>.Net</GroupName>
                </Group>
             */
            //结论：GroupName被序列化了，Comments没有被序列化
            //SerializeObject("xml_ignore2.xml");

            //注释位置1和3，解注释位置2
            //结果如下：
            /*
                <?xml version="1.0" encoding="utf-8"?>
                <Group xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
                  <Comments>Microsoft .net 3.5</Comments>
                </Group>    
             */
            //结论：Comments被序列化了，GroupName没有被序列化
            SerializeObject("xml_ignore3.xml");
        }

        public static XmlSerializer CreateOverrider()
        {
            //位置 2   ：通过代码来决定忽略哪个字段不序列化
            #region 位置 2
            XmlAttributeOverrides overr = new XmlAttributeOverrides();
            XmlAttributes attrs = new XmlAttributes();
            attrs.XmlIgnore = false;
            overr.Add(typeof(Group), "Comments", attrs);
            attrs = new XmlAttributes();
            attrs.XmlIgnore = true;
            overr.Add(typeof(Group), "GroupName", attrs);
            XmlSerializer serilizer = new XmlSerializer(typeof(Group), overr);
            #endregion

            //位置 3   ：直接序列化，忽不忽略哪些字段由类中的字段所标记的标签决定
            #region 位置 3
            //XmlSerializer serilizer = new XmlSerializer(typeof(Group));
            #endregion

            return serilizer;
        }

        public static void SerializeObject(string filename)
        {
            XmlSerializer serializer = CreateOverrider();
            Group group = new Group();
            group.GroupName = ".Net";
            group.Comments = "Microsoft .net 3.5";

            StreamWriter writer = new StreamWriter(filename);
            serializer.Serialize(writer, group);
            writer.Close();
        }
    }
}