Persistencia y serialización de datos en Durable Functions (Azure Functions)

Lógica de serialización predeterminada

Funciones duraderas para .NET en el proceso utilizan internamente Json.NET para serializar datos de orquestación y de entidades a JSON. La configuración predeterminada de Json.NET que se usa son:

Entradas, salidas y estado:

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

Excepciones:

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

Lea la documentación más detallada sobre aquí.

Personalización de la serialización con atributos de .NET

Durante la serialización, Json.NET busca atributos various en clases y propiedades que controlan cómo se serializan y deserializan los datos desde JSON. Si posee el código fuente del tipo de datos pasado a Durable Functions API, considere la posibilidad de agregar estos atributos al tipo para personalizar la serialización y la deserialización.

Personalización de la serialización con inserción de dependencias

Las aplicaciones de funciones destinadas a .NET y que se ejecutan en el entorno de ejecución de Functions V3 pueden usar Dependency Injection (DI) para personalizar cómo se serializan los datos y las excepciones. En el código de ejemplo siguiente se muestra cómo usar la inyección de dependencias para invalidar la configuración de serialización predeterminada de Json.NET mediante implementaciones personalizadas de las interfaces de servicio de IMessageSerializerSettingsFactory y IErrorSerializerSettingsFactory.

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 aislado y System.Text.Json

Durable Functions que se ejecuta en el proceso de trabajo aislado .NET usa el mismo serializador de objetos configurado globalmente para la aplicación de Azure Functions (consulte WorkerOptions). Este serializador es System.Text.Json de forma predeterminada, en lugar de Newtonsoft.Json. Los cambios en WorkerOptions.Serializer se aplicarán transitivamente a Durable Functions.

Para obtener más información sobre la compatibilidad integrada con la serialización JSON en .NET, consulte la documentación de información general sobre la serialización y deserialización de JSON en .NET.

Lógica de serialización y deserialización

Azure Functions las aplicaciones de Node usan JSON.stringify() para la serialización y JSON.Parse() para la deserialización. La mayoría de los tipos se deberían serializar y deserializar sin problemas. En los casos en los que la lógica predeterminada sea insuficiente, la definición de un método en el objeto secuestrará la lógica de serialización. Sin embargo, no existe ningún análogo para la deserialización de objetos.

Para la personalización completa de la canalización de serialización o deserialización, considere la posibilidad de controlar la serialización y deserialización con su propio código y pasar los datos como cadenas.

Lógica de serialización y deserialización

Se recomienda usar anotaciones de tipo para asegurarse de que Durable Functions serializa y deserializa los datos correctamente. Aunque muchos tipos integrados se controlan automáticamente, algunos tipos de datos integrados requieren anotaciones de tipo para conservar el tipo durante la deserialización.

Para los tipos de datos personalizados, puede hacer posible la serialización y deserialización de JSON definiendo los métodos de clase y en su clase de tipo de datos. Tenga en cuenta que no se llama a estos métodos en el valor devuelto de la función de orquestador, lo que significa que el valor devuelto debe ser de forma nativa serializable en JSON. Para obtener más información, consulte Enlaces.

Java usa las bibliotecas Jackson v2.x para la serialización y deserialización de cargas de datos. Puede usar anotaciones de Jackson en los tipos POJO para personalizar el comportamiento de serialización.