.NET 6和ASP.NET Core 6中的DateOnly

最新推荐文章于 2024-05-26 21:32:17 发布
最新推荐文章于 2024-05-26 21:32:17 发布
阅读量955 收藏
点赞数
分类专栏： ASP.NET CORE 文章标签： c# DateOnly
原文链接：https://www.codeproject.com/Articles/5325820/DateOnly-in-NET-6-and-ASP-NET-Core-6
版权

介绍

DateOnly是.NET 6中新引入的原始数据类型。显然，它适用于呈现、传递和存储仅日期信息，例如DateOrBirth、RegisterDate和WhatEverEventDate。

过去，.NET（Framework or Core）开发者基本使用三种方式：

  1. 使用string如yyyy-MM-dd，或yyyyMMdd。并将对象转换为DateTime用于计算日期跨度。
  2. 使用DateTime或DateTimeOffset并确保TimeOfDay为零。在进行跨时区对话时要格外小心。
  3. 使用Noda时间库或类似的。但是，根据您的上下文，使用额外的库可能会带来一些负面影响。

因此，拥有一个仅用于日期信息的专用类型真的是一件幸事。但是，我发现ASP.NET Core或System.Text.Json尚未正确支持DateOnly。如果你在Web API中使用DateOnly，你很快就会在绑定和序列化方面遇到麻烦。

本文提供DateOnly在ASP.NET Core 6中使用的解决方案，在未来引入7之前。

背景

过去，我使用派生类Newtonsoft.Json.Converters.IsoDateTimeConverter来处理仅日期信息。

public class DateAndTimeConverter : IsoDateTimeConverter
{
    static readonly Type typeOfDateTime = typeof(DateTime);
    static readonly Type typeOfNullableDateTime = typeof(DateTime?);
    static readonly Type typeOfDateTimeOffset = typeof(DateTimeOffset);
    static readonly Type typeOfNullDateTimeOffset = typeof(DateTimeOffset?);

    public override void WriteJson
    (JsonWriter writer, object value, JsonSerializer serializer)
    {
        var type = value.GetType();
        if (type == typeOfDateTimeOffset)
        {
            var dto = (DateTimeOffset)value;
            if (dto == DateTimeOffset.MinValue)
            {
                writer.WriteNull();
                return;
            }
            else if (dto.TimeOfDay == TimeSpan.Zero)
            {
                writer.WriteValue(dto.ToString("yyyy-MM-dd"));
                return;
            }
        }
        else if (type == typeOfNullDateTimeOffset)
        {
            var dto = (DateTimeOffset?)value;
            if (!dto.HasValue || dto.Value == DateTimeOffset.MinValue)
            {
                writer.WriteNull();
                return;
            }
            else if (dto.Value.TimeOfDay == TimeSpan.Zero)
            {
                writer.WriteValue(dto.Value.ToString("yyyy-MM-dd"));
                return;
            }
        }
        else if (type == typeOfDateTime)
        {
            var dt = (DateTime)value;
            if (dt.TimeOfDay == TimeSpan.Zero)
            {
                writer.WriteValue(dt.ToString("yyyy-MM-dd"));
                return;
            }
        }
        else if (type == typeOfNullableDateTime)
        {
            var dto = (DateTime?)value;
            if (!dto.HasValue || dto.Value == DateTime.MinValue)
            {
                writer.WriteNull();
                return;
            }
            else if (dto.Value.TimeOfDay == TimeSpan.Zero)
            {
                writer.WriteValue(dto.Value.ToString("yyyy-MM-dd"));
                return;
            }
        }

        base.WriteJson(writer, value, serializer);
    }
}

这些天来，我更喜欢使用JsonConverter<T>。这种方法看起来更整洁，也更灵活。并且System.Text.Json有一个类具有类似的接口。

使用代码

DateOnlyJsonConverter是nuget包Fonlow.DateOnlyExtensions中的转换器之一。您应该在ASP.NET Core控制器和.NET客户端中使用DateOnlyJsonConverter。

