我們為什麼推薦在Json中使用string表示Number屬性值？

有態度的小碼甲發表於2020-05-20
JSON

在這篇簡短的文章中，我將解釋在使用JSON傳輸資料時，為什麼浮點數或大十進位制值應表示為字串 。

long型別引發的詭異情況

長話短說，同事在利用swagger對接後端API時，詭異的發現swaggerUI中顯示的json屬性值並不是api返回的值。

[HttpGet]
public IActionResult QueryAsync()
{
   var testJson = new 
   {
       Id =  123123126964992223,
       Profile = "Please attention on Id",
   };
   return new JsonResult(testJson);
}

該API在swagger輸出：

{"Id": 123123126964992220,
 "Profile": "Please attention on Id"}

進一步從Chrome->[Network]->[Preview]、[Response payload]觀察到該long屬性值的差異。

直接給結論：部分long型別值(最大值263-1)會超過Javascript的最大安全Number(253-1)， 瀏覽器/前端 使用JSON.parse(123123126964992223)將不再保證準確性。

將JSON中的數字值作為字串傳輸的是為了消除傳輸中的精度丟失或歧義性。

JSON規範中未給數字指定精度，JSON解析器會自由選擇合適的數值精度。如果您的應用程式具有特定的精度要求，那麼在不同的JSON解析器可能不能正確表達精度。

另外部分long型別值(最大值263-1)會超過Javascript的最大安全Number(253 -1)， 前端json反序列化時也會出現錯誤。

stackoverflow有個解釋很贊：

覆寫.NET Core序列化框架，將long轉化為string

針對NewtonsoftJson編寫BigIntJsonConvert

 public class BigIntJsonConverter : JsonConverter<long>
    {
        public override long ReadJson(JsonReader reader, Type objectType, [AllowNull] long existingValue, bool hasExistingValue, JsonSerializer serializer)
        {
            var flag = long.TryParse(reader.ReadAsString(), out long num);
            return flag == true ? num : 0;
        }

        public override void WriteJson(JsonWriter writer, [AllowNull] long value, JsonSerializer serializer)
        {
            writer.WriteValue(value.ToString());
        }
    }
    
// 擷取自Startup.cs ConfigureServices函式    
  context.Services.AddMvc().AddNewtonsoftJson(options =>
{
    options.SerializerSettings.Converters.Add(new BigIntJsonConverter());
});

相關文章