如何将Azure持久化实体从函数式迁移至类式并兼容原有状态？

问题背景 #

Azure Functions中，类式Durable Entity与函数式实体的状态持久化格式存在明显差异：

• 类式实体：将状态直接序列化为JSON后存入state属性，最终格式为 {"state":"{\"Value\":1}"}
• 函数式实体：先将状态赋值到以状态类型命名的属性中再整体序列化，最终格式为 {"state":"{\"MyState\":{\"Value\":1}"}

当为了利用.NET依赖注入特性，将函数式Durable Entity重构为类式实体时，必须处理已持久化的函数式状态，才能保证类式实体正常读取历史状态。

解决方案 #

在类式实体读取状态时，添加兼容逻辑：先尝试直接反序列化到目标状态类型；如果失败，则按照函数式实体的格式解析，提取出内部的状态内容后再反序列化。

通用状态转换实现 #

下面是一个通用的状态反序列化方法，可同时支持两种格式的状态解析：

using System.Text.Json;
using System.Collections.Generic;
using System.Linq;

public static class EntityStateConverter
{
    public static T? DeserializeState<T>(string serializedState)
    {
        // 先尝试类式实体的直接反序列化
        try
        {
            return JsonSerializer.Deserialize<T>(serializedState, new JsonSerializerOptions(JsonSerializerDefaults.Web));
        }
        catch (JsonException)
        {
            // 失败则尝试解析函数式实体的包装格式
            var wrapper = JsonSerializer.Deserialize<Dictionary<string, T>>(serializedState, new JsonSerializerOptions(JsonSerializerDefaults.Web));
            return wrapper?.Values.FirstOrDefault();
        }
    }
}

在类式实体中使用 #

在类式Durable Entity的状态加载逻辑中，调用上述方法处理持久化的state字符串：

[JsonObject(MemberSerialization.OptIn)]
public class MyClassEntity : IMyEntity
{
    [JsonPropertyName("state")]
    public MyState CurrentState { get; set; } = new MyState(0);

    public void LoadState(string serializedState)
    {
        CurrentState = EntityStateConverter.DeserializeState<MyState>(serializedState) ?? new MyState(0);
    }

    // 其他实体操作方法...
}

record MyState(int Value);

验证测试 #

通过以下测试代码可以验证两种格式的状态都能被正确解析：

public class AzureFunctionTests(ITestOutputHelper output)
{
    [Fact]
    public void Deserialize_both_formats()
    {
        // 函数式实体的状态格式
        var functionStateJson = "{\"MyState\":{\"Value\":1}}";
        var stateFromFunction = EntityStateConverter.DeserializeState<MyState>(functionStateJson);
        output.WriteLine($"函数式状态解析结果：Value = {stateFromFunction?.Value}"); // 输出 1

        // 类式实体的状态格式
        var classStateJson = "{\"Value\":2}";
        var stateFromClass = EntityStateConverter.DeserializeState<MyState>(classStateJson);
        output.WriteLine($"类式状态解析结果：Value = {stateFromClass?.Value}"); // 输出 2
    }
}

内容的提问来源于stack exchange，提问作者Thomas Eyde