Datenpersistenz und Serialisierung in Durable Functions (Azure Functions)

Standardserialisierungslogik

Durable Functions für .NET verwendet im Prozess Json.NET zum Serialisieren von Orchestrierungs- und Entitätsdaten in JSON. Die standardmäßigen Json.NET einstellungen sind:

Eingaben, Ausgaben und Zustand:

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

Ausnahmen:

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

Eine ausführlichere Dokumentation zu JsonSerializerSettings finden Sie hier.

Anpassen der Serialisierung mit .NET Attributen

Während der Serialisierung sucht Json.NET nach verschiedenen Attributen an Klassen und Eigenschaften, die steuern, wie die Daten serialisiert und aus JSON deserialisiert werden. Wenn Sie den Quellcode für den an Durable Functions APIs übergebenen Datentyp besitzen, sollten Sie diese Attribute dem Typ hinzufügen, um die Serialisierung und Deserialisierung anzupassen.

Anpassen der Serialisierung per Abhängigkeitsinjektion

Funktions-Apps, die auf .NET abzielen und auf der Funktions-V3-Laufzeit ausgeführt werden, können Dependency Injection (DI) verwenden, um anzupassen, wie Daten und Ausnahmen serialisiert werden. Im folgenden Beispielcode wird die Verwendung von DI zum Überschreiben der Standard-Json.NET Serialisierungseinstellungen mithilfe von benutzerdefinierten Implementierungen der IMessageSerializerSettingsFactory und IErrorSerializerSettingsFactory-Dienstschnittstellen veranschaulicht.

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 Isolated und System.Text.Json

Durable Functions, die im .NET isolierten Arbeitsprozess ausgeführt werden, verwenden denselben Objekt-Serialisierer, der global für Ihre Azure Functions-App konfiguriert ist (siehe WorkerOptions). Dieses Serialisierungsmodul ist standardmäßig System.Text.Json und nicht Newtonsoft.Json. Alle Änderungen an WorkerOptions.Serializer gelten transitiv für Durable Functions.

Weitere Informationen zur integrierten Unterstützung der JSON-Serialisierung in .NET finden Sie in der JSON-Serialisierung und Deserialisierung in .NET Übersichtsdokumentation.

Serialisierungs- und Deserialisierungslogik

Azure Functions Node-Anwendungen verwenden JSON.stringify() für die Serialisierung und JSON.Parse() für deserialisierung. Die meisten Typen sollten nahtlos serialisiert und deserialisiert werden. Falls die Standardlogik unzureichend ist, können Sie die Serialisierungslogik durch Definieren einer toJSON()-Methode im Objekt überschreiben. Jedoch existiert für die Objektdeserialisierung kein entsprechendes Analogon.

Für eine vollständige Anpassung der Serialisierungs-/Deserialisierungspipeline sollten Sie die Serialisierung und Deserialisierung mit Ihrem eigenen Code verarbeiten und die Daten dabei als Zeichenfolgen übergeben.

Serialisierungs- und Deserialisierungslogik

Es wird empfohlen, Typanmerkungen zu verwenden, um sicherzustellen, dass Durable Functions Ihre Daten ordnungsgemäß serialisiert und deserialisiert. Obwohl viele integrierte Typen automatisch verarbeitet werden, benötigen einige integrierte Datentypen Typanmerkungen, um den Typ während der Deserialisierung beizubehalten.

Für benutzerdefinierte Datentypen machen Sie die JSON-Serialisierung und -Deserialisierung möglich, indem Sie die Klassenmethoden to_json und from_json in Ihrer Datentypklasse definieren. Beachten Sie, dass diese Methoden nicht für den Rückgabewert der Orchestratorfunktion aufgerufen werden, was bedeutet, dass der Rückgabewert nativ JSON-serialisierbar sein muss. Weitere Informationen finden Sie unter "Bindungen".

Java verwendet die Jackson v2.x-Bibliotheken für die Serialisierung und Deserialisierung von Datennutzlasten. Sie können Jackson-Anmerkungen für Ihre POJO-Typen verwenden, um das Serialisierungsverhalten anzupassen.