FreeSql中虚谷数据库Date类型字段映射问题解析

在使用FreeSql ORM框架连接虚谷数据库(Xugu)时，开发人员可能会遇到Date类型字段映射错误的问题。本文将深入分析这一问题，并提供多种解决方案。

问题现象

当实体类中使用DateTime类型映射数据库的date类型字段时，查询结果会出现异常——返回的值总是当前时间，而非数据库中实际存储的日期值。

典型的问题代码示例如下：

[Description("出生日期")]
[Column(Name = "CSRQ", DbType = "date")]
public DateTime Csrq { get; set; }

问题根源分析

经过调试发现，问题出在数据读取环节。通过AuditDataReader事件观察到的Value属性值不正确，这表明FreeSql在从虚谷数据库读取date类型数据时存在类型转换问题。

解决方案

方案一：使用字符串类型映射

最简单的解决方案是将实体类中的属性类型改为string：

[Column(Name = "CSRQ", DbType = "date")]
public string Csrq { get; set; }

方案二：自定义类型处理器(TypeHandler)

对于需要保持强类型的情况，可以自定义类型处理器：

1. 定义专用日期类型

public class XuguDate
{
    public DateTime Value { get; set; }
    // 可添加其他辅助方法和属性
}

2. 实现类型处理器

public class XuguDateTypeHandler : TypeHandler<XuguDate>
{
    public override object Serialize(XuguDate value) => value?.Value.ToString("yyyy-MM-dd");
    
    public override XuguDate Deserialize(object value) 
    {
        if (DateTime.TryParse(value?.ToString(), out var date))
            return new XuguDate { Value = date };
        return new XuguDate { Value = DateTime.MinValue };
    }
    
    public override void FluentApi(ColumnFluent col) => col.MapType(typeof(string)).StringLength(12);
}

3. 注册类型处理器

FreeSql.Internal.Utils.TypeHandlers.TryAdd(typeof(XuguDate), new XuguDateTypeHandler());

方案三：使用DateOnly类型(.NET 6+)

对于使用.NET 6及以上版本的项目，可以使用DateOnly类型：

public class DateOnlyTypeHandler : TypeHandler<DateOnly>
{
    public override object Serialize(DateOnly value) => value.ToString("yyyy-MM-dd");
    
    public override DateOnly Deserialize(object value) => 
        DateOnly.TryParse(string.Concat(value), out var trydo) ? trydo : DateOnly.MinValue;
    
    public override void FluentApi(ColumnFluent col) => col.MapType(typeof(string)).StringLength(12);
}

// 注册处理器
FreeSql.Internal.Utils.TypeHandlers.TryAdd(typeof(DateOnly), new DateOnlyTypeHandler());

最佳实践建议

1. 优先考虑字符串映射：对于简单的日期显示需求，字符串映射是最简单可靠的方案。

2. 复杂场景使用专用类型：如果需要日期计算等操作，建议使用DateOnly或自定义XuguDate类型，并通过类型处理器实现映射。

3. 版本兼容性：如果项目需要支持多版本.NET，自定义类型处理器是更通用的解决方案。

4. 调试技巧：遇到映射问题时，可以通过fsql.Ado.AuditDataReader事件观察原始数据值，帮助诊断问题。

总结

虚谷数据库的date类型与FreeSql的默认映射存在兼容性问题，但通过上述方案可以很好地解决。开发者应根据项目实际需求选择合适的解决方案，确保日期数据能够正确地在应用程序和数据库之间传递。