哪种方法用于模型绑定自定义类型

Question

我的 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:

Typically shouldn't be used to convert a string into a custom type, a TypeConverter is usually a better option.

所以我实施了 TypeConverter，但也没有用。

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

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

（附带问题：请帮助我理解何时应该实施模型绑定器、类型转换器和 json 转换器。）

Answer 1

我仍然不明白何时使用自定义模型绑定器与自定义类型转换器与自定义 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);

}

哪种方法用于模型绑定自定义类型

Which approach to use for model binding a custom type

c#

typeconverter

model-binding

jsonconverter

asp.net-core-5.0