如何使用 System.Text.Json 序列化 DateTimeOffset 为 Unix 时间戳

在 .NET 中，日期和时间通常使用 DateTime 或 DateTimeOffset 来表示。这两种数据类型都可以表示日期和时间，但它们之间有一些明显的区别。DateTime 是不带时区信息的，而 DateTimeOffset 是带时区偏移量的，可以用来表示一个特定的时刻。

在现代 web 应用中，我们经常需要将日期和时间数据序列化为 JSON 格式，以便在客户端和服务端之间进行通信。.NET 提供了多种方法来实现 JSON 序列化，其中 System.Text.Json 库是 .NET Core 3.0 以后推出的新型 JSON 序列化器，它比早期的 DataContractJsonSerializer 和 Newtonsoft.Json 更快，更轻量，并且提供了更为丰富的功能。

在本文中，我们将探讨如何在 System.Text.Json 中将 DateTimeOffset 序列化为时间戳。

代码示例

下面是一个简单的 .NET Core 控制台应用，它演示了如何使用 System.Text.Json 库将 DateTimeOffset 序列化为时间戳。

using System;
using System.Text.Json;

namespace JsonSerialization
{
    class Program
    {
        static void Main(string[] args)
        {
            // 创建一个 DateTimeOffset 对象
            var dateTimeOffset = new DateTimeOffset(2020, 10, 25, 10, 15, 0, TimeSpan.FromHours(8));

            // 序列化 DateTimeOffset 对象为 JSON
            var json = JsonSerializer.Serialize(dateTimeOffset, new JsonSerializerOptions
            {
                // 设置时间戳格式
                Converters = { new DateTimeOffsetConverter() }
            });

            // 输出结果
            Console.WriteLine(json);

            // 等待用户输入
            Console.ReadKey();
        }
    }

    // 定义 DateTimeOffset 转换器
    public class DateTimeOffsetConverter : JsonConverter<DateTimeOffset>
    {
        public override DateTimeOffset Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
        {
            return DateTimeOffset.FromUnixTimeMilliseconds(reader.GetInt64());
        }

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

运行结果如下：

1603592100000

可以看到，DateTimeOffset 对象已经被序列化为时间戳形式的 JSON 数据。

使用建议

在实际应用中，建议将 DateTimeOffsetConverter 类定义为一个单独的文件，例如 DateTimeOffsetConverter.cs，这样就可以轻松地在多个项目中复用该转换器。

另外，在实际项目中，可能需要对时间戳的格式进行进一步的自定义。

总结

本文介绍了如何使用 System.Text.Json 库将 DateTimeOffset 序列化为时间戳。实际应用中，序列化为时间戳可以使客户端更容易处理日期和时间数据，而且能够提高数据传输的效率。

参考资料

• System.Text.Json
• DateTimeOffset
• JsonConverter