System.Text.Json 反序列化 uint

问题描述

所以看起来新的 Json 库不会反序列化（甚至序列化）UInt32 类型。在 MVC 应用程序中，以下内容在 POST 的有效负载中发送：

{
   "Overrides":{
      
   },"Directions":{
      "data1" : "data2"
   },"ModeId": "1782354543","TestNumber" : 10
}

它应该序列化的类是这样的：

public class Payload
    {
        public uint ModeId;
        public Dictionary<string,string> Directions{ get; set; } = new();
        public Dictionary<string,string> Overrides { get; set; } = new();
        public int TestNumber { get; set; }
    }

但是当收到请求时，ModeId 为 0。我尝试根据我发现的单元测试添加自定义转换器 here 像这样：

public class UIntConverter : JsonConverter<uint>
    {
        public override uint Read(ref Utf8JsonReader reader,Type typetoConvert,JsonSerializerOptions options)
        {
            if (reader.TokenType == JsonTokenType.String)
            {
                string stringValue = reader.GetString();
                if (uint.TryParse(stringValue,out uint x))
                {
                    return x;
                }
            }
            if (reader.TokenType == JsonTokenType.Number)
            {
                return reader.GetUInt32();
            }

            throw new JsonException();
        }

        public override void Write(Utf8JsonWriter writer,uint value,JsonSerializerOptions options)
        {
            writer.WriteNumberValue(value);
        }
    }

然后像这样注册：

services.AddControllers()
                .AddJsonoptions(options =>
                {
                    options.JsonSerializerOptions.WriteIndented = false;
                    options.JsonSerializerOptions.IgnoreNullValues = true;
                    options.JsonSerializerOptions.PropertyNamingPolicy = null;
                    options.JsonSerializerOptions.Encoder = JavaScriptEncoder.UnsafeRelaxedJsonescaping;
                    options.JsonSerializerOptions.Converters.Add(new JsonStringEnumConverter());
                    options.JsonSerializerOptions.Converters.Insert(options.JsonSerializerOptions.Converters.Count,new UIntConverter());

                });

我什至无法使用相同的转换器将我的类序列化为字符串。它只是忽略了 uid 属性。

var payload = new Payload()
{
   Directions = new Directions
   {
     {"data1","data2" }
   },ModeId = 1782354543,TestNumber = 10
}
//then try to serialize
var defaultJsonSerializerSettings = new JsonSerializerOptions()
        {
            IgnoreNullValues = true,WriteIndented = false,PropertyNamingPolicy = null,Encoder = JavaScriptEncoder.UnsafeRelaxedJsonescaping,Converters = { new UIntConverter()}            
        };
Serializer.Serialize(payload,typeof(Payload),defaultJsonSerializerSettings); 

它序列化所有内容，除了完全忽略的 uint 属性。

您对 uint 属性的序列化/反序列化有何建议/建议？

[更新]：问题在于我试图序列化/反序列化一个字段，而不是像答案中指出的那样使用公共访问器的属性。恰好该字段的类型为 uint。

解决方法

如果您使用的是 .NET 5，或者如果 - 正如@Jimi 指出的那样 - 安装 <PackageReference Include="System.Text.Json" Version="5.0.2" />，然后您可以使用 IncludeFields 和 AllowReadingFromString 选项：

var serializeOptions = new JsonSerializerOptions
{
    IncludeFields = true,NumberHandling = JsonNumberHandling.AllowReadingFromString
};

var p = JsonSerializer.Deserialize<Payload>(json,serializeOptions);

在 .NET5 之前，您需要将 ModeId 更改为属性。

---

顺便说一句。您可以在没有转换器的情况下处理 string/int：

public string ModeId {get; set}
public uint ModeIdParsed => uint.Parse(ModeId);

如果您需要保留 ModeId 名称，那么您可以

public class Payload
{
   [JsonPropertyName("ModeId")]
   public string modeId {get;set;}

   [JsonIgnore]
   public uint ModeId => uint.Parse(modeId);
}

不幸的是，在 3.1 中，您需要将字符串变体公开（反序列化私有变量可从 v5 中获得）。