DapperLib/Dapper 中 DateOnly 和 TimeOnly 类型的支持问题解析

概述

在数据库操作中，日期和时间类型的处理一直是开发中的常见需求。随着 .NET 6 引入了 DateOnly 和 TimeOnly 这两个新类型，许多ORM框架需要相应地进行适配。本文将详细分析 Dapper 库在处理这些新类型时遇到的问题及其解决方案。

问题背景

在 Dapper 2.1.35 版本中，开发者遇到了以下问题：

1. 使用 Dictionary<string, object> 或 DynamicParameters（未指定DbType）传递 DateOnly 和 TimeOnly 类型参数时，会抛出 NotSupportedException 异常
2. 即使通过指定 DbType.Date 和 DbType.Time 成功插入数据，查询时也无法正确映射到 DateOnly 和 TimeOnly 类型的属性
3. 尝试将时间列映射到 DateTime 类型也会失败

技术分析

参数传递问题

Dapper 内部通过类型映射系统处理参数转换。在 2.1.35 版本中，SqlMapper.cs 文件中的 typeMap 变量明确将 DateOnly 类型标记为 DoNotSetFieldValue，导致无法直接使用这些类型作为参数。

解决方案是使用 DynamicParameters 并显式指定 DbType：

var parameters = new DynamicParameters();
parameters.Add("dateParam", dateOnlyValue, DbType.Date);
parameters.Add("timeParam", timeOnlyValue, DbType.Time);

查询结果映射问题

当从数据库查询数据时，Dapper 需要将数据库返回的值转换为目标类型。原始版本存在以下问题：

1. 数据库返回的 DATE 类型值被转换为 DateTime，无法自动转换为 DateOnly
2. TIME 类型值返回为特殊对象，无法直接转换为 TimeOnly 或 DateTime

在 2.1.37 及更高版本中，Dapper 改进了这些类型的处理：

1. 可以直接映射到包含 DateOnly 和 TimeOnly 属性的类
2. 作为替代方案，DATE 列可以映射到 DateTime，TIME 列可以映射到 TimeSpan

版本演进

• 2.1.35：不支持 DateOnly/TimeOnly 类型
• 2.1.37：添加了对这些类型的支持（最初未在 NuGet 上列出）
• 2.1.44：稳定版本，包含完整的 DateOnly/TimeOnly 支持

最佳实践

1. 参数传递：

   • 使用 DynamicParameters 而非 Dictionary<string, object>
   • 为 DateOnly 参数指定 DbType.Date
   • 为 TimeOnly 参数指定 DbType.Time

2. 结果映射：

   • 推荐直接使用 DateOnly 和 TimeOnly 类型属性
   • 备选方案：DATE 列映射到 DateTime，TIME 列映射到 TimeSpan
   • 确保使用 Microsoft.Data.SqlClient 而非 System.Data.SqlClient

3. 数据库兼容性：

   • 测试表明该解决方案适用于 MS SQL、MySQL 和 PostgreSQL
   • 不同数据库提供程序可能需要特定的版本支持

示例代码

// 插入数据
var parameters = new DynamicParameters();
parameters.Add("date", new DateOnly(2023, 1, 1), DbType.Date);
parameters.Add("time", new TimeOnly(12, 30), DbType.Time);
await connection.ExecuteAsync("INSERT INTO Table(DateCol, TimeCol) VALUES (@date, @time)", parameters);

// 查询数据
var results = await connection.QueryAsync<MyModel>("SELECT DateCol, TimeCol FROM Table");
public class MyModel {
    public DateOnly DateCol { get; set; }
    public TimeOnly TimeCol { get; set; }
}

结论

Dapper 从 2.1.37 版本开始完善了对 DateOnly 和 TimeOnly 类型的支持。开发者应使用最新稳定版本(2.1.44+)并遵循推荐的最佳实践，以确保日期和时间类型在应用程序和数据库之间的正确转换。这一改进显著简化了.NET 6+应用程序中日期时间相关字段的处理，使代码更加类型安全和表达清晰。