Dapper 库中 DateOnly 和 TimeOnly 类型的支持与使用指南

前言

在 .NET 6 及更高版本中，微软引入了两个新的日期时间相关类型：DateOnly 和 TimeOnly。这些类型为处理纯日期和纯时间提供了更清晰的语义。然而，在使用流行的微型 ORM 框架 Dapper 时，开发者可能会遇到一些兼容性问题。本文将详细介绍如何在 Dapper 中正确使用这些新类型。

兼容性背景

Dapper 从 2.1.37 版本开始正式支持 DateOnly 和 TimeOnly 类型。需要注意的是：

1. 必须使用 Microsoft.Data.SqlClient 而不是旧的 System.Data.SqlClient
2. 对于参数传递，推荐使用 DynamicParameters 而不是 Dictionary<string, object>
3. 数据库列类型应与 .NET 类型匹配：Date 列对应 DateOnly，Time 列对应 TimeOnly

参数传递最佳实践

推荐方式：使用 DynamicParameters

var parameters = new DynamicParameters();
parameters.Add("dateParam", new DateOnly(2023, 1, 1));
parameters.Add("timeParam", new TimeOnly(14, 30));

这种方式在 Dapper 2.1.37+ 版本中工作良好，无需指定 DbType。

需要指定 DbType 的情况

在某些场景下，可能需要显式指定参数类型：

parameters.Add("dateParam", new DateOnly(2023, 1, 1), DbType.Date);
parameters.Add("timeParam", new TimeOnly(14, 30), DbType.Time);

不推荐方式：使用 Dictionary<string, object>

var parameters = new Dictionary<string, object>
{
    {"dateParam", new DateOnly(2023, 1, 1)},
    {"timeParam", new TimeOnly(14, 30)}
};

这种方式在目前版本中仍然不支持，会抛出 NotSupportedException。

查询结果映射

直接映射到 DateOnly/TimeOnly 属性

在 Dapper 2.1.37+ 中，可以直接定义包含这些类型的实体类：

public class Event
{
    public int Id { get; set; }
    public DateOnly EventDate { get; set; }
    public TimeOnly StartTime { get; set; }
}

查询时，Dapper 会自动处理类型转换：

var events = connection.Query<Event>("SELECT * FROM Events");

备用映射方案

如果必须使用 DateTime 属性接收数据，可以按以下方式处理：

• 对于 Date 列：映射到 DateTime 属性（时间部分将被忽略）
• 对于 Time 列：映射到 TimeSpan 属性

public class EventAlternative
{
    public int Id { get; set; }
    public DateTime EventDate { get; set; } // 接收 DATE 列
    public TimeSpan StartTime { get; set; } // 接收 TIME 列
}

常见问题解决方案

1. 类型转换错误：确保使用正确的客户端驱动 (Microsoft.Data.SqlClient)
2. 参数传递失败：改用 DynamicParameters 替代 Dictionary
3. 查询结果映射异常：检查实体类属性类型是否与数据库列类型匹配

版本选择建议

推荐使用 Dapper 2.1.44 或更高版本，这些版本在保持 DateOnly/TimeOnly 支持的同时，修复了其他潜在问题。

总结

Dapper 对新日期时间类型的支持为现代 .NET 开发提供了更好的体验。通过遵循本文的建议，开发者可以避免常见的陷阱，充分利用这些新类型带来的优势。记住关键点：使用正确的客户端驱动、选择合适的参数传递方式，以及正确定义实体类属性类型。