Dapper 本身不直接支持 SQL Server 的用户定义类型(UDT),但可以通过自定义 ITypeHandler 实现 UDT 的双向映射——即 .NET 类型 ↔ 数据库 UDT 值。
注册UDT类型处理器
SQL Server 的 UDT(如
Point、
Geometry或自定义 CLR 类型)需在数据库中已注册,并在 .NET 端有对应类(通常实现
INullable和
IBinarySerialize)。Dapper 依靠
ITypeHandler完成转换: SetValue:把 .NET UDT 实例序列化为
SqlBytes或
byte[],并设置
parameter.UdtTypeNameParse:从数据库返回的
SqlBytes或
object反序列化为 UDT 实例
示例(以自定义 UDT
MyUdt为例):
public class MyUdtHandler : SqlMapper.ITypeHandler
{
public void SetValue(IDbDataParameter parameter, object value)
{
parameter.Value = value == null ? DBNull.Value : ((MyUdt)value).ToBinary();
parameter.UdtTypeName = "dbo.MyUdt"; // 必须与数据库中注册名一致
}
public object Parse(Type destinationType, object value)
{
if (value == null || value == DBNull.Value) return null;
var bytes = (byte[])value;
return MyUdt.FromBinary(bytes);
}
}
注册方式:
SqlMapper.AddTypeHandler(typeof(MyUdt), new MyUdtHandler());
确保UDT类符合SQL Server要求
.NET 端 UDT 类必须满足 SQL Server 的序列化规范,典型结构包括:
标记[Serializable]和
[SqlUserDefinedType(Format.Native)](或
Format.UserDefined+
IBinarySerialize实现) 提供静态
Parse()和实例
ToBinary()方法 无参构造函数(用于反序列化)
若使用
Format.UserDefined,必须完整实现
IBinarySerialize.Read()和
Write()。
配合Dapper.Contrib或QueryMultiple使用注意事项
UDT 字段在查询中默认无法自动映射到实体属性,除非:
该属性类型与注册的ITypeHandler类型完全匹配(含可空性,如
MyUdt?需额外注册) 避免在
Query<t>()</t>中混用未映射字段;建议显式 SELECT 所需列,或用匿名类型过渡 插入/更新时,确保参数对象中 UDT 属性值非 null 或已正确处理 null 场景(如设为
DBNull.Value)
替代方案:用内置类型绕过UDT(适用简单场景)
如果 UDT 仅用于封装简单数据(如坐标字符串、编码后的结构),更轻量的做法是:
数据库层仍用 UDT 列,但 Dapper 层统一按string或
byte[]处理 注册
string→
MyUdt的转换器(在业务逻辑中解析),而非让 Dapper 直接持有 UDT 类型 这样可规避 UDT 部署依赖,也便于跨数据库兼容
基本上就这些。关键不是“能不能”,而是“谁负责序列化”——Dapper 把控制权交给你,你只需守住
SetValue和
Parse这两个入口。
