AutoMapper使用手册(一)

阅读目录

  1. 介绍

  2. 基本使用

  3. 自动分割映射(Flattening)

  4. 自定义字段映射(Projection)

  5. 验证配置(Configuration validation)

介绍

AutoMapper是一个轻量级的类库,主要功能是把一个对象转换成另外一个对象,而避免我们每次都手工去转换。

常见几种使用场景:

  • 对外服务接口,把逻辑层的实体转换成服务消费者需要的字段。
  • UI展现层,把业务对象转换成UI需要展现的字段。
  • 用户的输入输出,把DTO与领域模型互转。

AutoMapper支持的平台:

  • .NET 4+
  • Silverlight 5
  • Windows Phone 8+
  • .NET for Windows Store apps (WinRT)
  • Windows Universal Apps
  • Xamarin.iOS
  • Xamarin.Android

基本使用

NuGet安装使用

PM> install-package automapper

注册2个类型之间的映射关系:

Mapper.CreateMap<Order, OrderDto>();

通过Map方法生成目标类型新对象,OrderDto是目标类型,order是源对象。

OrderDto dto = Mapper.Map<OrderDto>(order);

AutoMapper默认是根据属性名称自动与源进行规则匹配,赋值。
例:FirstName=FirstName,FirstName=firstname,mapper不区分大小写。

配置

使用静态全局mapper注册的话,应该放在应用程序启动的时候。
比如ASP.NET的Global.asax文件中Application_Start()方法。

测试

AutoMapper提供下面方法去验证我们的配置是否有效,无效会抛出异常:

Mapper.AssertConfigurationIsValid();

自动分割映射(Flattening)

实际中我们经常需要把一个复杂对象映射一个简单对象,给UI使用,例:

public class Order
{
    public Customer Customer { get; set; }
    public decimal GetTotal()
    {
        return 10*10;
    }
}
 public class Customer
    {
        public string Name { get; set; }
    }

然后匹配Order对象到一个简单的OrderDto,仅包含我们需要的字段:

public class OrderDto
{
    public string CustomerName { get; set; }
    public decimal Total { get; set; }
}

当我们使用AutoMapper创建Order/OrderDto映射配置时,AutoMapper映射器会尝试在Order中,寻找名称匹配的成员,有3种匹配方式。

  • 名称相同的属性进行映射,不区分大小写。
  • 带Get前缀的方法进行映射,如例子中:
    映射器会把Order中的GetTotal分割成Get、Total 2个词, 把第二个Total与OrderDto中Order进行匹配映射。
  • 目标类型属性分割,如例子中:
    映射器会把OrderDto中的CustomerName分割成Customer、Name。然后在Order中去Customer类属性中查找Name的属性。

内部匹配根据帕斯卡拼写法(PascalCase)。

自定义字段映射(Projection)

自动分割映射能预判源对象到目标对象的匹配,但不能自定义配置映射。AutoMapper在构造目标对象时,会自动按照规则进行目标与源属性分割匹配。
所以自动分割映射虽然方便智能,但却不是那么精确可控制的。 在很多场景下,我们更需要的是把A属性拆分映射B、C 2个属性上,或单独映射D属性上。
AutoMapper提供一种自定义成员映射的方法。例如:

public class CalendarEvent
{
    public DateTime Date { get; set; }
    public string Title { get; set; }
}

我们想在web页面上输出更多的字段:

public class CalendarEventForm
{
    public DateTime EventDate { get; set; }
    public int EventHour { get; set; }
    public int EventMinute { get; set; }
    public string Title { get; set; }
}

因为目标类型的属性不存在源上,所以AutoMapper也无法完成精确匹配。 我们需要自定义成员映射规则到我们的类型映射配置上面。

// 源对象
var calendarEvent = new CalendarEvent
    {
        Date = new DateTime(2008, 12, 15, 20, 30, 0),
        Title = "假期公司聚会"
    };

// 配置AutoMapper。   dest是目标表达式。opt是源表达式
Mapper.CreateMap<CalendarEvent, CalendarEventForm>()
    .ForMember(dest => dest.EventDate, opt => opt.MapFrom(src => src.Date.Date))
    .ForMember(dest => dest.EventHour, opt => opt.MapFrom(src => src.Date.Hour))
    .ForMember(dest => dest.EventMinute, opt => opt.MapFrom(src => src.Date.Minute));

