AutoMapper实际项目运用

AutoMapper是对象到对象的映射工具。在完成映射规则之后，AutoMapper可以将源对象转换为目标对象。

配置AutoMapper映射规则

AutoMapper是基于约定的，因此在实用映射之前，我们需要先进行映射规则的配置。

public class Source
{
    public int SomeValue { get; set; }
    public string AnotherValue { get; set; }
}

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

在上面的代码中，我们定义了两个类，我们需要将Source类的对象映射到Destination类的对象上面。要完成这个操作，我们需要对AutoMapper进行如下配置：

Mapper.CreateMap<Source, Destination>();

进行一下测试：

Source src = new Source() { SomeValue = 1, AnotherValue = "2" };
Destination dest = Mapper.Map<Destination>(src);

ObjectDumper.Write(dest);

我们可以在控制台看到dest对象的属性值：

这样我们就完成了一个简单的AutoMapper映射。

Profile的用法

Profile提供了一个命名的映射类，所有继承自Profile类的子类都是一个映射集合。

我们来看一下Profile的用法，这个例子中仍然使用上面的Source类和Destination类。

public class SourceProfile : Profile
{
    protected override void Configure()
    {
        CreateMap<Source, Destination>();
    }
}

我们可以再Profile中重写Configure方法，从而完成映射规则的配置。从Profile初始化Mapper规则：

Mapper.Initialize(x => x.AddProfile<SourceProfile>());

在一个Profile中，我们可以完成多个、更复杂的规则的约定：

public class Destination2
{
    public int SomeValue { get; set; }
    public string AnotherValue2 { get; set; }
}

public class SourceProfile : Profile
{
    protected override void Configure()
    {
        //Source->Destination
        CreateMap<Source, Destination>();

        //Source->Destination2
        CreateMap<Source, Destination2>().ForMember(d => d.AnotherValue2, opt =>
        {
            opt.MapFrom(s => s.AnotherValue);
        });
    }
}

AutoMapper最佳实践

这段内容将讨论AutoMapper的规则写在什么地方的问题。

在上一段中，我们已经知道了如何使用AutoMapper进行简单的对象映射，但是，在实际的项目中，我们会有很多类进行映射（从Entity转换为Dto，或者从Entity转换为ViewModel等），这么多的映射如何组织将成为一个问题。

首先我们需要定义一个Configuration.cs的类，该类提供AutoMapper规则配置的入口，它只提供一个静态的方法，在程序第一次运行的时候调用该方法完成配置。

当有多个Profile的时候，我们可以这样添加：

public class Configuration
{
    public static void Configure()
    {
        Mapper.Initialize(cfg =>
        {
            cfg.AddProfile<Profiles.SourceProfile>();
            cfg.AddProfile<Profiles.OrderProfile>();
            cfg.AddProfile<Profiles.CalendarEventProfile>();
        });
    }
}

在程序运行的时候，只需要调用Configure方法即可。

了解了这些实现以后，我们可以再项目中添加AutoMapper文件夹，文件夹结构如下：

Configuration为我们的静态配置入口类；Profiles文件夹为我们所有Profile类的文件夹。如果是MVC，我们需要在Global中调用：

AutoMapper.Configuration.Configure();

扁平化映射（Flattening）

默认情况下，我们的Source类和Destination类是根据属性名称进行匹配映射的。除此之外，默认的映射规则还有下面两种情况，我们称之为扁平化映射，即当Source类中不包含Destination类中的属性的时候，AutoMapper会将Destination类中的属性进行分割，或匹配“Get”开头的方法，例如：

Order类：

public class Order
{
    public Customer Customer { get; set; }

    public decimal GetTotal()
    {
        return 100M;
    }
}

Order类中包含了一个customer对象和一个GetTotal方法，为了方便演示，我直接将GetTotal方法返回100；

Customer类的定义如下：

public class Customer
{
    public string Name { get; set; }
}

OrderDto类的定义如下：

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

我们在进行映射的时候，不需要进行特殊的配置，既可以完成从Order到OrderDto的映射。

public class OrderProfile : Profile
{
    protected override void Configure()
    {
        CreateMap<Entity.Order, Dto.OrderDto>();
    }
}

测试代码：

Entity.Customer customer = new Entity.Customer() { Name = "Tom" };
Entity.Order order = new Entity.Order() { Customer = customer };
Dto.OrderDto orderDto = Mapper.Map<Dto.OrderDto>(order);
ObjectDumper.Write(order, 2);
ObjectDumper.Write(orderDto);

测试结果：

指定映射字段（Projection）

在实际的业务环境中，我们的Source类和Destination类的字段不可能一对一的匹配，这个时候我们就需要来指定他们的实际映射关系，例如：

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

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

在这两个类中，CalendarEvent的Date将被拆分为CalendarEventForm的日期、时、分三个字段，Title也将对应DisplayTitle字段，那么相应的Profile定义如下：

public class CalendarEventProfile : Profile
{
    protected override void Configure()
    {
        CreateMap<Entity.CalendarEvent, Entity.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))
            .ForMember(dest => dest.DisplayTitle, opt => opt.MapFrom(src => src.Title));
    }
}

