Newtonsoft Json.NET InvalidCastException

Question

这更多的是一个技术支持问题，但newtonsoft.com网站表示stackoverflow是提问的最佳场所。

我有一个用6.0.3序列化的字符串，但用6.0.8反序列化失败。它抛出InvalidCastException。当我降级到6.0.3时，它反序列化fine；当我再次升级到6.0.8时，异常是可重复的。

编辑：

我没有发布10KB长的包含敏感信息的实际字符串，而是创建了一个简单的可复制测试用例来演示这个问题。

抛出异常的行是：

this.SomeStrings = (string[])infoEnum.Current.Value;

InvalidCastException表示"无法将‘Newtonsoft.Json.Linq.JObject’类型的对象强制转换为‘System.String[]’类型"

正如下面的评论中所提到的，我用6.0.3序列化了FooClass的一个实例，然后将该字符串硬编码到asdf（）方法中，并尝试反序列化。反序列化在6.0.3上成功，在6.0.8上以InvalidCastException失败。

显然，在下面这个琐碎的repro案例中，在FooClass上执行ISerializable是没有意义的，但在现实生活中，我需要在复杂的数据类型中使用ISerializble，该类型将自身序列化和反序列化为字符串数组；以下只是为了从学术上说明bug行为的再现。

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using Newtonsoft.Json;
using System.Runtime.Serialization;
namespace CBClasses
{
    [Serializable]
    public class FooClass : ISerializable
    {
        public string[] SomeStrings { get; set; }
        public FooClass() { }
        protected FooClass(SerializationInfo info, StreamingContext context)
        {
            if (info == null)
                throw new ArgumentNullException();
            SerializationInfoEnumerator infoEnum = info.GetEnumerator();
            while (infoEnum.MoveNext()) {
                SerializationEntry entry = infoEnum.Current;
                switch (entry.Name) {
                    case "SomeStrings":
                        this.SomeStrings = (string[])infoEnum.Current.Value;
                        break;
                    default:
                        throw new SerializationException("Deserialization failed on unhandled member '" + entry.Name + "'");
                }
            }
        }
        public virtual void GetObjectData(SerializationInfo info, StreamingContext context)
        {
            info.AddValue("SomeStrings", this.SomeStrings, this.SomeStrings.GetType());
        }
    }
    public class NewtonsoftDebugTest
    {
        private static JsonSerializerSettings settings = new JsonSerializerSettings() {
            TypeNameHandling = TypeNameHandling.All,
            Formatting = Formatting.Indented,
            PreserveReferencesHandling = PreserveReferencesHandling.Objects,
            ReferenceLoopHandling = ReferenceLoopHandling.Serialize
        };
        public static void asdf()
        {
            /* FooClass foo = new FooClass() { SomeStrings = new string[0] };
             * string serializedBy603 = JsonConvert.SerializeObject(foo, settings);
             * Resulted in:
             * 
             * {
             *   "$id": "1",
             *   "$type": "CBClasses.FooClass, CBClasses",
             *   "SomeStrings": {
             *     "$type": "System.String[], mscorlib",
             *     "$values": []
             *   }
             * }
             * 
             * Now hard-coded below:
             */
            string serializedBy603 = 
                "{n" + 
                "  "$id": "1",n" + 
                "  "$type": "CBClasses.FooClass, CBClasses",n" + 
                "  "SomeStrings": {n" + 
                "    "$type": "System.String[], mscorlib",n" + 
                "    "$values": []n" + 
                "  }n" + 
                "}n";
            FooClass deserialized = (FooClass)JsonConvert.DeserializeObject(serializedBy603, settings);
            System.Diagnostics.Debugger.Break();
        }
    }
}

Answer 1

我对此进行了一些调查，可以确认该问题首次出现在6.0.7版本中，并且在最新版本（截至本文撰写之时为9.0.1）中仍然可以重现。这一变化似乎是作为从2014年11月4日起"支持ISerializable对象的引用保存"承诺的一部分做出的。根据源代码差异，JsonSerializerInternalReader类的CreateISerializable()方法中的以下代码从此更改：

        if (reader.TokenType == JsonToken.StartObject)
        {
            // this will read any potential type names embedded in json
            object o = CreateObject(reader, null, null, null, contract, member, null);
            serializationInfo.AddValue(memberName, o);
        }
        else
        {
            serializationInfo.AddValue(memberName, JToken.ReadFrom(reader));
        }

到此：

        serializationInfo.AddValue(memberName, JToken.ReadFrom(reader));

很明显，以前的代码用于处理嵌入的类型元数据，而替换代码则没有。事实上，我可以确认，将这一段代码恢复到其原始状态可以解决问题。然而，在不知道这个更改的意图的情况下（也许元数据应该在代码中的其他地方处理？），我不建议盲目地恢复它，因为这可能会破坏其他东西。当前的序列化代码仍然像以前一样添加类型元数据（我得到了与问题中发布的相同的JSON），所以这似乎肯定是反序列化端的回归。如果你还没有，你可能想在GitHub上报告一个问题。（是的，我确实意识到这个问题已经存在一年半了；我只是想在这里提供一些结束语。；-）

作为一种变通方法，您可以从SerializationEntry中提取字符串数组，如下所示：

            this.SomeStrings = ((JObject)entry.Value)["$values"].ToObject<string[]>();