Сохраняемость и сериализация данных в Устойчивых функциях (Функции Azure)

Логика сериализации по умолчанию

Устойчивые функции для .NET внутри процессов используют JSON.NET для сериализации данных оркестрации и сущностей в JSON. Используются параметры Json.NET по умолчанию:

Входы, выходы и состояние:

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

Исключения.

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

Дополнительные сведения о JsonSerializerSettings см. здесь.

Настройка сериализации с помощью атрибутов .NET

Во время сериализации Json.NET ищет различные атрибуты классов и свойств, которые управляют сериализацией и десериализацией данных из JSON. Если вы владеете исходным кодом для типа данных, переданного API-интерфейсам Устойчивых функций, рассмотрите возможность добавления этих атрибутов к типу для настройки сериализации и десериализации.

Кастомизация сериализации с внедрением зависимостей

Приложения-функции, предназначенные для .NET и выполняемые в среде выполнения функции v3, могут использовать внедрение зависимостей (DI) для настройки сериализации данных и исключений. В следующем примере кода показано, как использовать DI для переопределения параметров сериализации Json.NET по умолчанию с помощью пользовательских реализаций интерфейсов служб IMessageSerializerSettingsFactory и 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 и System.Text.Json

Устойчивые функции, выполняющиеся в изолированном рабочем процессе .NET, используют тот же сериализатор объектов, настроенный глобально для приложения Azure Functions (см. WorkerOptions). Этот сериализатор по умолчанию является System.Text.Json , а не Newtonsoft.Json. Любые изменения WorkerOptions.Serializer будут транзитивно применены к Durable Functions.

Дополнительные сведения о встроенной поддержке сериализации JSON в .NET см. в обзорной документации по сериализации и десериализации JSON в .NET .

Логика сериализации и десериализации

Приложения узла Функций Azure используют JSON.stringify() для сериализации и JSON.Parse() для десериализации. Большинство типов должны беспрепятственно проходить сериализацию и десериализацию. В случаях, когда логика по умолчанию недостаточна, определение метода toJSON() для объекта будет перехватывать логику сериализации. Однако для десериализации объектов аналогов не существует.

Для полной настройки конвейера сериализации и десериализации рассмотрите возможность обработки сериализации и десериализации с помощью собственного кода и передачи данных в виде строк.

Логика сериализации и десериализации

Рекомендуется использовать аннотации типов, чтобы обеспечение сериализации и десериализации данных в Durable Functions происходило корректно. Хотя многие встроенные типы обрабатываются автоматически, некоторые встроенные типы данных требуют аннотаций типов для сохранения типа во время десериализации.

Для пользовательских типов данных сериализация и десериализация JSON возможна путем определения классовых методов to_json и from_json в вашем классе типов данных. Обратите внимание, что эти методы не применяются к возвращаемому значению функции оркестратора, то есть возвращаемое значение должно быть изначально сериализуемым в формате JSON. Дополнительные сведения см. в разделе "Привязки".

Для сериализации и десериализации данных в Java используются библиотеки Jackson версии 2.x. Для настройки поведения сериализации можно использовать заметки Джексона в типах POJO.