测试代码：

Entity.CalendarEvent calendarEvent = new Entity.CalendarEvent()
{
    Date = DateTime.Now,
    Title = "Demo Event"
};
Entity.CalendarEventForm calendarEventForm = Mapper.Map<Entity.CalendarEventForm>(calendarEvent);
ObjectDumper.Write(calendarEventForm);

测试结果：

验证配置项（Configuration Validation）

AutoMapper提供了一种验证机制，用来判断Destination类中的所有属性是否都被映射，如果存在未被映射的属性，则抛出异常。

验证的用法：

Mapper.AssertConfigurationIsValid();

例如：

public class Source
{
    public int SomeValue { get; set; }
    public string AnotherValue { get; set; }
}

Destination代码：

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

测试：

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

运行程序将会出现AutoMapperConfigurationException异常：

这是因为SomeValuefff在Source类中没有对应的字段造成的。

解决这种异常的方法有：

指定映射字段，例如：

Mapper.CreateMap<Entity.Source, Entity.Destination>()
    .ForMember(dest => dest.SomeValuefff, opt =>
    {
        opt.MapFrom(src => src.SomeValue);
    });

或者使用Ignore方法：

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

或者使用自定义解析器，自定义解析器在下面讲到。

自定义解析器（Custom value resolvers）

AutoMapper允许我们自定义解析器来完成Source到Destination的值的转换。例如：

public class Source
{
    public int Value1 { get; set; }
    public int Value2 { get; set; }
}

public class Destination
{
    public int Total { get; set; }
}

Total属性在Source中不存在，如果现在创建映射规则，在映射的时候必然会抛出异常。这个时候我们就需要使用自定义解析器来完成映射。

自定义解析器需要实现 IValueResolver 接口，接口的定义如下：

public interface IValueResolver
{
    ResolutionResult Resolve(ResolutionResult source);
}

我们来自定义一个Resolver：

public class CustomResolver : ValueResolver<Source, int>
{
    protected override int ResolveCore(Source source)
    {
        return source.Value1 + source.Value2;
    }
}

然后在映射规则中使用这个解析器：

public class SourceProfile : Profile
{
    protected override void Configure()
    {
        //Source->Destination
        CreateMap<Source, Destination>()
            .ForMember(dest => dest.Total, opt =>
            {
                opt.ResolveUsing<CustomResolver>();
            });
    }
}

测试代码：

Source src = new Source()
{
    Value1 = 1,
    Value2 = 2
};
Destination dest = Mapper.Map<Destination>(src);
ObjectDumper.Write(dest);

测试结果：

在使用自定义Resolver中，我们还可以指定Resolver的构造函数，例如：

//Source->Destination
CreateMap<Source, Destination>()
    .ForMember(dest => dest.Total, opt =>
    {
        opt.ResolveUsing<CustomResolver>()
            .ConstructedBy(() =>

new CustomResolver

());
    });

自定义类型转换器（Custom type converters）

AutoMapper通过ConvertUsing来使用自定义类型转换器。ConvertUsing有三种用法：

void ConvertUsing(Func<TSource, TDestination> mappingFunction);
void ConvertUsing(ITypeConverter<TSource, TDestination> converter);
void ConvertUsing<TTypeConverter>() where TTypeConverter : ITypeConverter<TSource, TDestination>;

当我们有如下的Source类和Destination类：

public class Source
{
    public string Value1 { get; set; }
}

public class Destination
{
    public int Value1 { get; set; }
}

我们可以使用如下配置：

public class SourceProfile : Profile
{
    protected override void Configure()
    {
        //string->int
        CreateMap<string, int>()
            .ConvertUsing(Convert.ToInt32);
        //Source->Destination
        CreateMap<Source, Destination>();
    }
}

在上面的配置中，我们首先创建了从string到int的类型转换，这里使用了系统自带的Convert.ToInt32转换方法。

除了这种方法之外，我们还可以自定义类型转换器：

public class CustomConverter : ITypeConverter<Source, Destination>
{
    public Destination Convert(ResolutionContext context)
    {
        Source src = context.SourceValue as Source;
        Destination dest = new Destination();
        dest.Value1 = System.Convert.ToInt32(src.Value1);

        return dest;
    }
}

通过这个转换器，我们可以绕过string到int的转换，直接将Source类的对象转换为Destination类的对象。

对应的配置如下：

public class SourceProfile : Profile
{
    protected override void Configure()
    {
        //Source->Destination
        CreateMap<Source, Destination>()
            .ConvertUsing<CustomConverter>();
    }
}

或者，我们也可以使用下面的配置：

public class SourceProfile : Profile
{
    protected override void Configure()
    {
        //Source->Destination
        CustomConverter converter = new CustomConverter();
        CreateMap<Source, Destination>()
            .ConvertUsing(converter);
    }
}

空值替换（Null substitution）

空值替换允许我们将Source对象中的空值在转换为Destination的值的时候，使用指定的值来替换空值。

public class Source
{
    public string Value { get; set; }
}

public class Destination
{
    public string Value { get; set; }
}

配置代码：

