AutoMapper使用

AutoMapper使用

前言:前篇搭建了下WCF的代码,就提到了DTO的概念,对于为什么要有这么一个DTO的对象,上章可能对于这点不太详尽,在此不厌其烦再来提提它的作用:

  • 从安全上面考虑,领域Model都带有领域业务,让Client端引用Domain Model就意味着Client端可以绕过应用层直接完成业务逻辑的调用,这样是一种不安全的机制。
  • 从对象传递效率上面考虑,领域Model带有业务,而这些业务一般对于UI层是没有意义的,所以带有业务的model传递起来会加重网络负担。
  • 网上还说了DTOmodel最大的意义在于跨平台,Domain Model都是与特定的语言的数据类型有关,而这些数据类型是不能跨平台的,比如Java的类型就不能被C#使用。但在分布式模式下,Client端与Server端的平台不同是很正常的,如果Service直接返回Domain Model,Client端根本无法解析,这就要求Service返回的结果必须是标准的格式字节流。让Domain Model只使用简单类型(字符和数值)?让数据类型约束Domain Model显然不是一个好想法,所以DTO似乎是必不可少的了。

既然我们要使用DTO,那么有一件事我们就非做不可了,我们从领域层得到的是领域Model,如何把领域Model转换成只带有数据属性的DTO传递到前台呢?又或者我们从前台提交一个DTO对象,如何将DTO转换成领域Model而提交到后台呢?这个时候就需要我们的对象映射工具,目前市面上对象映射工具较多,但博主最熟悉的还是Automapper,这章就来分享下Automapper的使用。

一、AutoMapper

Automapper是一个object-object mapping(对象映射)工具,一般主要用于两个对象之间数据映射和交换。当然你也可以自己通过反射去写对象的映射,对于简单的两个属性间的数据转换,肯定没什么问题。但是如果遇到某些复杂的数据转换,比如指定某一个对象的某个属性映射到另一个对象的某一个属性,这种情况如果我们自己手动映射,恐怕就有点麻烦了吧。既然我们有现成的工具,为什么不用呢?

二、AutoMapper引用到项目中

向项目中添加AutoMapper的引用有两种方式:

1、Nuget方式

在需要使用AutoMapper的项目文件上面右键→管理Nuget程序包,打开Nuget界面,搜索Automapper,然后安装第一个即可。如下图:

2、程序包管理控制台方式

点击Visual Studio的工具菜单→程序包管理控制台,然后选择需要安装Automapper的项目(下图中的默认项目),最后在控制台里面输入命令“Install-Package AutoMapper”命令即可按照Automapper包:

三、AutoMapper使用代码示例

1、最简单的对象映射

AutoMapper使用起来还是比较简单的,最简单的用法你只需要两句话:

var oMenu = new TB_MENU() { MENU_NAME="权限管理", MENU_LEVEL="1" };Mapper.CreateMap<TB_MENU, DTO_TB_MENU>();
var oDto = Mapper.Map<DTO_TB_MENU>(oMenu);

首先创建映射,然后传入需要映射的对象执行映射。相信在项目中使用过AutoMapper的原因肯定也写过类似这样的AutoMapperHelper

    /// <summary>
    /// AutoMapper帮助类
    /// </summary>
    public static class AutoMapperHelper
    {
        /// <summary>
        ///  单个对象映射
        /// </summary>
        public static T MapTo<T>(this object obj)
        {
            if (obj == null) return default(T);
            Mapper.CreateMap(obj.GetType(), typeof(T));
            return Mapper.Map<T>(obj);
        }

        /// <summary>
        /// 集合列表类型映射
        /// </summary>
        public static List<TDestination> MapToList<TSource, TDestination>(this IEnumerable<TSource> source)
        {
            Mapper.CreateMap<TSource, TDestination>();
            return Mapper.Map<List<TDestination>>(source);
        }
    }

当然,这是最简单的用法,稍微复杂点的用法我们在后面慢慢介绍。

2、指定字段的对象映射

前面说了,对于指定某一个对象的某个属性映射到另一个对象的某一个属性,这种场景,我们先来看看下面代码:

   public partial class TB_USERS : BaseEntity
    {
        public string USER_ID { get; set; }
        public string USER_NAME { get; set; }
        public string USER_PASSWORD { get; set; }
        public string FULLNAME { get; set; }
        public string DEPARTMENT_ID { get; set; }

      public virtual TB_DEPARTMENT TB_DEPARTMENT { get; set; }
     //...后面肯定还有其他领域行为
    }

   public partial class TB_DEPARTMENT : BaseEntity
    {
        public string DEPARTMENT_ID { get; set; }
        public string NAME { get; set; }
    }

