.Net自定义转换器JsonConverter如何使用

前端开发   发布日期:2025年04月07日   浏览次数:158

这篇“.Net自定义转换器JsonConverter如何使用”文章的知识点大部分人都不太理解,所以小编给大家总结了以下内容,内容详细,步骤清晰,具有一定的借鉴价值,希望大家阅读完这篇文章能有所收获,下面我们一起来看看这篇“.Net自定义转换器JsonConverter如何使用”文章吧。

场景描述

例如api返回了以下json串 (infcode的值有可能时string 也可能时number

  1. 有时候返回时这个
  2. {
  3. "infcode": -1,
  4. "detail_msg": null
  5. }
  6. 有时后也可能时这个
  7. {
  8. "infcode": "-1",
  9. "detail_msg": null
  10. }

本人之前在springboot开发的时候,使用的是fastjson,所以,只要在实体类定义属性为String,那么无论是number还是字符串,都会转换成String.

但是,到了.netcore这边的就不太管用了. 如果实体类定义是string, json字段是number的话.会抛出异常

  1. The JSON value could not be converted to System.String

默认的反序列的写法 (以下),会报错,不能直接将number转成string

实体类变量= JsonSerializer.Deserialize<实体类类型>(jsonString);

要想实现无论是number还是字符串, 都能够反序列化成功的话.这里就需要用到JsonConverter来实现了.这里介绍两种比较直观的写法

  • 通过JsonSerializerOptions参数,绑定JsonConverter来实现

  • 在实体类的属性上 增加JsonConverter注解来实现 (不确定在C#是不是叫注解,在java中是叫注解)

通过JsonSerializerOptions参数,绑定JsonConverter来实现

  • 这里新建一个类,例如取名为IntJsonConverter.cs .让其继承JsonConverter.

  • 然后重写Read方法.

  • 下面是关键部分代码

  1. public class IntJsonConverter : JsonConverter<string> //这里因为实体类的属性是string 这里就配置储层string
  2. {
  3. public override string? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
  4. {
  5. if (reader.TokenType == JsonTokenType.Number)
  6. {
  7. //这里就简单处理以下 如果时number, 转换为decimal后在toString即可
  8. return reader.GetDecimal().ToString();
  9. }
  10. else
  11. {
  12. return reader.GetString();
  13. }
  14. }
  15. }

4.然后再需要转换的地方 配置以下反序列化的选项JsonSerializerOptions

  1. var serializeOptions = new JsonSerializerOptions
  2. {
  3. WriteIndented = true,
  4. };
  5. serializeOptions.Converters.Add(new IntJsonConverter());
  6. fsiResponse = JsonSerializer.Deserialize<FsiResponse>(contentStream, serializeOptions);

5.这样就可以了

在实体类的属性上 增加JsonConverter注解来实现

  • 同样需要自定义一个JsonConverter类 ,同刚才的步骤.

  • 在实体类上,增加注解,只向这个转换器

  1. public class FsiResponse
  2. {
  3. [JsonConverter(typeof(IntJsonConverter))]
  4. public string? infcode { get; set; }

3.然后反序列化的时候, 按照默认的写法即可

  1. fsiResponse = JsonSerializer.Deserialize<FsiResponse>(contentStream);

以上就是.Net自定义转换器JsonConverter如何使用的详细内容,更多关于.Net自定义转换器JsonConverter如何使用的资料请关注九品源码其它相关文章!