如何用Json.NET实现一对多关系与ID引用的双向转换？

嘿，这个场景我之前在基于CouchDB的.NET项目里踩过类似的坑，咱们一步步来拆解优化方案：

针对你遇到的IoC注入和循环引用问题，我们可以结合依赖注入友好的自定义Json转换器 + Json.NET的循环引用控制来解决，同时更贴合CouchDB的文档存储特性。

1. 解决IoC注入问题：放弃Attribute式转换器，改用实例化转换器 #

[JsonConverter]属性的最大问题是无法通过构造函数注入依赖（它只能用无参构造实例化），所以我们需要把转换器从属性标记改为在JsonSerializer实例中注册，这样就能通过IoC容器注入你的DB类了。

实现支持依赖注入的转换器 #

先写一对通用的引用转换器，分别处理集合（一对多）和单个对象（一对一）：

// 基础接口：让所有需要关联的实体实现，统一ID属性
public interface IEntityWithId
{
    string Id { get; set; }
}

// 处理一对多的ID列表转换器
public class ReferenceListConverter<T> : JsonConverter where T : class, IEntityWithId
{
    private readonly IMyCouchDbService _dbService;

    // 通过构造函数注入DB服务，不再用静态方法
    public ReferenceListConverter(IMyCouchDbService dbService)
    {
        _dbService = dbService ?? throw new ArgumentNullException(nameof(dbService));
    }

    public override bool CanConvert(Type objectType)
    {
        return objectType == typeof(List<T>);
    }

    public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)
    {
        var entities = value as List<T>;
        writer.WriteStartArray();
        foreach (var entity in entities)
        {
            writer.WriteValue(entity.Id);
        }
        writer.WriteEndArray();
    }

    public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
    {
        var ids = serializer.Deserialize<List<string>>(reader);
        // 通过注入的DB服务加载实体，不再依赖静态方法
        return ids.Select(id => _dbService.GetById<T>(id)).ToList();
    }
}

// 处理一对一的单个ID转换器
public class ReferenceConverter<T> : JsonConverter where T : class, IEntityWithId
{
    private readonly IMyCouchDbService _dbService;

    public ReferenceConverter(IMyCouchDbService dbService)
    {
        _dbService = dbService;
    }

    public override bool CanConvert(Type objectType)
    {
        return objectType == typeof(T);
    }

    public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)
    {
        var entity = value as T;
        writer.WriteValue(entity?.Id);
    }

    public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
    {
        var id = serializer.Deserialize<string>(reader);
        return string.IsNullOrEmpty(id) ? null : _dbService.GetById<T>(id);
    }
}

在IoC容器中注册并配置MyCouch #

以SimpleInjector为例，先注册转换器和DB服务，然后把配置好的JsonSerializer传给MyCouch：

// 注册DB服务和转换器
container.Register<IMyCouchDbService, MyCouchDbService>(Lifestyle.Scoped);
container.Register<ReferenceListConverter<User>>(Lifestyle.Scoped);
container.Register<ReferenceConverter<Login>>(Lifestyle.Scoped);

// 配置JsonSerializer
var jsonSerializer = new JsonSerializer
{
    ContractResolver = new CamelCasePropertyNamesContractResolver(),
    // 先开启循环引用忽略，后续再优化
    ReferenceLoopHandling = ReferenceLoopHandling.Ignore
};

// 从容器获取转换器实例并添加到序列化器
jsonSerializer.Converters.Add(container.GetInstance<ReferenceListConverter<User>>());
jsonSerializer.Converters.Add(container.GetInstance<ReferenceConverter<Login>>());

// 把自定义序列化器传给MyCouch
var myCouchSettings = new MyCouchClientSettings("http://localhost:5984", "your-db")
{
    Serializer = new MyCouch.Serialization.JsonNetSerializer(jsonSerializer)
};
var myCouchClient = new MyCouchClient(myCouchSettings);

2. 解决循环引用问题：双向关联的序列化控制 #

当User和Login双向关联时，直接序列化会导致循环，我们有两种更优雅的处理方式：

方式一：选择性忽略反向关联的序列化 #

如果不需要在User中序列化Login的完整对象，可以给User的Login属性加[JsonIgnore]，但保留LoginId字段存关联ID：

public class User : IEntityWithId
{
    public string Id { get; set; }
    public string LoginId { get; set; }

    // 只用于反序列化后加载，不序列化到CouchDB
    [JsonIgnore]
    public Login Login { get; set; }
}

这种方式最直接，符合CouchDB文档“扁平化存储，用ID关联”的设计理念。

方式二：用转换器控制双向序列化 #

如果必须在User中保留Login的序列化（只存ID），可以给User的Login属性使用ReferenceConverter<Login>，同时结合ReferenceLoopHandling.Ignore，Json.NET会在检测到循环时自动跳过嵌套的关联对象，避免无限递归。

3. 关于Json.NET引用机制的适用性 #

Json.NET的PreserveReferencesHandling.Objects会生成$id和$ref标记，但这更适合同一文档内的对象引用，对于CouchDB跨文档的一对多关联，直接存储ID列表的方式更直观，也更符合NoSQL的设计思路——毕竟CouchDB不支持JOIN，后续查询关联数据还是要通过ID手动加载，存ID列表的可读性和可控性更强。

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