c# - 为什么 BinaryFormatter 可以序列化 Action<> 但 Json.net 不能

Question

尝试序列化/反序列化一个 Action<>。

我尝试#1 天真

JsonConvert.SerializeObject(myAction);
...
JsonConvert.Deserialize<Action>(json);

反序列化失败，说它无法序列化 Action。

尝试 #2

JsonConvert.DeserializeObject<Action>(ctx.SerializedJob, new JsonSerializerSettings {ConstructorHandling = ConstructorHandling.AllowNonPublicDefaultConstructor });

同样(大概)失败。

尝试#3然后我找到http://mikehadlow.blogspot.com/2011/04/serializing-continuations.html

这使用 BinaryFormatter。我将其放入(base64 将二进制编码为字符串)。第一次工作完美。

尝试 #4

然后我发现

https://github.com/DevrexLabs/Modules.JsonNetFormatter

这是 json.net 的 IFormatter 模块。连线，同样的失败 - 无法反序列化。

那么为什么 BinaryFormatter 可以做到而 Json.net 却不能呢？

编辑:

一般的回答是——“那是最愚蠢的事情”。让我展示一下我正在尝试做什么

MyJobSystem.AddJob(ctx=>
{
   // code to do
   // ......
}, DateTime.UtcNow + TimeSpan.FromDays(2));

即 - 在 2 天内执行此 lambda。

这对我来说很好用。使用二进制格式化程序。我很好奇为什么一个序列化基础设施可以做到而另一个不能。他们似乎对什么可以处理什么不能处理有相同的规则

Answer 1

原因 BinaryFormatter是(有时)能够往返 Action<T>是这样的代表被标记为 [Serializable] 并实现 ISerializable .

但是，仅仅因为委托(delegate)本身被标记为可序列化并不意味着它的成员可以被成功序列化。在测试中，我能够序列化以下委托(delegate):

Action<int> a1 = (a) => Console.WriteLine(a);

但试图序列化以下抛出一个 SerializationException :

int i = 0;
Action<int> a2 = (a) => i = i + a;

捕获的变量i显然被放置在一个不可序列化的编译器生成的类中，从而阻止了委托(delegate)的二进制序列化成功。

另一方面，Json.NET 无法往返 Action<T>尽管supporting ISerializable 因为它不支持通过 SerializationInfo.SetType(Type) 配置的序列化代理.我们可以确认 Action<T>正在通过以下代码使用此机制:

var iSerializable = a1 as ISerializable;
if (iSerializable != null)
{
    var info = new SerializationInfo(a1.GetType(), new FormatterConverter());
    var initialFullTypeName = info.FullTypeName;
    iSerializable.GetObjectData(info, new StreamingContext(StreamingContextStates.All));
    Console.WriteLine("Initial FullTypeName = \"{0}\", final FullTypeName = \"{1}\".", initialFullTypeName, info.FullTypeName);
    var enumerator = info.GetEnumerator();
    while (enumerator.MoveNext())
    {
        Console.WriteLine("   Name = {0}, objectType = {1}, value = {2}.", enumerator.Name, enumerator.ObjectType, enumerator.Value);
    }
}

运行时输出:

Initial FullTypeName = "System.Action`1[[System.Int32, mscorlib, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]", final FullTypeName = "System.DelegateSerializationHolder".
   Name = Delegate, objectType = System.DelegateSerializationHolder+DelegateEntry, value = System.DelegateSerializationHolder+DelegateEntry.
   Name = method0, objectType = System.Reflection.RuntimeMethodInfo, value = Void <Test>b__0(Int32).

注意 FullTypeName已更改为 System.DelegateSerializationHolder ？那是代理，Json.NET 不支持它。

这引出了一个问题，当一个委托(delegate)被序列化时究竟写出了什么？为了确定这一点，我们可以配置 Json.NET 来序列化 Action<T>类似于BinaryFormatter将通过设置

• DefaultContractResolver.IgnoreSerializableAttribute = false
• DefaultContractResolver.IgnoreSerializableInterface = false
• JsonSerializerSettings.TypeNameHandling = TypeNameHandling.All

如果我序列化a1使用这些设置:

var settings = new JsonSerializerSettings
{
    TypeNameHandling = TypeNameHandling.All,
    ContractResolver = new DefaultContractResolver
    {
        IgnoreSerializableInterface = false,
        IgnoreSerializableAttribute = false,
    },
    Formatting = Formatting.Indented,
};
var json = JsonConvert.SerializeObject(a1, settings);
Console.WriteLine(json);

然后生成如下JSON:

