时间戳

首页 > 解决方案 > C# XmlSerializer DefaultAttribute 属性仍然为 nullables 序列化

c# - C# XmlSerializer DefaultAttribute 属性仍然为 nullables 序列化

问题描述

我想减少序列化输出中的混乱，为经常相同或不使用的属性引入默认值。

但是，它们仍然在输出中。我究竟做错了什么？

这应该是完整的（虽然没有编译）：

[Serializable]
public class MyClass
{
    [DefaultValue(null)]
    public string Alias { get; set; } = null;

    [DefaultValue(false)]
    public bool Deactivated { get; set; } = false;

    [DefaultValue(null)]
    public bool? MyNullable { get; set; } = null;
}

public static string SerializeFromObject<T>(this T toSerialize)
{
    var xmlSerializer = new XmlSerializer(toSerialize.GetType());
    using (StringWriter textWriter = new StringWriter())
    {
        xmlSerializer.Serialize(textWriter, toSerialize);
        return textWriter.ToString();
    }
}

var myClass = new MyClass();
var str = SerializeFromObject(myClass);

这里是 xml 输出，仍然包括可为空的：

<?xml version="1.0" encoding="utf-16"?>
<MyClass xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <MyNullable xsi:nil="true" />
</MyClass>

如何摆脱序列化 xml 中的可空值？

标签： c#xmlxml-serializationdefault-valuexmlserializer

解决方案

Self的回答非常有帮助，但最后还是出现了一些问题，所以我没有遵循它。稍后我将在此处概述它以供后代使用，因此它不会在评论中或通过离线链接丢失。

我自己的解决方案：

使用标准的 .net xml 序列化，将序列化的字符串重新读入 XElement，删除所有“nil”。然后 .ToString() 再次。

绝对是一个中等好的解决方案，所以请随时提出更好的解决方案。

建议的条件序列化对我来说意味着太多我想避免的额外代码。

我的解决方案还有一个缺点，即不能为 nullables 指定 DefaultValues，它们在为 null 时总是被省略。不过这对我来说很好。当我没有默认值时，我使用 nullable。

    /// <summary>
    /// use for compact serializations
    /// nullables that don't have a value are omitted (irrespecitve of DefaultValue!)
    /// </summary>
    /// <typeparam name="T"></typeparam>
    /// <param name="toSerialize"></param>
    /// <returns></returns>
    public static string SerializeFromObject_NoNils<T>(T toSerialize)
    {
        var ele = Serialize<T>(toSerialize);
        void removeNils(XNode node)
        {
            // recursion
            if (node is XElement elem)
            {
                foreach (var child in elem.DescendantNodes())
                    removeNils(child);
                //foreach (var child in elem.Descendants())
                //    removeNils(child);
            }

            // same level
            while (node != null)
            {
                var nextnode = node.NextNode;
                //if (node.)
                if ((node as System.Xml.Linq.XElement)?.Attribute("{http://www.w3.org/2001/XMLSchema-instance}nil")?.Value == "true")
                    node.Remove();
                node = nextnode;
            }
        }

        removeNils(ele.FirstNode);
        return ele.ToString();
    }

如果有人想建立或改进 Self 的答案 - 这有一个缺点，即 DefaultValue 属性似乎不起作用（它似乎适用于 default(type) 而不是该属性），这里是从他的链接复制/粘贴的，添加了一个空的命名空间，因为默认的 .net 反序列化会偶然发现 DataSerializerContract 命名空间。

所以，这不是我的代码，归功于用户 Self。

using System;
using System.Collections.Generic;
using System.Linq;

using System.IO;
using System.Xml;
using System.Xml.Serialization;
using System.ComponentModel;

using System.Runtime.Serialization;

public class Program
{
    public static void Main()
    {

        var myClass = new MyClass();
        var str_dc = DataContract_SerializeFromObject(myClass);
        str_dc.Dump();
        
        
        var str_xml = SerializeFromObject(myClass);
        str_xml.Dump();
    }


    public static string SerializeFromObject<T>( T toSerialize)
    {
        var xmlSerializer = new XmlSerializer(toSerialize.GetType());
        using (StringWriter textWriter = new StringWriter())
        {
            xmlSerializer.Serialize(textWriter, toSerialize);
            return textWriter.ToString();
        }
    }

    public static string DataContract_SerializeFromObject<T>( T toSerialize)
    {
        var xmlSerializer = new DataContractSerializer(toSerialize.GetType());
        
        using (var output = new StringWriter())
        using (var writer = new XmlTextWriter(output) { Formatting = Formatting.Indented })
        {
            xmlSerializer.WriteObject(writer, toSerialize);
            return output.GetStringBuilder().ToString();
        }
    }
}

[DataContract(Namespace = "")] // default namespace is not deserializable with standard functionality   
[Serializable]
public class MyClass
{
    [DataMember(EmitDefaultValue = false)] [DefaultValue(null)]
    public string Alias { get; set; } = null;

    [DataMember(EmitDefaultValue = false)] [DefaultValue(false)]
    public bool Deactivated { get; set; } = false;

    [DataMember(EmitDefaultValue = false)] [DefaultValue(null)]
    public bool? MyNullable { get; set; } = null;
}

推荐阅读