public class SourceProfile : Profile
{
    protected override void Configure()
    {
        //Source->Destination
        CreateMap<Source, Destination>()
            .ForMember(dest => dest.Value, opt =>
            {
                opt.NullSubstitute("原始值为NULL");
            });
    }
}

测试代码：

Source src = new Source();
Destination dest = Mapper.Map<Destination>(src);
ObjectDumper.Write(dest);

测试结果：

条件映射（Conditional mapping）

条件映射只当Source类中的属性值满足一定条件的时候才进行映射。例如：

public class Foo
{
    public int baz;
}

public class Bar
{
    public uint baz;
}

对应的配置代码如下：

Mapper.CreateMap<Foo, Bar>()
    .ForMember(dest => dest.baz, opt =>
    {
        opt.Condition(src => (src.baz >= 0));
    });
时间： 2024-10-21 01:45:53

AutoMapper实际项目运用的相关文章

ABP项目中的使用AutoMapper

AutoMapper之ABP项目中的使用 最近在研究ABP项目,昨天写了Castle Windsor常用介绍以及其在ABP项目的应用介绍 欢迎各位拍砖,有关ABP的介绍请看阳光铭睿 博客 AutoMapper只要用来数据转换,在园里已经有很多这方面文章了,本文主要介绍其在实际项目常用总结,以及在ABP项目中的应用介绍.AutoMapper应用非常简单,大家稍微看下文档就可以上手,但是性能不好啊,所以一般用在后台项目,对外的项目千万不要用.就那NOP来说吧,它也是把AutoMapper放在后台项目

让AutoMapper在你的项目里飞一会儿(转)

出处:http://www.cnblogs.com/WeiGe/p/3835523.html 先说说DTO DTO是个什么东东? DTO(Data Transfer Object)就是数据传输对象,说白了就是一个对象,只不过里边全是数据而已. 为什么要用DTO? 1.DTO更注重数据,对领域对象进行合理封装,从而不会将领域对象的行为过分暴露给表现层 2.DTO是面向UI的需求而设计的,而领域模型是面向业务而设计的.因此DTO更适合于和表现层的交互,通过DTO我们实现了表现层与领域Model之间的

让AutoMapper在你的项目里飞一会儿

先说说DTO DTO是个什么东东? DTO(Data Transfer Object)就是数据传输对象,说白了就是一个对象,只不过里边全是数据而已. 为什么要用DTO? 1.DTO更注重数据,对领域对象进行合理封装,从而不会将领域对象的行为过分暴露给表现层 2.DTO是面向UI的需求而设计的,而领域模型是面向业务而设计的.因此DTO更适合于和表现层的交互,通过DTO我们实现了表现层与领域Model之间的解耦,因此改动领域Model不会影响UI层 3.DTO说白了就是数据而已,不包含任何的业务逻辑

DTO学习系列之AutoMapper（四）

本篇目录: Mapping Inheritance-映射继承 Queryable Extensions (LINQ)-扩展查询表达式 Configuration-配置 Conditional Mapping-条件映射 AutoMapper版本变化点 类型映射优先级 后记 关于AutoMapper写到这基本的东西都差不多了,上一篇定义为灵活配置篇,本篇可以定义为扩展应用篇,加一些补充,关于AutoMapper的项目应用,网上找了几篇英文文章,虽然看不懂,但是代码是相通的,感觉很不错,主要是Enti

AutoMapper使用

AutoMapper使用 前言:前篇搭建了下WCF的代码,就提到了DTO的概念,对于为什么要有这么一个DTO的对象,上章可能对于这点不太详尽,在此不厌其烦再来提提它的作用: 从安全上面考虑,领域Model都带有领域业务,让Client端引用Domain Model就意味着Client端可以绕过应用层直接完成业务逻辑的调用,这样是一种不安全的机制. 从对象传递效率上面考虑,领域Model带有业务,而这些业务一般对于UI层是没有意义的,所以带有业务的model传递起来会加重网络负担. 网上还说了DT

AutoMapper安装及基本用法

AutoMapper安装及基本用法 AutoMapper的使用场景 AutoMapper是对象到对象的映射工具.在完成映射规则之后,AutoMapper可以将源对象转换为目标对象. 一般情况下,表现层与应用层之间是通过DTO(数据传输对象Data Transfer Object)来进行交互的,数据传输对象是没有行为的POCO对象(简单CLR对象Plain Old CLR Object),他的目的是为了对领域对象进行数据封装,实现层与层之间的数据传递.为何不直接将领域对象进行数据传递?因为领域对象

使用AutoMapper实现Dto和Model的自由转换（上）

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

对象映射工具AutoMapper介绍

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

.net开源项目

Json.NET http://json.codeplex.com/ Json.NET是一个读写Json效率比较高的.Net框架.Json.Net 使得在.Net环境下使用Json更加简单.通过Linq To JSON可以快速的读写Json,通过JsonSerializer可以序列化你的.Net对象.让你轻松实现.Net中所有类型(对象,基本数据类型等)和Json的转换. Math.NET http://www.mathdotnet.com/ Math.NET的目标是为提供一款自身包含清晰框架的