领域层有这两个实体model,然后我们需要得到下面的DTO_TB_USERS这一个对象

   public class DTO_TB_USERS
    {
        [DataMember]
        public string USER_ID { get; set; }

        [DataMember]
        public string USER_NAME { get; set; }

        [DataMember]
        public string USER_PASSWORD { get; set; }

        [DataMember]
        public string FULLNAME { get; set; }

        [DataMember]
        public string DEPARTMENT_ID { get; set; }

     [DataMember]     public string DEPARTMENT_NAME { get; set; }
       }

这个时候DTO_TB_USERS这个对象的属性分布在其他两个领域实体里面,我们看看AutoMapper如何解决:

var oDomainUser = userRepository.Entities.FirstOrDefault();
var map = Mapper.CreateMap<TB_USERS, DTO_TB_USERS>();
map.ForMember(d => d.DEPARTMENT_NAME, opt => opt.MapFrom(x => x.TB_DEPARTMENT.NAME));
var oDto = Mapper.Map<TB_USERS, DTO_TB_USERS>(oDomainUser);  

通过上面的代码,ForMember()方法会指定哪个字段转换为哪个字段,这样就完美的将对象的层级结构由二级变成了一级(即将TB_USERS下面TB_DEPARTMENT对象的NAME值转换成了DTO_TB_USERS的DEPARTMENT_NAME值)。除此之外,Automapper里面还可以通过ForMember帮我们做其他很多我们想不到的事情,比如可以设置某个属性值保留初始值,只需要通过

map.ForMember(d => d.DEPARTMENT_NAME, opt => opt.Ignore());

这一句就帮我们搞定。

3、传递lamada的表达式映射

还记得我们在仓储里面封装了传递lamada表达式的查询方法么?试想,如果我们在Web层里面也希望传递lamada表达式去后台查询,那么这个时候就有点问题了,因为我们Web里面只能访问DTO的Model,所以只能传入DTO Model的lamada,而我们仓储里面需要传入的是领域Model的lamada,那么问题就来了,这两个lamada表达式之间必须存在一个转换关系,试想,这些东西如果让我们手动去处理,还是有难度的吧!还好,我们神奇的Automapper替我们想到了。它能够帮我们将DTO的lamada转换成领域Model的lamada,来看看代码吧:

     [Import]
     public IUserRepository userRepository { get; set; }

     public virtual IList<DTO> Find(Expression<Func<DTO, bool>> selector)
        {
            //得到从Web传过来和DTOModel相关的lamaba表达式的委托
            Func<DTO, bool> match = selector.Compile();
            //创建映射Expression的稳妥
            Func<T, DTO> mapper = AutoMapper.QueryableExtensions.Extensions.CreateMapExpression<T, DTO>(Mapper.Engine).Compile();
            //得到领域Model相关的lamada
            Expression<Func<T, bool>> lamada = ef_t => match(mapper(ef_t));
            List<T> list = userRepository.Find(lamada).ToList();
            return Mapper.Map<List<T>, List<DTO>>(list);
        }

上面方法完美实现了两种lamada之间的转换,但根据博主的使用经历,这种转换对属性的类型有很严格的要求,必须保证领域model和DTO的Model同一个属性的类型完全相同,否则容易报异常。使用的时候需要注意。

4、Automapper的其他应用

除了上面介绍的Automapper的几个简单使用,其他还有其他的一些用法。

网上很多介绍DataReader对象和实体类之间的映射:

using (IDataReader reader = db.ExecuteReader(command))
{
    if (reader.Read())
    {
        return AutoMapper.Mapper.DynamicMap<Product>(reader);
    }
}

至此,AutoMapper的常见用法基本分享完了,至于更高级的用法,有兴趣可以看看蟋蟀兄的【AutoMapper官方文档】DTO与Domin Model相互转换(上)。虽然很多高级用法在实际项目中很难用上,但多了解一点似乎也并没有坏处。

分类: .NetC#

标签: DDD

时间: 2024-10-21 08:46:51

AutoMapper使用的相关文章

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

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

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

在上一篇文章中我们构造出了完整的应用场景,包括我们的Model.Dto以及它们之间的转换规则.下面就可以卷起袖子,开始我们的AutoMapper之旅了. [二]以Convention方式实现零配置的对象映射 我们的AddressDto和Address结构完全一致,且字段名也完全相同.对于这样的类型转换,AutoMapper为我们提供了Convention,正如它的官网上所说的: 引用 AutoMapper uses a convention-based matching algorithm to

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

