如何用同一DataContract兼容单字符串与字符串数组的JSON响应？

调用某团队提供的REST API时，遇到两个端点返回结构相似但message字段类型不同的情况：

• 端点A返回的message是单个字符串：

{
  "message": "Hello World."
}

• 端点B返回的message是字符串数组：

{
  "message": [
    "Hello World.",
    "Hello StackOverflow."
  ]
}

希望用同一个DataContract兼容这两种响应，当前的DataContract代码如下：

[DataContract]
public class Response
{
  [DataMember(Name = "message")]
  public string Message { get; set; } // 改为string[]同样会报错
}

反序列化时触发错误：

There was an error deserializing the object of type Response. End element 'message' from namespace '' expected. Found element 'item' from namespace ''

完整调用代码：

string jsonPayload = "{ 'Random': 'Payload' }";
HttpClient myHttpClient = getHttpClient();
HttpResponseMessage responseMsg = await myHttpClient.PostAsync("myApiPath", new StringContent(jsonPayload));

DataContractJsonSerializer serializer = new DataContractJsonSerializer(typeof(Response));
string rspJson = await responseMsg.Content.ReadAsStringAsync();
MemoryStream ms = new MemoryStream(Encoding.UTF8.GetBytes(rspJson));
Response rsp = (Response)serializer.ReadObject(ms);

方法一：私有字段兼容双类型，公共属性统一输出 #

通过定义私有字段接收反序列化的原始数据（可能是单个字符串或数组），再通过公共属性对外提供统一的集合访问方式：

[DataContract]
public class Response
{
    // 私有字段映射message，兼容两种类型
    [DataMember(Name = "message")]
    private object _message;

    // 公共属性统一返回字符串列表
    public List<string> Messages
    {
        get
        {
            if (_message == null)
                return new List<string>();
            
            if (_message is string singleMsg)
                return new List<string> { singleMsg };
            
            if (_message is string[] arrayMsg)
                return arrayMsg.ToList();
            
            return new List<string>();
        }
    }
}

这种方式不需要修改序列化逻辑，完全依托DataContract的字段映射实现兼容，对外提供统一的访问接口。

方法二：自定义序列化代理处理类型转换 #

实现IDataContractSurrogate接口，让序列化器自动将单个字符串转为数组：

public class MessageSurrogate : IDataContractSurrogate
{
    public Type GetDataContractType(Type type) => type;

    public object GetDeserializedObject(object obj, Type targetType)
    {
        if (targetType == typeof(Response) && obj is Response response)
        {
            // 从私有字段获取原始值，转为数组
            var rawValue = obj.GetType().GetField("_message", System.Reflection.BindingFlags.NonPublic | System.Reflection.BindingFlags.Instance)?.GetValue(obj);
            if (rawValue is string singleMsg)
            {
                response.Message = new[] { singleMsg };
            }
            else if (rawValue is string[] arrayMsg)
            {
                response.Message = arrayMsg;
            }
        }
        return obj;
    }

    // 其余接口方法默认实现
    public object GetObjectToSerialize(object obj, Type targetType) => obj;
    public object GetCustomDataToExport(Type clrType, Type dataContractType) => null;
    public object GetCustomDataToExport(MemberInfo memberInfo, Type dataContractType) => null;
    public void GetKnownCustomDataTypes(System.Collections.ObjectModel.Collection<Type> customDataTypes) { }
    public Type GetReferencedTypeOnImport(string typeName, string typeNamespace, object customData) => null;
    public System.CodeDom.CodeTypeDeclaration ProcessImportedType(System.CodeDom.CodeTypeDeclaration typeDeclaration, System.CodeDom.CodeCompileUnit compileUnit) => typeDeclaration;
}

修改Response类为数组类型：

[DataContract]
public class Response
{
    public string[] Message { get; set; }

    // 私有字段用于映射
    [DataMember(Name = "message")]
    private object _message;
}

创建序列化器时传入代理：

var settings = new DataContractJsonSerializerSettings
{
    DataContractSurrogate = new MessageSurrogate()
};
DataContractJsonSerializer serializer = new DataContractJsonSerializer(typeof(Response), settings);

方法三：预处理JSON字符串 #

反序列化前将单个字符串格式的message替换为数组格式：

string rspJson = await responseMsg.Content.ReadAsStringAsync();

// 检测并替换单个字符串为数组
if (rspJson.Contains("\"message\": \"") && !rspJson.Contains("\"message\": ["))
{
    rspJson = rspJson.Replace("\"message\": \"", "\"message\": [\"")
                     .Replace("\",", "\"],").Replace("\"}", "\"]}");
}

MemoryStream ms = new MemoryStream(Encoding.UTF8.GetBytes(rspJson));
DataContractJsonSerializer serializer = new DataContractJsonSerializer(typeof(Response));
Response rsp = (Response)serializer.ReadObject(ms);

这种方式直接简单，但需注意JSON格式的准确性，适合场景单一的情况。

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