我们为什么推荐在Json中使用string表示Number属性值？

Posted 2020-12-05 lonelyxmas

原文:我们为什么推荐在Json中使用string表示Number属性值？

在这篇简短的文章中，我将解释在使用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类型值(最大值2⁶³-1)会超过javascript的最大安全Number(2⁵³-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.Value.ToString(), 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());
});

• https://stackoverflow.com/questions/35709595/why-would-you-use-a-string-in-json-to-represent-a-decimal-number