{
  "$type": "System.Action`1[[System.Int32, mscorlib]], mscorlib",
  "Delegate": {
    "$type": "System.DelegateSerializationHolder+DelegateEntry, mscorlib",
    "type": "System.Action`1[[System.Int32, mscorlib, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]",
    "assembly": "mscorlib, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089",
    "target": null,
    "targetTypeAssembly": "Tile, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null",
    "targetTypeName": "Question49138328.TestClass",
    "methodName": "<Test>b__0",
    "delegateEntry": null
  },
  "method0": {
    "$type": "System.Reflection.RuntimeMethodInfo, mscorlib",
    "Name": "<Test>b__0",
    "AssemblyName": "Tile, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null",
    "ClassName": "Question49138328.TestClass",
    "Signature": "Void <Test>b__0(Int32)",
    "MemberType": 8,
    "GenericArguments": null
  }
}

替换 FullTypeName不包括在内，但其他一切都包括在内。正如您所见，它实际上并没有存储委托(delegate)的 IL 指令；它存储要调用的方法的完整签名，包括隐藏的、编译器生成的方法名称 <Test>b__0在 this answer 中提到.您可以通过打印 a1.Method.Name 自己看到隐藏的方法名称。 .

顺便说一句，确认Json.NET确实保存了与BinaryFormatter相同的成员(member)数据。 , 你可以序列化 a1二进制并打印任何嵌入的 ASCII 字符串，如下所示:

var binary = BinaryFormatterHelper.ToBinary(a1);
var s = Regex.Replace(Encoding.ASCII.GetString(binary), @"[^\u0020-\u007E]", string.Empty);
Console.WriteLine(s);
Assert.IsTrue(s.Contains(a1.Method.Name)); // Always passes

使用扩展方法:

public static partial class BinaryFormatterHelper
{
    public static byte[] ToBinary<T>(T obj)
    {
        using (var stream = new MemoryStream())
        {
            new System.Runtime.Serialization.Formatters.Binary.BinaryFormatter().Serialize(stream, obj);
            return stream.ToArray();
        }
    }
}

这样做会产生以下字符串:

????"System.DelegateSerializationHolderDelegatemethod00System.DelegateSerializationHolder+DelegateEntry/System.Reflection.MemberInfoSerializationHolder0System.DelegateSerializationHolder+DelegateEntrytypeassemblytargettargetTypeAssemblytargetTypeNamemethodNamedelegateEntry0System.DelegateSerializationHolder+DelegateEntrylSystem.Action`1[[System.Int32, mscorlib, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]Kmscorlib, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089;Tile, Version=1.0.0.0, Culture=neutral, PublicKeyToken=nullQuestion49138328.TestClass<Test>b__0/System.Reflection.MemberInfoSerializationHolderNameAssemblyNameClassNameSignatureMemberTypeGenericArgumentsSystem.Type[]Void <Test>b__0(Int32)

断言永远不会触发，表明编译器生成的方法名称 <Test>b__0确实也存在于二进制文件中。

现在，这是可怕的部分。如果我修改我的 c# 源代码以创建另一个 Action<T>之前 a1 ，像这样:

// I inserted this before a1 and then recompiled: 
Action<int> a0 = (a) => Debug.WriteLine(a);

Action<int> a1 = (a) => Console.WriteLine(a);

然后重新构建并重新运行， a1.Method.Name更改为 <Test>b__1 :

{
  "$type": "System.Action`1[[System.Int32, mscorlib]], mscorlib",
  "Delegate": {
    "$type": "System.DelegateSerializationHolder+DelegateEntry, mscorlib",
    "type": "System.Action`1[[System.Int32, mscorlib, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]",
    "assembly": "mscorlib, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089",
    "target": null,
    "targetTypeAssembly": "Tile, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null",
    "targetTypeName": "Question49138328.TestClass",
    "methodName": "<Test>b__1",
    "delegateEntry": null
  },
  "method0": {
    "$type": "System.Reflection.RuntimeMethodInfo, mscorlib",
    "Name": "<Test>b__1",
    "AssemblyName": "Tile, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null",
    "ClassName": "Question49138328.TestClass",
    "Signature": "Void <Test>b__1(Int32)",
    "MemberType": 8,
    "GenericArguments": null
  }
}

现在，如果我反序列化 a1 的二进制数据从早期版本保存，返回为 a0 !因此，在您的代码库中的某处添加另一个委托(delegate)，或以其他明显无害的方式重构您的代码，可能会导致先前序列化的委托(delegate)数据损坏和失败，甚至可能在反序列化到您的软件的新版本。此外，除了恢复代码中的所有更改并且不再进行此类更改之外，这不太可能得到修复。

总而言之，我们发现序列化的委托(delegate)信息对于代码库中看似无关的更改来说非常脆弱。我强烈建议不要通过 BinaryFormatter 的序列化来持久化代表。或 Json.NET。相反，考虑维护一个命名委托(delegate)表并序列化名称，或者遵循 command pattern并序列化命令对象。