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對象的屬性值：

image

這樣咱們就完成了一個簡單的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文件夾，文件夾結構以下：

image

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); 測試結果：

image

指定映射字段（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); 測試結果：

image

驗證配置項（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異常：

image

這是由於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); 測試結果：

image

在使用自定義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); 測試結果：

image

條件映射（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)); });