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,
}

に関する詳細なドキュメントについては、こちらを参照してください。

.NET属性を使用したシリアル化のカスタマイズ

シリアル化中、Json.NET は、データを JSON にシリアル化およびデシリアル化する方法を制御するさまざまな属性をクラスやプロパティに探します。 Durable Functions API に渡されるデータ型のソース コードを所有している場合は、シリアル化と逆シリアル化をカスタマイズするために、これらの属性を型に追加することを検討してください。

依存関係の挿入によるシリアル化のカスタマイズ

.NETを対象とし、Functions V3 ランタイムで実行する関数アプリは、Dependency Injection (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 Isolated と System.Text.Json

.NET Isolated worker プロセス で実行されているDurable Functionsは、Azure Functions アプリ用にグローバルに構成されたのと同じオブジェクト シリアライザーを使用します (WorkerOptions を参照)。 このシリアライザーは、Newtonsoft.Json ではなく、既定で System.Text.Json になります。 WorkerOptions.Serializerへの変更は、Durable Functionsに推移的に適用されます。

.NETでの JSON シリアル化の組み込みサポートの詳細については、JSON のシリアル化と逆シリアル化.NET概要ドキュメントを参照してください。

シリアル化と逆シリアル化のロジック

Azure Functions Node アプリケーションでは、シリアル化に JSON.stringify()、逆シリアル化に JSON.Parse() を使用。 ほとんどの型は、シームレスにシリアル化および逆シリアル化する必要があります。 既定のロジックが不十分な場合は、 オブジェクトに対してメソッドを定義すると、シリアル化ロジックがハイジャックされます。 ただし、オブジェクトの逆シリアル化にはアナログは存在しません。

シリアル化/逆シリアル化パイプラインを完全にカスタマイズする場合は、独自のコードでシリアル化と逆シリアル化を処理し、データを文字列として渡すことを検討してください。

シリアル化と逆シリアル化のロジック

Durable Functionsがデータを正しくシリアル化およびデシリアライズするために、型注釈を使用することを推奨します。 多くの組み込み型は自動的に処理されますが、一部の組み込みデータ型では、逆シリアル化中に型を保持するために型の注釈が必要です。

カスタム・データ・タイプの場合、データ・タイプ・クラスでクラス・メソッド および を定義することにより、JSONシリアライゼーションおよびデシリアライゼーションを可能にします。 これらのメソッドは、オーケストレーター関数からの戻り値に対しては呼び出されないため、戻り値はネイティブに JSON シリアル化可能である必要があることに注意してください。 詳細については、「 バインディング」を参照してください。

Javaでは、Jackson v2.x ライブラリを使用して、データ ペイロードのシリアル化と逆シリアル化を行います。 POJO 型で Jackson 注釈を使用して、シリアル化の動作をカスタマイズできます。