Durable Functions (Azure Functions) 中的数据保留和序列化

适用于 .NET（进程内）的 Durable Functions 在内部使用 Json.NET，以便将业务流程和实体数据序列化为 JSON。 使用的默认 Json.NET 设置是：

输入、输出和状态：

JsonSerializerSettings
{
    TypeNameHandling = TypeNameHandling.None,
    DateParseHandling = DateParseHandling.None,
}

异常：

JsonSerializerSettings
{
    ContractResolver = new ExceptionResolver(),
    TypeNameHandling = TypeNameHandling.Objects,
    ReferenceLoopHandling = ReferenceLoopHandling.Ignore,
}

在此处阅读有关 JsonSerializerSettings 的详细文档。

在序列化的过程中，Json.NET 在用于控制如何从 JSON 序列化和反序列化数据的类和属性上查找各种属性。 如果你拥有传递到 Durable Functions API 的数据类型的源代码，请考虑将这些特性添加到类型以自定义序列化和反序列化。

面向 .NET 并在 Functions V3 运行时上运行的函数应用可以使用依赖项注入 (DI) 来自定义数据和异常的序列化方式。 下面的示例代码演示了如何借助 DI 使用 IMessageSerializerSettingsFactory 和 IErrorSerializerSettingsFactory 服务接口的自定义实现来重写默认 Json.NET 序列化设置。

using Microsoft.Azure.Functions.Extensions.DependencyInjection;
using Microsoft.Azure.WebJobs.Extensions.DurableTask;
using Microsoft.Extensions.DependencyInjection;
using Newtonsoft.Json;
using System.Collections.Generic;

[assembly: FunctionsStartup(typeof(MyApplication.Startup))]
namespace MyApplication
{
    public class Startup : FunctionsStartup
    {
        public override void Configure(IFunctionsHostBuilder builder)
        {
            builder.Services.AddSingleton<IMessageSerializerSettingsFactory, CustomMessageSerializerSettingsFactory>();
            builder.Services.AddSingleton<IErrorSerializerSettingsFactory, CustomErrorSerializerSettingsFactory>();
        }

        /// <summary>
        /// A factory that provides the serialization for all inputs and outputs for activities and
        /// orchestrations, as well as entity state.
        /// </summary>
        internal class CustomMessageSerializerSettingsFactory : IMessageSerializerSettingsFactory
        {
            public JsonSerializerSettings CreateJsonSerializerSettings()
            {
                // Return your custom JsonSerializerSettings here
            }
        }

        /// <summary>
        /// A factory that provides the serialization for all exceptions thrown by activities
        /// and orchestrations
        /// </summary>
        internal class CustomErrorSerializerSettingsFactory : IErrorSerializerSettingsFactory
        {
            public JsonSerializerSettings CreateJsonSerializerSettings()
            {
                // Return your custom JsonSerializerSettings here
            }
        }
    }
}

在 .NET 独立工作进程中运行的 Durable Functions 使用在全局级别上为 Azure Functions 应用配置的对象序列化程序（请参阅 WorkerOptions）。 默认情况下，此序列化程序是 System.Text.Json，而不是 Newtonsoft.Json。 对 WorkerOptions.Serializer 的任何更改都将以传递方式应用于Durable Functions。

有关 .NET 中 JSON 序列化的内置支持的详细信息，请参阅 .NET 中的 JSON 序列化和反序列化概述文档。

Azure Functions Node 应用程序使用 JSON.stringify() 进行序列化，使用 JSON.Parse() 进行反序列化。 大多数类型都会无缝地进行序列化和反序列化。 在默认逻辑不充分的情况下，在对象上定义 toJSON() 方法会劫持序列化逻辑。 但是，对于对象反序列化，不存在模拟。

若要对序列化/反序列化管道进行完全的自定义，请考虑使用你自己的代码来处理序列化和反序列化，并将数据作为字符串进行传递。

建议使用类型注解以确保 Durable Functions 正确地序列化和反序列化数据。 虽然许多内置类型是自动处理的，但是某些内置数据类型需要类型注解才能在反序列化期间保留类型。

对于自定义数据类型，必须通过从类中导出静态 to_json 和 from_json 方法来定义数据类型的 JSON 序列化和反序列化。

Java 使用 Jackson v2.x 库对数据有效负载进行序列化和反序列化。 可以在 POJO 类型上使用 Jackson 注释来自定义序列化行为。