书接上文.在上一篇文章中我们讨论了使用AutoMapper实现类型间1-1映射的两种方式--Convention和Configuration,知道了如何进行简单的OO Mapping.在这个系列的最后一篇文章我想基于我们的需求讨论一些中级别的话题,包括:如何实现类型体型之间的映射,以及如何为两个类型实现多个映射规则. [四]将一个类型映射为类型体系 先回顾一下我们的Dto和Model.我们有BookDto,我们有Author,每个Author有自己的ContactInfo.现在提一个问题:如何从

对象映射工具AutoMapper介绍

AutoMapper是用来解决对象之间映射转换的类库.对于我们开发人员来说,写对象之间互相转换的代码是一件极其浪费生命的事情,AutoMapper能够帮助我们节省不少时间. 一. AutoMapper解决了什么问题? 要问AutoMapper解决了什么问题? 难道不是对象映射转换的问题吗? 当然是,不过我们可以问深入一些,为什么项目中会出现大量的对象映射转换?(以下对于非MVC项目也适用) 在现代的软件开发中,项目的层级更加的细分,而不同层级之间对于对象的需求是有区别的,这就需要在不同层级间传递

0.AutoMapper

AutoMapper是基于约定的对象 - 对象映射器.AutoMapper使用流畅的配置API来定义对象 - 对象映射策略.AutoMapper使用基于约定的匹配算法来匹配源到目标值.AutoMapper面向模型投影场景,将复杂的对象模型变成DTO和其他简单对象,这些对象的设计更适合于序列化,通信,消息传递或简单的域和应用程序层之间的防腐层. 1.扁平化 2.投影 3.配置验证 4.列表和数组 5.嵌套映射 6.自定义类型转换器 7.自定义值解析器 8.空替换 9.映射操作之前和之后 10.依赖

AutoMapper的介绍与使用(二)

AutoMapper的匹配 1,智能匹配 AutoMapper能够自动识别和匹配大部分对象属性: 如果源类和目标类的属性名称相同,直接匹配,不区分大小写 目标类型的CustomerName可以匹配源类型的Customer.Name 目标类型的Total可以匹配源类型的GetTotal()方法 2,自定义匹配 Mapper.CreateMap<CalendarEvent, CalendarEventForm>()                                          

升级AutoMapper后遇到的“Missing map”与“Missing type map configuration or unsupported mapping”问题

前几天发现 AutoMapper 3.3 的一个性能问题(详见:遭遇AutoMapper性能问题:映射200条数据比100条慢了近千倍),于是将 AutoMapper 升级至最新的 5.1.1 看是否也存在这个性能问题. 升级中想当然地将之前的map配置代码: Mapper.CreateMap<AEntity, ADto>(); Mapper.CreateMap<BEntity, BDto>(); 改为: Mapper.Initialize(cfg => cfg.Create

遭遇AutoMapper性能问题:映射200条数据比100条慢了近千倍

今天遇到了AutoMapper的一个性能问题,使用的是AutoMapper的Project特性,AutoMapper版本是3.3.0,代码如下: return await _repository .GetByStartId(startIngId, itemCount) .Project() .To<TDto>() .ToListAsync(); 当获取包含200条数据的列表时,竟然超过5秒. GetDocs(3000, 200) 6304ms GetDocs(3000, 200) 5822ms

分享一个简单程序(webApi+castle+Automapper+Ef+angular)

前段时间在周末给朋友做了一个小程序,用来记录他们单位的一些调度信息(免费,无版权问题).把代码分享出来.整个程序没有做任何架构.但是麻雀虽小,用到的技术也没少.WebApi+Castle+AutoMapper+Ef+angular,日志记录Log4net.初学者可以学习借鉴,虽然做的比较仓促,但是自我感觉代码写的还是比较规范. git地址:https://git.oschina.net/richieyangs/TaskRecord.git 只需修改web.config中的连接字符串,Ctrl+F

无名小卒AutoMapper的大显神威

最近在做gxpt(高校平台的项目),前台框架用的是MVC,后台用的是EF+WCF.怎么突然说出来感觉很高大上的样子.呵呵!但是在写代码的时候就发现一个问题.就是在EF中的实体(Model)跟前台需要的实体(DTO数据传输对象)是不一样的,所以就需要转换一下.一开始也没多想,可能是被做项目的热情冲昏了头脑,写多少代码都不觉得类,所以每当需要转换的时候就一个一个的写!给大家看一个例子! <span style="font-size:18px;">namespace testau