如何在运行时参数化DataContract的Name属性实现XML反序列化

我调用第三方通用接口/api/foo（无法控制该接口），它返回对应实体的XML数据，路径中的foo可传入任意实体名称。示例响应如下：

调用api/foo1时的响应：

<foo1>
    <name>SomeValue</name>
    <id>101</id>
</foo1>

调用api/foo2时的响应：

<foo2>
    <name>SomeOtherValue</name>
    <id>205</id>
</foo2>

XML的根节点是请求路径中的foo参数，内部字段（name、id）固定，但实体名称由用户定义，没有预先固定的列表。

我尝试用DataContractSerializer和如下DataContract类反序列化：

[DataContract(Name = "foo1", Namespace = "")]
public class Foo
{
    [DataMember(Name = "name")] 
    public string Name { get; set; }
    
    [DataMember(Name = "id")] 
    public string Id { get; set; }
}

这段代码只能正确反序列化foo1，无法处理其他实体名称。请问能不能在运行时参数化DataContract的Name属性？我写了最小可复现示例，第一个断言正常，第二个失败：

[DataContract(Name = "foo1", Namespace = "")]
public class Foo
{
    [DataMember(Name = "name")] 
    public string Name { get; set; }
    
    [DataMember(Name = "id")] 
    public string Id { get; set; }
}

[Fact]
public void TestDeserialization()
{
     var foo1 = "<foo1>\n\t<name>SomeValue</name>\n\t<id>101</id>\n</foo1>";
     var foo2 = "<foo2>\n\t<name>SomeOtherValue</name>\n\t<id>205</id>\n</foo2>";
        
     var serializer = new DataContractSerializer(typeof(Foo));
     var objFoo1 = (Foo)serializer.ReadObject(XmlReader.Create(new StringReader(foo1)));
     var objFoo2 = (Foo)serializer.ReadObject(XmlReader.Create(new StringReader(foo2)));

     objFoo1.Name.Should().Be("SomeValue");
     objFoo2.Name.Should().Be("SomeOtherValue");
}

直接修改DataContract的Name属性在运行时做不到，但可以通过两种实用方式解决问题：

方法1：使用DataContractSerializer的重载构造函数 #

DataContractSerializer提供了重载构造函数，允许动态指定根节点名称和命名空间，无需依赖类上的DataContract特性的Name参数：

// 移除Foo类上的DataContract特性（或保留但忽略Name属性）
public class Foo
{
    [DataMember(Name = "name")] 
    public string Name { get; set; }
    
    [DataMember(Name = "id")] 
    public string Id { get; set; }
}

// 封装动态反序列化方法
public Foo DeserializeFoo(string xml, string rootNodeName)
{
    var serializer = new DataContractSerializer(
        typeof(Foo), 
        rootNodeName, 
        string.Empty); // 匹配接口返回的空命名空间
    using var reader = XmlReader.Create(new StringReader(xml));
    return (Foo)serializer.ReadObject(reader);
}

// 修改后的测试代码
[Fact]
public void TestDeserialization()
{
     var foo1 = "<foo1>\n\t<name>SomeValue</name>\n\t<id>101</id>\n</foo1>";
     var foo2 = "<foo2>\n\t<name>SomeOtherValue</name>\n\t<id>205</id>\n</foo2>";
        
     var objFoo1 = DeserializeFoo(foo1, "foo1");
     var objFoo2 = DeserializeFoo(foo2, "foo2");

     objFoo1.Name.Should().Be("SomeValue");
     objFoo2.Name.Should().Be("SomeOtherValue");
}

方法2：预处理XML替换根节点名称 #

如果不想修改序列化器的创建逻辑，可以先将XML的根节点替换为DataContract中指定的名称，再执行反序列化：

// 封装根节点替换方法
public string ReplaceRootNode(string xml, string targetRootName)
{
    var doc = XDocument.Parse(xml);
    if (doc.Root != null)
    {
        doc.Root.Name = XName.Get(targetRootName, doc.Root.Name.NamespaceName);
    }
    return doc.ToString();
}

// 修改后的测试代码
[Fact]
public void TestDeserialization()
{
     var foo1 = "<foo1>\n\t<name>SomeValue</name>\n\t<id>101</id>\n</foo1>";
     var foo2 = "<foo2>\n\t<name>SomeOtherValue</name>\n\t<id>205</id>\n</foo2>";
        
     var serializer = new DataContractSerializer(typeof(Foo));
     var objFoo1 = (Foo)serializer.ReadObject(XmlReader.Create(new StringReader(foo1)));
     // 替换foo2的根节点为foo1
     var modifiedFoo2 = ReplaceRootNode(foo2, "foo1");
     var objFoo2 = (Foo)serializer.ReadObject(XmlReader.Create(new StringReader(modifiedFoo2)));

     objFoo1.Name.Should().Be("SomeValue");
     objFoo2.Name.Should().Be("SomeOtherValue");
}

推荐方案 #

优先选择方法1，它无需修改XML原始内容，性能更优，也更贴合DataContractSerializer的设计逻辑。

内容的提问来源于stack exchange，提问作者Jorgoth