0

0

Dapper如何实现手动控制对象映射 Dapper自定义TypeMap教程

畫卷琴夢

畫卷琴夢

发布时间:2026-01-20 10:51:51

|

836人浏览过

|

来源于php中文网

原创

Dapper通过TypeMap机制支持自定义映射逻辑,核心是替换IDbPropertyMap行为;可使用SetTypeMap全局注册自定义ITypeMap,或用MapHandler单次动态控制,亦可结合自定义特性实现声明式映射。

dapper如何实现手动控制对象映射 dapper自定义typemap教程

Dapper 默认通过反射自动映射查询结果到对象,但有时需要手动控制映射逻辑(比如字段名不一致、类型转换特殊、忽略某些列、或动态构造对象)。Dapper 提供了 TypeMap 机制来实现自定义映射,核心是替换或扩展默认的 IDbPropertyMap 行为。

理解 Dapper 的 TypeMap 工作机制

Dapper 内部用 TypeMap 管理一个类型(如 User)与其数据库列之间的映射关系。每个类型对应一个 TypeMap 实例,它包含一组 IDbPropertyMap,每个映射一条属性到一列(或表达式)。默认情况下,Dapper 会按名称(大小写不敏感)自动匹配列名和属性名。

手动控制的关键在于:在查询前,为指定类型注册自定义 TypeMap,从而接管属性绑定逻辑。

使用 SetTypeMap 自定义整个类型的映射

最直接的方式是调用 SqlMapper.SetTypeMap,传入类型和自定义 TypeMap 实现:

  • 继承 SqlMapper.ITypeMap,或更常用的是继承内置的 DefaultTypeMap
  • 重写 GetMemberMaps 方法,返回你想要的 IDbPropertyMap 列表
  • 每个 IDbPropertyMap 指定属性、列名、是否可空、转换器等

示例:将数据库列 user_name 映射到 C# 属性 UserName,并忽略 is_deleted 字段:

SqlMapper.SetTypeMap(typeof(User), new CustomUserTypeMap());

class CustomUserTypeMap : DefaultTypeMap { public CustomUserTypeMap() : base(typeof(User)) { }

public override IEnumerable GetMemberMaps(MemberInfo member)
{
    var maps = base.GetMemberMaps(member).ToList();
    // 替换 UserName 的列名为 user_name
    if (member.Name == "UserName")
    {
        return new[] { new DbPropertyMap(member, "user_name") };
    }
    // 忽略 is_deleted 字段(不返回任何映射)
    if (member.Name == "IsDeleted") return Enumerable.Empty();
    return maps;
}

}

AliGenie 天猫精灵开放平台
AliGenie 天猫精灵开放平台

天猫精灵开放平台

下载

用 SqlMapper.MapHandler 动态控制单次映射

如果只需对某次查询做临时映射(比如多表 JOIN 后字段冲突),不必全局注册 TypeMap,可用 SqlMapper.MapHandler

  • Query 前设置 SqlMapper.MapHandler
  • 该委托接收 IDataReader 和目标对象实例,由你手动赋值
  • 适合复杂逻辑、运行时决定映射、或混合多个来源数据

示例:

SqlMapper.MapHandler = (reader, obj) =>
{
    var user = (User)obj;
    user.Id = reader.GetInt32("id");
    user.UserName = reader.GetString("user_name");
    user.CreatedAt = reader.GetDateTime("created_at");
    // 不读取 deleted_at 字段
};

var users = connection.Query("SELECT id, user_name, created_at FROM users");

配合 ColumnAttribute 或自定义 Attribute 更灵活

你可以结合自定义特性(如 [DbColumn("user_name")])+ 自定义 TypeMap,让映射声明式、可复用:

  • 定义自己的特性类,标记在属性上
  • GetMemberMaps 中检查该特性,提取列名或转换逻辑
  • 比硬编码更易维护,也支持不同实体混用规则

注意:Dapper 原生不识别 [Column](那是 EF 的),必须自己解析。

基本上就这些。TypeMap 是 Dapper 最底层的映射控制入口,够用但需谨慎——一旦设错会影响所有后续对该类型的查询。建议优先用列别名(SQL 中 AS)或匿名对象 + 手动构造,仅在真正需要深度定制时才介入 TypeMap。

相关专题

更多
数据分析工具有哪些
数据分析工具有哪些

数据分析工具有Excel、SQL、Python、R、Tableau、Power BI、SAS、SPSS和MATLAB等。详细介绍:1、Excel,具有强大的计算和数据处理功能;2、SQL,可以进行数据查询、过滤、排序、聚合等操作;3、Python,拥有丰富的数据分析库;4、R,拥有丰富的统计分析库和图形库;5、Tableau,提供了直观易用的用户界面等等。

683

2023.10.12

SQL中distinct的用法
SQL中distinct的用法

SQL中distinct的语法是“SELECT DISTINCT column1, column2,...,FROM table_name;”。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

321

2023.10.27

SQL中months_between使用方法
SQL中months_between使用方法

在SQL中,MONTHS_BETWEEN 是一个常见的函数,用于计算两个日期之间的月份差。想了解更多SQL的相关内容,可以阅读本专题下面的文章。

348

2024.02.23

SQL出现5120错误解决方法
SQL出现5120错误解决方法

SQL Server错误5120是由于没有足够的权限来访问或操作指定的数据库或文件引起的。想了解更多sql错误的相关内容,可以阅读本专题下面的文章。

1095

2024.03.06

sql procedure语法错误解决方法
sql procedure语法错误解决方法

sql procedure语法错误解决办法:1、仔细检查错误消息;2、检查语法规则;3、检查括号和引号;4、检查变量和参数;5、检查关键字和函数;6、逐步调试;7、参考文档和示例。想了解更多语法错误的相关内容,可以阅读本专题下面的文章。

357

2024.03.06

oracle数据库运行sql方法
oracle数据库运行sql方法

运行sql步骤包括:打开sql plus工具并连接到数据库。在提示符下输入sql语句。按enter键运行该语句。查看结果,错误消息或退出sql plus。想了解更多oracle数据库的相关内容,可以阅读本专题下面的文章。

677

2024.04.07

sql中where的含义
sql中where的含义

sql中where子句用于从表中过滤数据,它基于指定条件选择特定的行。想了解更多where的相关内容,可以阅读本专题下面的文章。

575

2024.04.29

sql中删除表的语句是什么
sql中删除表的语句是什么

sql中用于删除表的语句是drop table。语法为drop table table_name;该语句将永久删除指定表的表和数据。想了解更多sql的相关内容,可以阅读本专题下面的文章。

417

2024.04.29

Java JVM 原理与性能调优实战
Java JVM 原理与性能调优实战

本专题系统讲解 Java 虚拟机(JVM)的核心工作原理与性能调优方法,包括 JVM 内存结构、对象创建与回收流程、垃圾回收器(Serial、CMS、G1、ZGC)对比分析、常见内存泄漏与性能瓶颈排查,以及 JVM 参数调优与监控工具(jstat、jmap、jvisualvm)的实战使用。通过真实案例,帮助学习者掌握 Java 应用在生产环境中的性能分析与优化能力。

3

2026.01.20

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
最新Python教程 从入门到精通
最新Python教程 从入门到精通

共4课时 | 5.8万人学习

Rust 教程
Rust 教程

共28课时 | 4.6万人学习

Git 教程
Git 教程

共21课时 | 2.8万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号