// 执行映射
CalendarEventForm form = Mapper.Map<CalendarEvent, CalendarEventForm>(calendarEvent);

form.EventDate.ShouldEqual(new DateTime(2008, 12, 15));
form.EventHour.ShouldEqual(20);
form.EventMinute.ShouldEqual(30);
form.Title.ShouldEqual("假期公司聚会");

ForMember方法允许我们指定2个action委托去配置每个成员的映射关系。 在上面的例子中,我们在源表达式使用了MapFrom方法去执行源值与目标成员的映射。这个MapFrom方法接受一个lambda表达式为参数,它在对象映射期间进行求值,即惰性求值。MapFrom参数可以是任意一个func的lambda表达式。

验证配置(Configuration validation)

平常我们手工进行对象映射,虽然很枯燥无味,但有利于我们测试转换。在这个源类型到目标类型转换基础测试上,其实我们仍然需要测试自己的应用。 AutoMapper也想到了这点,它减少的不仅仅是我们手工进行对象映射的事情,还能帮助我们节省手工写测试代码的时间。

AutoMapper提供了AssertConfigurationIsValid方法去测试我们的配置项。 假设我们有个轻微的错误在源类型和目标类型上:

public class Source {    public int SomeValue { get; set; } }
public class Destination
{
    public int SomeValuefff { get; set; }
}

在Destination上,我们可能不小心输入错误,多了几个fff。也可能是我们的源属性重命名了。

我们去测试配置项,创建映射配置并且执行AssertConfigurationIsValid方法。

Mapper.CreateMap<Source, Destination>();
Mapper.AssertConfigurationIsValid();

在代码执行期间会抛出一个AutoMapperConfigurationException异常,描述消息为:

 Unmapped members were found. Review the types and members below.
 Add a custom mapping expression, ignore, add a custom resolver, or modify the source/destination type
  ==============================================================
Source -> Destination (Destination member list)
ConsoleApplication1.Source -> ConsoleApplication1.Destination (Destination member list)
Unmapped properties:
SomeValuefff

AssertConfigurationIsValid执行验证期间,AutoMapper会检查每个目标类型的属性,逐一去匹配源中是否存在合适相等的类型。

异常处理(Overriding configuration errors)

除了我们去修改源和目标类型的名称外。 我们有3种选择去解决错误:

  • 自定义值解析器
  • 指定字段映射(Projection)
  • 使用忽略(Ignore())选项

关于第三种选择,在目标类型我们有个成员,它有其他的含义(非字面意思或预留字段), 我们不想进行转换,我们可以配置如下:

 Mapper.CreateMap<Source, Destination>()
    .ForMember(dest => dest.SomeValuefff, opt => opt.Ignore());

官方文档:https://github.com/AutoMapper/AutoMapper

坐车回家过年了,祝大家新年愉快。

时间: 2024-10-29 19:13:29

AutoMapper使用手册(一)的相关文章

angular参考手册拷贝

AngularJS 参考手册 AngularJS 指令 本教程用到的 AngularJS 指令 : 指令 描述 ng-app 定义应用程序的根元素. ng-bind 绑定 HTML 元素到应用程序数据 ng-bind-html 绑定 HTML 元素的 innerHTML 到应用程序数据,并移除 HTML 字符串中危险字符 ng-bind-template 规定要使用模板替换的文本内容 ng-blur 规定 blur 事件的行为 ng-change 规定在内容改变时要执行的表达式 ng-check

Exchange 2013迁移SOP手册

Exchange 2013迁移SOP手册 阶段1:环境部署 OUTLOOK升级方式 统计版本低于SP3的OUTLOOK客户端信息 记录计算机在域中所在OU信息 域中创建临时升级用OU,如MAILUPGRADE 采用如下命令移动计算机到MAILUPGRADE OU dsmove "CN=Aidong Qi,OU=Users,OU=TESTP,OU=Hitech,DC=hitechad,DC=com" -newparent OU=MAILUPGRADE,DC=hitechad,DC=com

