用于模型绑定自定义类型的方法

问题描述

我的 API 控制器有一个如下所示的端点：

public async Task<IActionResult> Update([FromBody] UpdateCommand command) { /* ... */ }

那个 command 看起来像这样：

public class UpdateCommand {
  public string Username { get; set; }
  public Id Id { get; set; }               // <--- here's the problem
}

那个 Id 是一个值对象，看起来像这样：

public class Id : SimpleValueObject<long> {
  // base class has: IComparable,equality,GetHashCode,etc.
  public Id(long value) : base(value) { }
  public Id(string value) : base(Parse(value)) { }
  private static long Parse(string value) { /* ... */ }
}

客户端会发送：

{
  "username": "foo","id": 1
}

现在我想让模型绑定自动工作。但我很困惑如何做到这一点。

我实现了 IModelBinder 和 IModelBinderProvider，但这没有帮助。然后我注意到文档 say this:

通常不应该用于将字符串转换为自定义类型，TypeConverter 通常是更好的选择。

所以我实现了一个 TypeConverter，但这也没有帮助。

然后我想实现一个 JsonConverter<T>，但该框架现在使用的不是 Newtonsoft 的东西，所以我没有走远。

所以我的问题是：我必须做什么来促进我的自定义类型的自动绑定。我只需要知道该走哪条路，剩下的我来想办法。

（作为一个附带问题：请帮助我理解什么时候应该实现模型绑定器、类型转换器和 json 转换器。）

解决方法

我仍然不明白何时使用自定义模型绑定器、自定义类型转换器和自定义 json 转换器。

但似乎针对这种情况的解决方案是自定义 JsonConverter<T>。

这对我有用：

public class IdConverter : JsonConverter<Id> {

  public override Id? Read(ref Utf8JsonReader reader,Type typeToConvert,JsonSerializerOptions options) {
    if (reader.TokenType is not JsonTokenType.String and not JsonTokenType.Number)
      throw new JsonException();
    try {
      if (reader.TokenType is JsonTokenType.String) {
        var value = reader.GetString();
        return new Id(value);
      }
      else {
        var value = reader.GetInt64();
        return new Id(value);
      }
    }
    catch {
      throw new JsonException();
    }
  }

  public override void Write(Utf8JsonWriter writer,Id value,JsonSerializerOptions options) =>
    writer.WriteNumberValue(value.Value);

}