public sealed class DateOnlyJsonConverter : JsonConverter<DateOnly>
{
    public override void WriteJson(JsonWriter writer, DateOnly value, JsonSerializer serializer)
    {
        writer.WriteValue(value.ToString("O"));
    }

    public override DateOnly ReadJson(JsonReader reader, Type objectType, DateOnly existingValue, bool hasExistingValue, JsonSerializer serializer)
    {
        var v = reader.Value;
        if (v == null)
        {
            return DateOnly.MinValue;
        }

        var vType = v.GetType();
        if (vType == typeof(DateTimeOffset)) //when the object is from a property in POST body. When used in service, better to have options.SerializerSettings.DateParseHandling = Newtonsoft.Json.DateParseHandling.DateTimeOffset;
        {
            return DateOnly.FromDateTime(((DateTimeOffset)v).DateTime);
        }

        if (vType == typeof(string))
        {
            return DateOnly.Parse((string)v); //DateOnly can parse 00001-01-01
        }

        if (vType == typeof(DateTime)) //when the object is from a property in POST body from a TS client
        {
            return DateOnly.FromDateTime((DateTime)v);
        }

        throw new NotSupportedException($"Not yet support {vType} in {this.GetType()}.");
    }
}

在您的ASP.NET Core Startup代码中，将转换器注入控制器：

 public class Startup
    {
        public Startup(IConfiguration configuration)
        {
            Configuration = configuration;
        }

        public IConfiguration Configuration { get; }

        public void ConfigureServices(IServiceCollection services)
        {
            services.AddControllers()
            .AddNewtonsoftJson(
                options =>
                {
                    options.SerializerSettings.DateParseHandling = Newtonsoft.Json.DateParseHandling.DateTimeOffset;
                    options.SerializerSettings.Converters.Add(new DateOnlyJsonConverter());
                    options.SerializerSettings.Converters.Add(new DateOnlyNullableJsonConverter());
                }
            );

在您的使用HttpClient的.NET客户端代码中，将转换器添加到JsonSerializerSettings：

var jsonSerializerSettings = new Newtonsoft.Json.JsonSerializerSettings()
{
    NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore,
};

jsonSerializerSettings.Converters.Add(new DateOnlyJsonConverter());
jsonSerializerSettings.Converters.Add(new DateOnlyNullableJsonConverter());
Api = new DemoWebApi.Controllers.Client.SuperDemo(httpClient, jsonSerializerSettings);

public partial class SuperDemo
{
    private System.Net.Http.HttpClient client;

    private JsonSerializerSettings jsonSerializerSettings;

    public SuperDemo(System.Net.Http.HttpClient client, 
                     JsonSerializerSettings jsonSerializerSettings = null)
    {
        if (client == null)
            throw new ArgumentNullException("Null HttpClient.", "client");

        if (client.BaseAddress == null)
            throw new ArgumentNullException("HttpClient has no BaseAddress", "client");

        this.client = client;
        this.jsonSerializerSettings = jsonSerializerSettings;
    }

    public System.DateOnly PostDateOnly(System.DateOnly d, 
           Action<System.Net.Http.Headers.HttpRequestHeaders> handleHeaders = null)
    {
        var requestUri = "api/SuperDemo/DateOnly";
        using (var httpRequestMessage = new HttpRequestMessage(HttpMethod.Post, requestUri))
        {
            using (var requestWriter = new System.IO.StringWriter())
            {
                var requestSerializer = JsonSerializer.Create(jsonSerializerSettings);
                requestSerializer.Serialize(requestWriter, d);
                var content = new StringContent(requestWriter.ToString(), 
                              System.Text.Encoding.UTF8, "application/json");
                httpRequestMessage.Content = content;
                if (handleHeaders != null)
                {
                    handleHeaders(httpRequestMessage.Headers);
                }

                var responseMessage = client.SendAsync(httpRequestMessage).Result;
                try
                {
                    responseMessage.EnsureSuccessStatusCodeEx();
                    var stream = responseMessage.Content.ReadAsStreamAsync().Result;
                    using (JsonReader jsonReader = new JsonTextReader
                                      (new System.IO.StreamReader(stream)))
                    {
                        var serializer = JsonSerializer.Create(jsonSerializerSettings);
                        return serializer.Deserialize<System.DateOnly>(jsonReader);
                    }
                }
                finally
                {
                    responseMessage.Dispose();
                }
            }
        }
    }

现在DateOnly几乎在所有情况下都可以在ASP.NET Core 6中使用。

更多示例可以在测试套件中找到。

兴趣点

日期仅在URL中？

到目前为止，使用自定义的JsonConverters，您可以使用HTTP POST正文中的DateOnly对象和返回的结果，作为独立对象或复杂对象的属性值，但是，使用DateOnly对象作为URL的段是不可能的，因为JsonConverter不涉及自定义，但“ Microsoft.AspNetCore.Routing.EndpointMiddleware”和Microsoft.AspNetCore.Mvc.ModelBinding.Binders.ComplexObjectModelBinder可能正在使用System.Text.Json。

显然，微软的ASP.NET Core团队需要做一些事情来给予DateOnly与DateTimeOffset 相同的处理，而目前DateOnly在ASP.NET Core 6的模型绑定中并未将其列为简单类型。

尽管如此，对于可能只是使用string类型而不是DateOnly类型作为URL参数并传递ISO 8601日期字符串的应用程序开发人员来说，这并不是一个真正的大问题。例如：

[HttpGet]
[Route("DateOnlyStringQuery")]
public DateOnly QueryDateOnlyAsString([FromQuery] string d)
{
    return DateOnly.Parse(d);
}

[Fact]
public async void TestQueryDateOnlyString()
{
    DateOnly d = new DateOnly(2008, 12, 18);
    var r = await api.QueryDateOnlyAsStringAsync(d.ToString("O"));
    Assert.Equal(d, r);
}

或者，只需使用POST。

代码生成器怎么样？

编写与Web API对话的客户端代码听起来既重复又无聊。如今，许多开发人员更愿意使用代码生成器来生成客户端API代码。您可以尝试WebApiClientGen和OpenApiClientGen，它们都可以生成与上面类似的客户端API代码。

Newtonsoft.Json还是System.Text.Json？

从.NET 6开始，仍有一些情况System.Text.Json无法正确处理，但Newtonsoft.Json可以。

.NET Framework客户端怎么样？

显然，微软没有计划向后移植DateOnly到.NET Framework。因此，如果您有一些.NET Framework客户端应用程序需要维护，并且想要与使用ASP.NET Core Web API服务通信DateOnly，您可以做什么？

您可以在Nuget包Fonlow.DateOnlyExtensionsNF中使用DateTimeOffsetJsonConverter和DateTimeJsonConverter 。在这个测试套件中可以找到使用DateOnly与ASP.NET Core Web API对话的示例。

WebApiClientGen生成C#客户端API代码，始终映射DateOnly到DateOnly。并且OpenApiClientGen有一个设置“DateToDateOnly”默认为True。如果您希望.NET Framework客户端和.NET客户端都使用生成的代码，您可以将“DateToDateOnly”保留为true。复制生成的代码并将所有“DateOnly”标识符替换为“DateTimeOffset”。您应该不难通过Powsershell脚本自动化生成代码的这种变体。

.NET Framework客户端应用程序代码：

var jsonSerializerSettings = new Newtonsoft.Json.JsonSerializerSettings()
{
    NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore,
};

jsonSerializerSettings.DateParseHandling = Newtonsoft.Json.DateParseHandling.DateTimeOffset; //needed to make sure JSON serializers assume DateTimeOffset rather than DateTime.
jsonSerializerSettings.Converters.Add(new DateTimeOffsetJsonConverter()); //needed to handle DateOnly.MinValue
jsonSerializerSettings.Converters.Add(new DateTimeOffsetNullableJsonConverter()); //needed to handle DateOnly.MinValue
Api = new DemoWebApi.Controllers.Client.DateTypes(httpClient, jsonSerializerSettings);

[Fact]
public void TestPostDateOnly()
{
    var dateOnly = new DateTimeOffset(1988, 12, 23, 0, 0, 0, TimeSpan.Zero);
    var r = api.PostDateOnly(dateOnly);
    Assert.Equal(dateOnly.Date, r.Date);
    Assert.Equal(DateTimeOffset.Now.Offset, r.Offset); //Local date start, because the return  object is "1988-12-23". no matter the client sends "2022-03-12" or "2022-03-12T00:00:00+00:00" or "2022-03-12T00:00:00Z"
    Assert.Equal(TimeSpan.Zero, r.TimeOfDay);
}

您可能会注意到需要额外的设置DateParseHandling。这可确保跨时区通信保留正确的时区信息，而NewtonSoft.Json JsonConverte.ReadJson() 默认情况下读取 DateTimeOffset为DateTime，从而丢失时区信息。相反，在.NET 6中，我们不需要在客户端中为服务器上的DateOnly使用DateTimeOffset，因此不需要转换器。 

JavaScript或TypeScript客户端怎么样？

您的JavaScript客户端只能使用Date对象与Web API对话，该API始终返回yyyy-MM-dd string仅适用于日期的数据。幸运的是，JavaScript可以很好地处理这个问题，可能是因为Date对象总是使用UTC在内部存储数据。WebApiClientGen和OpenApiClientGen可以为jQuery、Angular 2+、AXIOS、Aurelia和Fetch API生成客户端API。在这个类别为“DateTypes API”的测试套件中，您可能会看到TypeScript应用程序如何使用生成的客户端API代码进行DateOnly处理。

日期选择器

您的客户端程序可能会使用一些日期选择器组件。在.NET中，您可能需要确保日期选择器组件与.NET DateOnly兼容，否则，您可能需要遵循当前的数据绑定实践。

如果您正在开发带有日期选择器组件的Web UI，您需要确保选择的日期，例如，“1980-01-01”在Date对象中存储为“1980-01-01T00:00:00.000Z”而不是“1979-12-31T14:00:00.000Z”（我在澳大利亚+10时区）。

比如在开发Angular SPA的时候，我使用的DatePicker是Angular Material Components的组件。为了确保Date对象获得“1980-01-01T00:00:00.000Z”，可以有两种方法。

在@NgModule/providers中，提供以下内容：

{ provide: DateAdapter, useClass: MomentDateAdapter, 
  deps: [MAT_DATE_LOCALE, MAT_MOMENT_DATE_ADAPTER_OPTIONS] },
{ provide: MAT_DATE_FORMATS, useValue: MAT_MOMENT_DATE_FORMATS },
{ provide: MAT_MOMENT_DATE_ADAPTER_OPTIONS, useValue: { useUtc: true, strict: true } },

在包含许多延迟模块的复杂业务应用程序中，您可以在每个延迟模块或组件中声明这些提供程序，而您可能有第三方组件，它们可能更喜欢DatePicker。

仅将DateTime对象映射到日期的约定

将对象映射DateTime到仅日期信息的信号是设置 TimeZone=Zero和TimeOfDate=Zero。显然，Moment.JS团队和Angular Material Components团队使用了相同的协议。同样，.NET客户端和ASP.NET Core Web API都应该使用相同的转换器集来确保这样的协议处理DateTime和DateTimeOffset，否则，不仅只有日期的情况会出现问题，而且DateTime.Min和DateTimeOffset.Min也会跨时区陷入麻烦。

评论

如果您有一个只能存储DateTime日期信息的遗留数据库，您需要检查应用程序如何存储日期。

DateOnly和数据库

显然，并非所有数据库引擎都支持仅日期列。据我所知，  MS SQL Server 2016和MySql仅支持日期数据类型。

使用Entity Framework Code First，相应的数据库特定库应映射DateOnly到Date列类型。

集成测试

在开发分布式应用程序时，在处理DateTime和DateOnly时测试跨时区问题很重要。在集成测试期间，您应该在位于不同时区的机器/VM上拥有服务和客户端。我在澳大利亚，我通常会在+10:00时区使用测试客户端或集成测试套件，在UTC或-10:00时区使用服务。

https://www.codeproject.com/Articles/5325820/DateOnly-in-NET-6-and-ASP-NET-Core-6

寒冰屋
关注
专栏目录
asp.net core6 MVC+SQLite例子
01-12
这个`MyTestMVC`项目就是这样一个完整的示例，展示了如何在ASP.NET Core 6环境中结合MVC和SQLite来创建Web应用。通过研究这个项目，开发者可以了解如何在最新的开发工具和框架下进行实际的Web开发。
asp.net core6 MVC+SqlServer例子
01-12
在这个项目中，我们将会深入探讨ASP.NET Core 6 MVC框架与SQL Server数据库的集成，以及Visual Studio 2022的最新特性。 ASP.NET Core 6是一个跨平台的高性能开源框架，用于构建云就绪的、现代化的Web应用。相比...
.net core 6.0 DateOnly和TimeOnly无法序列化和反序列化
cw370008359的专栏
09-05 650
net core 6.0自动从数据库生成实体类时，如果表字段是date或者time，则生成的实体类中该字段的类型会自动变成DateOnly和TimeOnly，此时查询该数据返回给前端时会报错
在 .NET 6 中使用 DATEONLY 和 TIMEONLY
farway000的博客
09-15 422
在 .NET 6 中使用 DATEONLY 和 TIMEONLY在 即将发布的.NET 6中，引入了两种期待已久的类型作为核心库的一部分。DateOnly和TimeOnly允许开发人员表示...
在.NET 6中使用DateOnly和TimeOnly
芝麻麻雀-Asp.Net学习之路
05-31 990
千呼万唤始出来 在.NET 6(preview 4)中引入了两个期待已久的类型，将作为核心库的一部分。DateOnly和TimeOnly允许开发人员表示DateTime的日期或时间部分。这两个类型为值类型（struct type），可以在代码中独立处理日期或时间概念时使用，它们定义在System命名控件中，使用它们可以与数据库中允许表示相同类型数据的方式保持一致。具体来说，这些类型与SQL Server数据库中日期和时间类型可以很好的进行匹配。 注意：如果你要使用这两种类型，需要下载并安装.NET 6(pr
ASP.NET Core WebAPI 日期格式化
m0_62959350的博客
09-27 353
【代码】ASP.NET Core WebAPI 日期格式化。
2022年8月16日：--使用 ASP.NET Core、最小 API 和 .NET 6 创建--使用最小 API、ASP.NET Core 和 .NET 6 生成 Web API（没看懂）
DXB2021的博客
08-16 1059
生成 Web API 是一种常见任务。希望能够提交一些数据，了解应用程序或服务如何使用它。生成 API 的方式在不同的技术堆栈之间可能会有很大的差别。了解在生成 API 的过程中，有许多需要处理的事项，例如数据存储、安全性、版本控制和文档。处理所有这些事项可能需要进行复杂的操作。生成 API 的过程可能很复杂，因为它需要支持多种功能，例如路由、在数据存储中进行读取和写入，以及身份验证。为了节省时间，请从 .NET 框架着手，这些框架提供许多需要的功能。...
Pro ASP.NET Core 6 Ninth Edition
06-02
Pro ASP.NET Core 6 Develop Cloud-Ready Web Applications Using MVC，Blazor，and Razor Pages -Ninth Edition- Adam Freeman 英文版
.net 开发文档 ASP.NET Core 2.1 ASP.NET Core 3.0.1 EF Core 和 EF6.zip
10-03
本资料集合涵盖了ASP.NET Core 2.1、3.0.1版本以及EF Core和EF6的相关知识，旨在帮助开发者全面理解这些技术的核心概念和实际应用。 首先，ASP.NET Core是Microsoft推出的跨平台、高性能的开源Web框架，支持Windows...
详解ASP.NET Core和ASP.NET Framework共享身份验证
01-20
ASP.NET Core 和 ASP.NET Framework 共享身份验证是.NET开发者在迁移项目时面临的重要问题。随着.NET Core的崛起，它的优势如开源、跨平台、高性能等吸引了大量开发者的关注。然而，由于.NET Core与.NET Framework在...
sqlserver date类型和字符串比较_.NET Core基于SQL Server数据库实现读写分离实战演练...
weixin_39885067的博客
11-21 146
一、课程介绍读写分离从字面意思就可以理解，就是把对数据库的读操作和写操作分离开。读写分离在网站发展初期可以一定程度上缓解读写并发时产生锁的问题，将读写压力分担到多台服务器上。读写分离的基本原理是让主数据库处理事务性增、改、删操作(INSERT、UPDATE、DELETE)，而从数据库处理SELECT查询操作。随着系统的业务量不断增长数据多了之后，对数据库的读、写就会很多。分库减少单台数据...
.NET平台系列22：.NET Core/.NET5/.NET6 对比 .NET Framework
nidongla的博客
06-11 3146
系列目录 【已更新最新开发文章，点击查看详细】 　　在我的博客《.NET平台系列2 .NET Framework 框架详解》与 《.NET平台系列7 .NET Core 体系结构详解》 两篇文章中分别详细介绍了.NET Framewrok与.NET Core 的核心构成以及各部件的组成与原理。本文通过其他维度更加直接的对比说明两者的差异。 体系结构对比 　　.NET平台自诞生之日起就具备跨平台的能力。.NET Framework本身是一个跨平台的解决方案，在这一基础上它还支持C#和VB等编程语言...
.net日期控件使用
热门推荐
一路向北
01-12 1万+
ASP.NET 使用My97DatePicker日期控件 首先要下载该控件的包，下载地址：http://pan.baidu.com/s/1Aa5gk 引用文件 <script src="js/My97DatePicker/WdatePicker.js" type="text/javascript"></script><script src="js/My97...
关于ASP.NET CORE使用DateTime日期类型参数的一个小细节
jamenu的博客
07-01 1285
2.不要在方法里对DateTime参数进行判空操作，因为当你不为DateTime传入值时，它会被默认设置为 DateTime.MinValue 测试： 故
.net6API使用AutoMapper和DTO
故里2130
02-16 1502
通俗的来说，DTO就是前端界面需要用的数据结构和类型，而我们经常使用的数据实体，是数据库需要用的数据结构和类型，它们2者负责的方向不一样，经常需要进行转化，那么此时AutoMapper就是一个转换工具，它可以对数据实体和前端界面的数据进行转换，反之，也可以，这样就加大了转换的效率，如果不用AutoMapper时，我们需要自己手写转换，AutoMapper的目的就是提高转换效率，不用写更多的判断代码了。此文件最重要，里面都是对实体类和DTO进行配置的，相互转换的。dto里面的字段，就是前端需要显示的字段。
.NET 6新特性试用 | 最小Web API
dotNET跨平台
11-14 1516
前言如果你使用过其他一些轻量级Web框架，比如Node.JS，你就会知道，创建具有最小依赖项的HTTP API是多么简单：varexpress=require('express') ...
在.NET 6.0上使用Kestrel配置和自定义HTTPS
xwnxwn的专栏
07-24 1467
因为如果你的服务是在防火墙后面，是属于后台服务，不对外网提供服务，启用HTTPS也是有意义的。通常，在Windows上，启用HTTPS所需的证书是从Windows证书存储库加载的，在Linux或Mac上，则会从证书文件上加载证书，后者更加灵活，是我比较推荐的方式。原文链接：https://blog.csdn.net/bj_xuzhiqiang/article/details/126726816。// 格式化json输出的日期格式为时间戳。// 格式化json输出的日期格式。// 设置时区为 UTC。
C#中DateTime类型对象按自定义格式转换到JSON
a_dev的专栏
05-11 2392
自定义一个类，继承自DateTimeConverterBase，并重写WriteJson和ReadJson方法： public class CustomizedDateTimeConverer : DateTimeConverterBase { private static IsoDateTimeConverter dtConvertor = new IsoDateT...
闲话 .NET（6）：.NET Core 各个版本的特性
最新发布
yangshuquan的专栏
05-26 1472
NET Core 发展非常迅速，不过短短几年，.NET Core 已经发布 .NET 8 了，基本上保持了一年一个版本的速度，每个版本都有自己的独有特性，下面我们来简单的盘点一下这些新特性有哪些。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值