Persistência e serialização de dados em funções duráveis (Azure Functions)

Lógica de serialização padrão

O Durable Functions for .NET em processo usa internamente Json.NET para serializar dados de orquestração e entidade para JSON. As configurações de Json.NET padrão usadas são:

Entradas, saídas e estado:

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

Exceções:

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

Leia a documentação mais detalhada aqui JsonSerializerSettings .

Personalizando a serialização com atributos .NET

Durante a serialização, Json.NET procura vários atributos em classes e propriedades que controlam como os dados são serializados e desserializados do JSON. Se você possui o código-fonte do tipo de dados passado para APIs de Funções Duráveis, considere adicionar esses atributos ao tipo para personalizar a serialização e a desserialização.

Personalizando a serialização com injeção de dependência

Os aplicativos de função destinados ao .NET e executados no tempo de execução do Functions V3 podem usar a DI (Injeção de Dependência) para personalizar como os dados e as exceções são serializados. O código de exemplo a seguir demonstra como usar DI para substituir as configurações de serialização de Json.NET padrão usando implementações personalizadas das IMessageSerializerSettingsFactory interfaces e IErrorSerializerSettingsFactory de serviço.

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 isolado e System.Text.Json

As Funções Duráveis em execução no processo de trabalho isolado do .NET usam o mesmo serializador de objeto configurado globalmente para seu aplicativo Azure Functions (consulte WorkerOptions). Este serializador passa a ser System.Text.Json por padrão em vez de Newtonsoft.Json. Quaisquer alterações serão WorkerOptions.Serializer aplicadas transitoriamente às Funções Duráveis.

Para obter mais informações sobre o suporte interno para serialização JSON no .NET, consulte a serialização e desserialização JSON na documentação de visão geral do .NET.

Lógica de serialização e desserialização

Os aplicativos do nó do Azure Functions são usados JSON.stringify() para serialização e JSON.Parse() desserialização. A maioria dos tipos deve serializar e desserializar perfeitamente. Nos casos em que a lógica padrão é insuficiente, a definição de um toJSON() método no objeto sequestrará a lógica de serialização. No entanto, não existe nenhum analógico para a desserialização de objetos.

Para personalização completa do pipeline de serialização/desserialização, considere lidar com a serialização e desserialização com seu próprio código e passar dados como cadeias de caracteres.

Lógica de serialização e desserialização

É recomendável usar anotações de tipo para garantir que o Durable Functions serialize e desserialize seus dados corretamente. Enquanto muitos tipos internos são manipulados automaticamente, alguns tipos de dados internos exigem anotações de tipo para preservar o tipo durante a desserialização.

Para tipos de dados personalizados, você deve definir a serialização JSON e a desserialização de um tipo de dados exportando um método estático to_json e from_json de sua classe.

O Java usa as bibliotecas Jackson v2.x para serialização e desserialização de cargas úteis de dados. Você pode usar anotações Jackson em seus tipos POJO para personalizar o comportamento de serialização.