C#怎么在XML序列化时忽略某个属性 [XmlIgnore]-XML/RSS教程-PHP中文网

C#怎么在XML序列化时忽略某个属性 [XmlIgnore]

月夜之吻

发布： 2025-12-14 21:08:03

原创

824人浏览过

在C#中，跳过属性XML序列化的最直接方式是使用[XmlIgnore]特性，仅对public属性或字段生效，无法动态条件忽略；需动态控制时可用ShouldSerializeXXX()方法。

c#怎么在xml序列化时忽略某个属性 [xmlignore]

在 C# 中，使用 XmlSerializer 进行 XML 序列化时，若想**跳过某个属性不参与序列化**，最直接的方式就是在该属性上加上 [XmlIgnore] 特性。

1. 基本用法：给属性加 [XmlIgnore]

只需在要忽略的属性前添加 [XmlIgnore] 特性即可。注意：它只能作用于**公共字段或属性**（private 成员加了也无效）。

示例：

public class Person
{
    public string Name { get; set; }
    public int Age { get; set; }
<pre class="brush:php;toolbar:false;">[XmlIgnore]
public string InternalCode { get; set; } // 不会出现在 XML 中

登录后复制

}

序列化后生成的 XML 将只包含 Name 和 Age，InternalCode 被完全跳过。

Musho

AI网页设计Figma插件

查看详情

2. 注意事项与常见问题

不能用于私有字段：XmlSerializer 只序列化 public 成员，private 字段即使没加 [XmlIgnore] 也不会被序列化；加了也无意义。
不支持条件性忽略：[XmlIgnore] 是静态标记，无法根据运行时值动态决定是否忽略（如“仅当值为 null 时忽略”需换其他方式，比如用 ShouldSerializeXXX 模式）。
与 [JsonIgnore] 不同：这是专用于 XmlSerializer 的特性，对 JsonSerializer（如 System.Text.Json）无效；JSON 忽略要用 [JsonIgnore] 或 [JsonProperty(DefaultValueHandling = DefaultValueHandling.Ignore)] 等。

3. 替代方案：ShouldSerializeXXX 模式（按需忽略）

如果需要**根据逻辑条件决定是否序列化**某个属性（比如值为空时不输出），可以配合布尔方法 ShouldSerializeXXX() 使用：

public class Person
{
    public string Name { get; set; }
    public int Age { get; set; }
    public string Nickname { get; set; }
<pre class="brush:php;toolbar:false;">public bool ShouldSerializeNickname()
{
    return !string.IsNullOrWhiteSpace(Nickname);
}

登录后复制

}

XmlSerializer 会自动查找名为 ShouldSerialize + 属性名 的 public bool 方法，返回 false 时跳过该属性。