oracle11g dataguard 完全手册

一.前言: 网络上关于dataguard的配置文章很多,但是很多打着oracle11g的文章实际都是只能在9 10 上运行,比如FAL_CLIENT在11g中已经废弃,但是现在网络上的文章都是没有标注这一点.而且对于具体含义语焉不详对于新手只能知其然而不知其所以然.这篇文章我就想让像我这样的人对于dataguard配置不仅仅知道怎么配置,还要知道为什么需要这样配置,这样的效果才是最好的. 这篇文章不仅仅是记录如何配置,还介绍了为什么是这样,以及注意要点,我希望这个文章可以作为进行dataguar

小书匠语法使用手册

小书匠语法使用手册 小书匠 语法 MARKDOWN 帮助 常用语法 标题 1这是 H1 一级标题 2------ 3这是 H2 二级标题 4====== 5# 这是 H1 一级标题 6## 这是 H2 二级标题 7### 这是 H3 三级标题 8#### 这是 H4 四级标题 9##### 这是 H5 五级标题 10###### 这是 H6 六级标题 11 快捷键: [ctrl + h] 列表 无序列表 1* 项目1 2 * 子项目1.1 3 * 子项目1.2 4 * 子项目1.2.1 5* 项

[笔记][Java7并发编程实战手册]3.2 资源的并发访问控制Semaphore信号量

[笔记][Java7并发编程实战手册]系列目录 简介 本文学习信号量Semaphore机制. Semaphore 本质是一个共享锁 内部维护一个可用的信号集,获取信号量之前需要先申请获取信号数量:用完之后,则需要释放信号量:如果不释放,那么其他等待线程则一直阻塞直到获取信号量或则被中断为止 本人的理解是:互斥锁是同一时间只能一个线程访问,而在这里,是同一时间允许获取到了信号量的线程并发访问,而没有获取到信号量的则必须等待信号量的释放: 将信号量初始化为 1,使得它在使用时最多只有一个可用的许可,

SVN Server环境安装配置手册

SVN Server环境安装配置手册_百度文库 http://wenku.baidu.com/link?url=923bv1olSkznh1gWd7Gqoxxwj18IHIlTXcEbNiPSLM5H32k93UtQ22rAVppNIlVv89ru4E1cPFe1yESSEkSsR4NfDMMRgpA2d3GI_KcV37m

《开源分享1》:前端开发必备《Html-CSS中文手册》

一直想做一些优秀的资源分享内容,今天尝试整理了一下,以后会每天抽点时间发一些自认为不错的资料出来.帮助大家提高学习效率. 今天分享的内容:前端开发:<Html-CSS中文手册>! 本手册针对的是已有一定网页设计制作经验的读者.其目的是提供完整清晰的样式表内容的快速索引及进阶帮助.所以对于网页制作和样式表的基础知识,仅简单介绍,恕不赘述. 手册提供了完整的 CSS2.0 的属性(Properties).规则(At-Rules).伪类(Pseudo-Classes).伪元素(Pseudo-Elem

LINUX基本命令行手册一

linux基本命令行手册一    1.1基本的网络命令        1>wget 从服务器上检索或下载文件,支持HTTP,HTTPS,FTP协议,服务器响应后,会将请求到的文件下载到当前用户所处的目录下        语法:wget [option]... [URL]...        option:            -t:尝试请求服务器的次数,若在指定的次数内,未响应,则断开链接            -o:将信息输出保存在记录文件中            -nc:支持断点下载,当下

使用AutoMapper实现Dto和Model的自由转换(上)

在实际的软件开发项目中,我们的"业务逻辑"常常需要我们对同样的数据进行各种变换.例如,一个Web应用通过前端收集用户的输入成为Dto,然后将Dto转换成领域模型并持久化到数据库中.另一方面,当用户请求数据时,我们又需要做相反的工作:将从数据库中查询出来的领域模型以相反的方式转换成Dto再呈现给用户.有时候我们还会面临更多的数据使用需求,例如有多个数据使用的客户端,每个客户端都有自己对数据结构的不同需求,而这也需要我们进行更多的数据转换. 频繁的数据转换琐碎而又凌乱,很多时候我们不得不: