c#中通过自定义Converter实现定制DateTime的序列化格式

目录

一、Newtonsoft.Json下自定义DateTime序列化格式器

1. 定义DateFormatConverter 

2. 在实体上使用自定义的DateFormatConverter特性

二、System.Text.Json下自定义DateTime的序列化格式器

1. 定义DateTimeConverter

2. 定义DateTimeJsonConverter特性

3. 在实体上使用自定义的DateTimeJsonConverter特性

本文介绍了Newtonsoft.Json与System.Text.Json下如何在实体上自定义DateTime类型的序列化格式。

一、Newtonsoft.Json下自定义DateTime序列化格式器

1. 定义DateFormatConverter 

using Newtonsoft.Json.Converters;

namespace HZCC.Test.Model.Converter
{
    /// <summary>
    /// 日期格式转换器
    /// </summary>
    /// <remarks>
    /// 使用方法：在实体属性上指定序列化时需要的日期时间格式
    /// </remarks>
    public class DateFormatConverter : IsoDateTimeConverter
    {
        /// <summary>
        /// 构造函数
        /// </summary>
        /// <param name="format"></param>
        public DateFormatConverter(string format)
        {
            DateTimeFormat = format;
        }
    }
}

2. 在实体上使用自定义的DateFormatConverter特性

using HZCC.Test.Model.Converter;
using Newtonsoft.Json;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace HZCC.Test.Model.Input
{
    /// <summary>
    /// 出差数据
    /// </summary>
    public class CcLeaveDto
    {
        /// <summary>
        /// id
        /// </summary>
        public string Id { get; set; }
        /// <summary>
        /// 姓名
        /// </summary>
        public string Name { get; set; }
        /// <summary>
        /// 出差开始日期
        /// </summary>
        [JsonConverter(typeof(DateFormatConverter), "yyyy-MM-dd HH:mm:ss.fff")]
        public DateTime ActualStartTime { get; set; }
        /// <summary>
        /// 出差结束日期
        /// </summary>
        [JsonConverter(typeof(DateFormatConverter), "yyyy-MM-dd HH:mm:ss.fff")]
        public DateTime ActualEndTime { get; set; }
    }
}

二、System.Text.Json下自定义DateTime的序列化格式器

适用于System.Text.Json的自定义DateTime序列化转换器，可在Model属性上指定具体序列化格式

1. 定义DateTimeConverter

using System;
using System.Collections.Generic;
using System.Globalization;
using System.Linq;
using System.Text;
using System.Text.Json;
using System.Threading.Tasks;

namespace HZCC.Test.Model.Converter
{
    /// <summary>
    /// 适用于System.Text.Json的DateTime格式转换器,可指定日期格式
    /// </summary>
    /// <param name="format">日期格式，示例：yyyy-MM-dd、yyyy-MM-dd HH:mm:ss、yyyy-MM-dd HH:mm:ss.fff</param>
    public class DateTimeConverter(string format) : System.Text.Json.Serialization.JsonConverter<DateTime>
    {
        private readonly string _format = format;

        /// <summary>
        /// 读取
        /// </summary>
        public override DateTime Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
        {
            if (reader.GetString()! == null) return DateTime.MinValue;
            return DateTime.ParseExact(reader.GetString()!, _format, CultureInfo.InvariantCulture);
        }
        /// <summary>
        /// 写入
        /// </summary>
        public override void Write(Utf8JsonWriter writer, DateTime dateTimeValue, JsonSerializerOptions options)
        {
            writer.WriteStringValue(dateTimeValue.ToString(_format, CultureInfo.InvariantCulture));
        }
    }
}

2. 定义DateTimeJsonConverter特性

using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Linq;
using System.Text;
using System.Text.Json.Serialization;
using System.Threading.Tasks;

namespace HZCC.Test.Model.Converter
{
    /// <summary>
    /// 适用于System.Text.Json的DateTime格式转换器特性,可指定日期格式
    /// 使用示例：[DateTimeJsonConverter("yyyy-MM-dd HH:mm:ss.fff")]
    /// </summary>
    /// <param name="format">日期格式，示例：yyyy-MM-dd、yyyy-MM-dd HH:mm:ss、yyyy-MM-dd HH:mm:ss.fff等</param>
    [AttributeUsage(AttributeTargets.Property)]
    public class DateTimeJsonConverterAttribute(string format) : JsonConverterAttribute
    {
        private readonly string _format = format;

        /// <summary>
        /// 创建转换器
        /// </summary>
        public override JsonConverter CreateConverter(Type typeToConvert)
        {
            if (typeToConvert != typeof(DateTime))
            {
                throw new ArgumentException(
                    $"This converter only works with DateTime, and it was provided {typeToConvert.Name}.");
            }

            return new DateTimeConverter(_format);
        }
    }
}

3. 在实体上使用自定义的DateTimeJsonConverter特性

	/// <summary>
	/// 测试Dto
	/// </summary>
	public class TestDto
	{
        /// <summary>
        /// 唯一标识
        /// </summary>
        public string Id{ get; set; }
        /// <summary>
        /// 名称
        /// </summary>
        public string Name{ get; set; }
        /// <summary>
        /// 开始时间1
        /// </summary>
        [DateTimeJsonConverter("yyyy-MM-dd")]
        public DateTime StartTime1 { get; set; }
        /// <summary>
        /// 开始时间2
        /// </summary>
        [DateTimeJsonConverter("yyyy-MM-dd HH:mm:ss.fff")]
        public DateTime StartTime2 { get; set; }

    }