Dapper 本身不直接支持 SQL Server 的
hierarchyid类型,但可以通过类型映射、自定义转换和原生 SQL 配合实现完整读写与层次查询。
理解 hierarchyid 在 Dapper 中的默认行为
Dapper 默认将
hierarchyid映射为
byte[]或
string(取决于数据库驱动返回值),无法直接调用其方法(如
.GetAncestor()、
.IsDescendantOf())。SQL Server 的
hierarchyid是 CLR UDT 类型,需显式处理。 使用
Microsoft.Data.SqlClient(推荐)时,
hierarchyid列默认返回
SqlHierarchyId实例(需引用
Microsoft.SqlServer.Types) 若用
System.Data.SqlClient(已弃用),则通常退化为
byte[],需手动反序列化(不推荐) Dapper 不会自动调用
SqlHierarchyId.Parse()或
.ToString(),需在代码或 SQL 层转换
读取 hierarchyid:推荐用字符串中间表示
最实用的方式是让 SQL 返回可读的路径字符串(如
/1/2/3/),避免 .NET 端依赖 SQL Server 类型库。 查询时用
CONVERT(VARCHAR, hierarchy_column)或
hierarchy_column.ToString()映射到 C# 的
string属性,便于日志、前端展示和简单比较 示例:
var nodes = connection.Query<OrgNode>(@"
SELECT Id, Name, CONVERT(VARCHAR(50), Path) AS PathStr
FROM OrgNodes
WHERE Path.IsDescendantOf(CONVERT(HIERARCHYID, @root)) = 1",
new { root = "/1/" });
写入与层次关系查询:交给 SQL Server 原生处理
层级逻辑(如查找子树、计算层级深度、插入子节点)强烈建议在 SQL 中完成,而非在 C# 中解析
hierarchyid字节数组。 插入新节点:用
GetDescendant(NULL, NULL)或
GetReparentedValue()生成路径 查所有后代:用
WHERE Path.IsDescendantOf(@parent) = 1查直接子节点:加
AND Path.GetLevel() = @parentLevel + 1Dapper 只负责传参和映射,不参与 hierarchyid 运算
高级场景:映射到 SqlHierarchyId 并封装操作
若需在 .NET 中构造或验证 hierarchyid(如后台批量生成树),可引入
Microsoft.SqlServer.Types并注册自定义类型处理器。 安装 NuGet:
Microsoft.SqlServer.Types注册 Dapper 类型处理器(一次):
Dapper.SqlMapper.AddTypeHandler(typeof(SqlHierarchyId),
new SqlHierarchyIdTypeHandler());
自定义 handler 示例:将 string→
SqlHierarchyId.Parse(),反之调用
.ToString()注意:部署时需确保目标服务器有对应 SQL Server CLR 类型运行时(Azure SQL 托管实例支持,普通 Azure SQL DB 不支持)
基本上就这些。核心原则是——把 hierarchyid 当作 SQL Server 的“黑盒路径类型”来用,Dapper 负责安全传参和结果映射,真正的树形逻辑留在 T-SQL 里执行,既高效又可靠。
