C# 接口中DateTime类型字段返回年月日格式，去掉时分秒的数据

Posted 2023-02-17 李公子lm

背景

在我们平时写接口的时候，避免不了这样一个问题，数据库中存的字段类型为datetime,代码中对应的实体类也是DateTime类型的字段，于是在读取数据库内容之后返回的数据也是DateTime类型的值，比如2022-10-24 18:34:56.110，但是对于服务器请求者来说，他们可能只需要显示年月日即可，后面的时分秒是不需要的，如果能说服他们，不用修改我们的代码，当日最好。那么对于我们服务提供者来说，如何处理这类问题呢?

实现方式1

可以直接把返回的实体类中的DateTime修改为string，格式就可以自定义了，但是缺点也很明显，

1.无法使用ToList，MapTo等方式直接把数据库中读取的DateTime值直接转换成String。
2.若有多个接口需要修改，比较麻烦。
3.适用情况单一，若有别的字段类型修改，比较麻烦。

实现方式2（推荐）

采用JsonConverterAttribute类和JsonConverter<T>类，通过给属性加特性类的方式进行修改。
实现的简要步骤如下。
这里我新建个一个ASP.NET Core Web API的项目，来做示范。项目建好之后内容如下。
WeatherForecastController.cs内容如下。

using Microsoft.AspNetCore.Mvc;

namespace DateTime返回年月日.Controllers

    [ApiController]
    [Route("[controller]")]
    public class WeatherForecastController : ControllerBase
    
        private static readonly string[] Summaries = new[]
        
            "Freezing", "Bracing", "Chilly", "Cool", "Mild", "Warm", "Balmy", "Hot", "Sweltering", "Scorching"
        ;

        private readonly ILogger<WeatherForecastController> _logger;

        public WeatherForecastController(ILogger<WeatherForecastController> logger)
        
            _logger = logger;
        

        [HttpGet(Name = "GetWeatherForecast")]
        public IEnumerable<WeatherForecast> Get()
        
            return Enumerable.Range(1, 5).Select(index => new WeatherForecast
            
                Date = DateTime.Now.AddDays(index),
                TemperatureC = Random.Shared.Next(-20, 55),
                Summary = Summaries[Random.Shared.Next(Summaries.Length)]
            )
            .ToArray();
        
    

在Get 接口中，返回了一个WeatherForecast的一个数组，在这个实体类中，有一个DateTime类型的字段Date,我们请求下接口看下返回值。

这里可以看到，Date字段返回的是一个包含年月日，并且还有时区的一个字符串。
WeatherForecast实体类如下

using System.Text.Json.Serialization;

namespace DateTime返回年月日

    public class WeatherForecast
    
        public DateTime Date  get; set; 

        public int TemperatureC  get; set; 

        public int TemperatureF => 32 + (int)(TemperatureC / 0.5556);

        public string? Summary  get; set; 
    

重点来了。参考https://docs.microsoft.com/zh-cn/dotnet/api/system.text.json.serialization.jsonconverterattribute?view=net-6.0

JsonConverterAttribute可用反射的方式指定一个转换器类。那么我们就新建一个名为DateOnlyConverter的类，继承JsonConverter<T>这个泛型类，其中需要指定类型为DateTime，内容如下。

using System.Text.Json;
using System.Text.Json.Serialization;

namespace DateTime返回年月日

    public class DateOnlyConverter : JsonConverter<DateTime>
    
        public override DateTime Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
        
            throw new NotImplementedException();
        

        public override void Write(Utf8JsonWriter writer, DateTime value, JsonSerializerOptions options)
        
            writer.WriteStringValue(value.ToString("yyyy-MM-dd"));
        
    

JsonConverter<T>包含两个抽象接口必须添加对应的实现，Read和Write，我们只需要修改具体的Write方法，实现内容也非常简单，就是把对应的类型进行转换。
最后在WeatherForecast类的Date属性上添加上对应的特性。

using System.Text.Json.Serialization;

namespace DateTime返回年月日

    public class WeatherForecast
    
        [JsonConverter(typeof(DateOnlyConverter))]
        public DateTime Date  get; set; 

        public int TemperatureC  get; set; 

        public int TemperatureF => 32 + (int)(TemperatureC / 0.5556);

        public string? Summary  get; set; 
    

最后来看下调用结果吧。

通过添加特性的方式，不用修改实体类的类型，也不用修改具体的业务逻辑。

结语

参考内容：
https://docs.microsoft.com/zh-cn/dotnet/api/system.text.json.serialization.jsonconverter-1?view=net-6.0

have a wonderful day.