C# XmlIgnore 与 JsonIgnore

在 C# 中，XmlIgnore 是一个属性，用于指示 XML 序列化器忽略某个类成员（如属性或字段）。当你不想让序列化器包括某个成员在 XML 文档中时，可以使用 XmlIgnore 属性。

使用 XmlIgnore 属性

XmlIgnore 是 System.Xml.Serialization 命名空间的一部分，可以应用于类的公共或受保护成员上。当序列化或反序列化一个对象时，标记了 XmlIgnore 的成员将不会出现在生成的 XML 中。

示例代码：

假设你有一个类 Person，并且你不希望序列化其中的 Notes 属性：

csharp

深色版本

1using System;
2using System.Xml.Serialization;
3
4public class Person
5{
6    public string Name { get; set; }
7    
8    [XmlIgnore]
9    public string Notes { get; set; }  // 这个属性将不会被序列化到XML中
10}
11
12class Program
13{
14    static void Main()
15    {
16        Person person = new Person
17        {
18            Name = "John Doe",
19            Notes = "This is a test note."
20        };
21
22        // 序列化对象
23        XmlSerializer serializer = new XmlSerializer(typeof(Person));
24        using (TextWriter writer = new StreamWriter("person.xml"))
25        {
26            serializer.Serialize(writer, person);
27        }
28
29        // 读取并反序列化对象
30        using (TextReader reader = new StreamReader("person.xml"))
31        {
32            Person deserializedPerson = (Person)serializer.Deserialize(reader);
33            Console.WriteLine(deserializedPerson.Name);  // 输出: John Doe
34        }
35    }
36}

在这个例子中，Notes 属性被 XmlIgnore 标记后，在序列化过程中不会被写入 XML 文件。同样，在反序列化时，也不会尝试从 XML 中读取该属性的值。

注意事项

• 兼容性: 如果其他系统依赖于这个属性来进行处理，则使用 XmlIgnore 可能会导致不一致的问题。
• 设计意图: XmlIgnore 主要用于那些不应暴露给序列化过程的内部属性或方法，比如用于业务逻辑而非数据持久化的属性。

总之，XmlIgnore 提供了一种方便的方式来控制哪些成员应该被序列化到 XML 中，这对于保护敏感数据或优化 XML 输出非常有用。然而，在使用时应当谨慎，确保不会影响到系统的正常工作流程。

JsonConvert XmlIgnore

在 C# 中，当你使用 Newtonsoft.Json（通常称为 Json.NET）进行 JSON 序列化和反序列化时，JsonIgnore 属性可以起到类似于 XmlIgnore 的作用，即指示序列化器忽略特定的属性或字段。

使用 JsonIgnore

在 Newtonsoft.Json 中，你可以使用 [JsonIgnore] 属性来指定哪些属性不应该被序列化到 JSON 中。这在某些情况下非常有用，比如当你有一个内部状态或临时变量，不希望它出现在 JSON 表示中。

示例代码：

csharp

深色版本

1using Newtonsoft.Json;
2
3public class Person
4{
5    public string Name { get; set; }
6    
7    [JsonIgnore]
8    public string Notes { get; set; }  // 这个属性将不会被序列化到JSON中
9}
10
11class Program
12{
13    static void Main()
14    {
15        Person person = new Person
16        {
17            Name = "John Doe",
18            Notes = "This is a test note."
19        };
20
21        // 序列化对象
22        string json = JsonConvert.SerializeObject(person);
23        Console.WriteLine(json);  // 输出: {"Name":"John Doe"}
24
25        // 反序列化对象
26        Person deserializedPerson = JsonConvert.DeserializeObject<Person>(json);
27        Console.WriteLine(deserializedPerson.Name);  // 输出: John Doe
28        Console.WriteLine(deserializedPerson.Notes);  // 输出: null
29    }
30}

在这个例子中，Notes 属性被 [JsonIgnore] 标记后，在序列化过程中不会被写入 JSON 字符串。同样，在反序列化时，不会从 JSON 中读取该属性的值，因此默认情况下该属性会被设为默认值（对于引用类型是 null，对于值类型是其默认值）。