我怎么知道一个类型是否可以使用Json.NET进行转换?

时间:2013-09-09 22:44:39

标签: c# .net json json.net datacontractjsonserializer

我正在尝试为内部存储数据的集合编写一个接口JObject

internal class JsonDataSet : IDataSet
{
    private JObject Document { get; set; }

    // The following methods are from the IDataSet interface
    public int Count { ... }
    public void Add<T>(string key, T value) { ... }
    public T GetItem<T>(string key) { ... }
    public bool ContainsKey(string key) { ... }
}

Add<T>方法中,如果自定义类型没有DataContract注释,我想提供一个有用的例外。例如,如果有人打电话:

dataSet.Add<IDictionary<string, IList<CustomType>>>(dict);

如果"Cannot serialize type 'CustomType'. DataContract annotations not found."没有正确的注释,它将抛出异常CustomType

到目前为止,我已经找到了一种方法来获取类型定义中的每个泛型参数,以便我可以检查它们:

private IEnumerable<Type> GetGenericArgumentsRecursively(Type type)
{
    if (!type.IsGenericType) yield return type;

    foreach (var genericArg in type.GetGenericArguments())
        foreach (var yieldType in GetGenericArgumentsRecursively(genericArg ))
            yield return yieldType;
}

并尝试实现这样的add方法:

public void Add<T>(string key, T value)
{
    foreach(var type in GetGenericArgumentsRecursively(typeof(T)))
    {
        if(!type.IsPrimitive && !Attribute.IsDefined(type, typeof(DataContractAttribute)))
            throw new Exception("Cannot serialize type '{0}'. DataContract annotations not found.", typeof(T));
    }

    Document.Add(new JProperty(key, JToken.Parse(JsonConvert.SerializeObject(value))));
}

我认为这适用于原始类型和自定义类型,但不适用于非泛型.NET类型,因为它们并非都有DataContract注释。有没有办法知道JsonConvert可以序列化哪些类型?

1 个答案:

答案 0 :(得分:6)

Json.NET支持几乎所有类型,甚至那些没有任何自定义属性的类型。支持的属性包括DataContract,JsonObject,Serializable。有许多方法可以让Json.NET包含序列化中的成员,并且有许多方法可以让它跳过。如果您无法序列化某些类,则更可能是由于缺少Data *属性以外的问题引起的:成员抛出异常,缺少构造函数,错误的转换器,可见性问题等。您的错误消息不太可能比由Json.NET。

如果你想事先测试,你必须从Json.NET复制疯狂的逻辑。检查类型和成员属性是不够的。只需验证用于属性的转换器,至少需要检查五个位置。即使您完成所有这些工作,也是不够的,因为在新版本中,Json.NET中将引入新类型或转换器或功能或属性,您将不得不再次执行所有这些操作。

测试类型可以序列化的唯一可靠方法是尝试序列化它。