[.Net Core 3.0+/.Net 5] System.Text.Json中时间格式化

• 2020 年 11 月 13 日
• 筆記
• .NET 5, .NET Core, c#, System.Text.Json

简介

.Net Core 3.0开始全新推出了一个名为System.Text.Json的Json解析库，用于序列化和反序列化Json，此库的设计是为了取代Json.Net(Newtonsoft.Json)

时间格式化的不足

System.Text.Json的优点就不说了，来说一下不完善的地方，毕竟一个新事物出来，不可能十全十美的，用的最多的就是时间的格式化

官方文档：在 System.Text.Json 中，具有内置支持的唯一格式是 ISO 8601-1:2019，因为它被广泛采用、意义明确并且可精确地进行往返。 若要使用任何其他格式，请创建自定义转换器

ISO 8601-1:2019通俗的说就是时间格式化为2020-11-11T21:08:18。ISO 8601-1:2019标准参考：ISO官网 | 百度百科 | wikipedia

但我们一般用的时候不想要这种格式，因为中间有一个T，前端处理起来很麻烦，最好还是返回指定的时间格式，例如：yyyy-MM-dd、yyyy-MM-dd HH:mm:ss。

解决方案

既然官方不内置提供指定时间格式化的方式，那就没办法了吗，查阅文档发现，虽然无法简单的实现功能，但是可以通过创建自定义转换器来实现相应功能

文档地址：微软官方文档

以下是一个自定义时间转化器的完整实现：

public class DateTimeConverterUsingDateTimeParse : JsonConverter<DateTime>
{
    public override DateTime Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
    {
        return DateTime.Parse(reader.GetString());
    }

    public override void Write(Utf8JsonWriter writer, DateTime value, JsonSerializerOptions options)
    {
        writer.WriteStringValue(value.ToString("yyyy-MM-dd HH:mm:ss"));
    }
}

使用

代码看起来非常简单是不是，只需要重写Read和Write，但是我们只是写了一个自定义转换器，怎么让它生效呢，请往下看：

JsonSerializer.Serialize()和JsonSerializer.Deserialize()方法都接受一个JsonSerializerOptions类型的配置项参数

在JsonSerializerOptions添加Converters就可以了

JsonSerializerOptions options = new JsonSerializerOptions()
{
    Converters.Add(new DateTimeConverterUsingDateTimeParse())
}

string jsonString = JsonSerializer.Serialize(data, options);

至此，我们已经实现使用System.Text.Json库指定时间格式字符串进行序列化和反序列化，你甚至可以把yyyy-MM-dd HH:mm:ss做成参数来更自由的指定格式化字符串

基准测试

但是凡事有利就有弊，官方文档也说得很清楚了：

使用自定义转换器与使用序列化程序的本机实现相比，此方法的性能大大降低

有人就想知道了，到底会影响多少性能呢，我进行了一项基准测试，序列化100000条数据，包含时间处理，模型如下：

public class Dto
{
    public string Name { get; set; }

    public string Phone { get; set; }

    public DateTime DateTime { get; set; }
}

BenchmarkDotNet=v0.12.1, OS=Windows 10.0.19042
Intel Core i7-6700K CPU 4.00GHz (Skylake), 1 CPU, 8 logical and 4 physical cores
.NET Core SDK=5.0.100-rc.2.20479.15
  [Host]     : .NET Core 3.1.9 (CoreCLR 4.700.20.47201, CoreFX 4.700.20.47203), X64 RyuJIT  [AttachedDebugger]
  DefaultJob : .NET Core 3.1.9 (CoreCLR 4.700.20.47201, CoreFX 4.700.20.47203), X64 RyuJIT

  System.Text.Json Version 5.0.0
  Newtonsoft.Json Version 12.0.3

结语

可以看到性能确实会有影响，但是可以忽略不计了，100000条才差10ms。

同时可以发现System.Text.Json性能是Newtonsoft.Json的两倍

推荐大家以后在满足需求的情况下尽量使用内置的System.Text.Json