SqlSugar中处理SqlHierarchyId类型的自定义转换方案

在使用SqlSugar ORM框架与SQL Server数据库交互时，有时会遇到需要处理特殊数据类型如SqlHierarchyId的情况。本文将详细介绍如何在SqlSugar中实现SqlHierarchyId类型的自定义转换。

问题背景

当数据库表中包含SqlHierarchyId类型的字段时，直接映射到C#的string类型会导致类型转换异常。这是因为SqlHierarchyId是SQL Server特有的数据类型，不能直接转换为.NET的string类型。

解决方案

SqlSugar提供了自定义类型转换的机制，可以通过实现ISugarDataConverter接口来解决这个问题。

自定义转换器实现

首先需要创建一个自定义转换器类，继承ISugarDataConverter接口：

public class HierarchyIdConverter : ISugarDataConverter
{
    public SugarParameter ParameterConverter<T>(object value, int index)
    {
        var parameterName = "@hierarchyIdParam" + index;
        return new SugarParameter(parameterName, value) 
        { 
            CustomDbType = SqlDbType.Udt,  // 指定为UDT类型
            UdtTypeName = "hierarchyid"     // 指定UDT类型名称
        };
    }
  
    public T QueryConverter<T>(IDataRecord dataRecord, int index)
    {
        // 直接从数据记录中获取值，由调用方处理类型转换
        return (T)dataRecord.GetValue(index);
    }
}

在实体类中应用转换器

在实体类中，通过SugarColumn特性指定自定义转换器：

public class Department
{
    [SugarColumn(SqlParameterDbType = typeof(HierarchyIdConverter))]
    public string HierarchyPath { get; set; }
    
    // 其他属性...
}

实现原理

1. 参数转换：当SqlSugar需要将C#对象转换为SQL参数时，会调用ParameterConverter方法。在这里我们明确指定参数类型为UDT(用户定义类型)，并设置具体的UDT名称为"hierarchyid"。

2. 查询结果转换：当从数据库读取数据时，QueryConverter方法会被调用。我们直接返回原始值，由调用方处理具体的类型转换逻辑。

注意事项

1. 确保项目中已引用Microsoft.SqlServer.Types程序集，这是处理SqlHierarchyId类型所必需的。

2. 在实际业务代码中处理SqlHierarchyId时，可能需要额外的类型转换逻辑，因为数据库返回的是SqlHierarchyId对象而非字符串。

3. 对于复杂的层次结构操作，建议在应用层封装专门的辅助方法来处理SqlHierarchyId的解析和构建。

扩展应用

这种自定义转换器机制不仅适用于SqlHierarchyId类型，还可以用于处理其他特殊数据库类型，如地理空间数据类型(Geometry/Geography)、XML类型等。只需要根据具体类型的特性实现相应的转换逻辑即可。

通过这种灵活的类型转换机制，SqlSugar能够很好地支持SQL Server中的各种特殊数据类型，为开发人员提供了更大的灵活性。