詳解c# AutoMapper 使用方式

更新時(shí)間：2017年12月04日 11:35:31 作者：大穩(wěn)·楊

本篇文章主要介紹了詳解c# AutoMapper 使用方式，小編覺(jué)得挺不錯(cuò)的，現(xiàn)在分享給大家，也給大家做個(gè)參考。一起跟隨小編過(guò)來(lái)看看吧

安裝方式：使用vs自帶的nuget管理工具，搜索AutoMapper ，選擇第一個(gè)安裝到你的項(xiàng)目即可。

先說(shuō)說(shuō)DTO

DTO是個(gè)什么東東？

DTO（Data Transfer Object）就是數(shù)據(jù)傳輸對(duì)象，說(shuō)白了就是一個(gè)對(duì)象，只不過(guò)里邊全是數(shù)據(jù)而已。

為什么要用DTO?

1、DTO更注重?cái)?shù)據(jù)，對(duì)領(lǐng)域?qū)ο筮M(jìn)行合理封裝，從而不會(huì)將領(lǐng)域?qū)ο蟮男袨檫^(guò)分暴露給表現(xiàn)層

2、DTO是面向UI的需求而設(shè)計(jì)的，而領(lǐng)域模型是面向業(yè)務(wù)而設(shè)計(jì)的。因此DTO更適合于和表現(xiàn)層的交互，通過(guò)DTO我們實(shí)現(xiàn)了表現(xiàn)層與領(lǐng)域Model之間的解耦，因此改動(dòng)領(lǐng)域Model不會(huì)影響UI層

3、DTO說(shuō)白了就是數(shù)據(jù)而已，不包含任何的業(yè)務(wù)邏輯，屬于瘦身型的對(duì)象，使用時(shí)可以根據(jù)不同的UI需求進(jìn)行靈活的運(yùn)用

我從網(wǎng)上找了一些資料，

AutoMapper

現(xiàn)在我們既然知道了使用DTO的好處，那么我們肯定也想馬上使用它，但是這里會(huì)牽扯一個(gè)問(wèn)題：怎樣實(shí)現(xiàn)DTO和領(lǐng)域Model之間的轉(zhuǎn)換？

有兩個(gè)思路，我們要么自己寫轉(zhuǎn)換代碼，要么使用工具。不過(guò)就應(yīng)用而言，我還是覺(jué)得用工具比較簡(jiǎn)單快捷，那就使用工具吧。其實(shí)這樣的轉(zhuǎn)換工具很多，不過(guò)我還是決定使用AutoMapper，因?yàn)樗銐蜉p量級(jí)，而且也非常流行，國(guó)外的大牛們都使用它。使用AutoMapper可以很方便的實(shí)現(xiàn)DTO和領(lǐng)域Model之間的轉(zhuǎn)換，它是一個(gè)強(qiáng)大的Object-Object Mapping工具。

下載了個(gè)demo，然后自己又寫了一遍，我把AutoMapper 的使用分為兩種：

1、viewmodel與實(shí)體的字段名字是一致的，viewmodel的字段可以比實(shí)體中的字段少，但是不能多。

還有一種情況是：源實(shí)體中的字段名字是Getxxx，那么viewmodel中對(duì)應(yīng)的字段可以是xxx，也會(huì)自動(dòng)對(duì)應(yīng)賦值，比如我寫的demo中源實(shí)體中GetA,viewmodel中的A；

再有一種情況就是實(shí)體中的實(shí)體賦值，在我寫的這個(gè)例子中，源實(shí)體中包含的實(shí)體類字段為Sub,里面包含的字段名字為Age，

那么destmodel中對(duì)應(yīng)的字段名字可以是：SubAge,那么automapper就可以自動(dòng)為你賦值了，大家看最后的運(yùn)行結(jié)果。

給大家看下我建的源實(shí)體：

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

    public string GetA { set; get; }
    public string GetD { set; get; }


    public string SetB { set; get; }

    public string c { set; get; }

    public SubSource1 Sub { set; get; }
  }


  public class SubSource1
  {
    public string Age { set; get; }

  }

還有viewmodel（要轉(zhuǎn)化成為你想要的模型）：

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

    public string A { set; get; }

    public string C { set; get; }

    public string SubAge { set; get; }

    public string D { set; get; }
  }

我封裝的擴(kuò)展方法：

    /// <summary>
    /// 類型映射,默認(rèn)字段名字一一對(duì)應(yīng)
    /// </summary>
    /// <typeparam name="TDestination">轉(zhuǎn)化之后的model，可以理解為viewmodel</typeparam>
    /// <typeparam name="TSource">要被轉(zhuǎn)化的實(shí)體，Entity</typeparam>
    /// <param name="source">可以使用這個(gè)擴(kuò)展方法的類型，任何引用類型</param>
    /// <returns>轉(zhuǎn)化之后的實(shí)體</returns>
    public static TDestination MapTo<TDestination, TSource>(this TSource source) 
      where TDestination:class 
      where TSource :class 
    {
      if (source == null) return default(TDestination);
      var config = new MapperConfiguration(cfg => cfg.CreateMap<TDestination, TSource>());
      var mapper = config.CreateMapper();
      return mapper.Map<TDestination>(source);
    }

使用方式：

        var source1 = new Source1
        {
          Name = "source",
          Sub = new SubSource1 { Age = "25" },
          c = "c",
          GetA = "A",
          SetB = "B"
        };

        var destViewModel = source1.MapTo<Dest1, Source1>();

運(yùn)行結(jié)果：

2.viewmodel與實(shí)體字段名字沒(méi)有全部對(duì)應(yīng)，只有幾個(gè)字段的名字和源實(shí)體中的字段名字是一樣的，其他的字段是通過(guò)實(shí)體中的幾個(gè)字段組合或者是格式或者是類型轉(zhuǎn)化而來(lái)的，

使用方法：不能再使用這個(gè)擴(kuò)展方法了，只能自己額外寫代碼，代碼如下：

        var config2 = new MapperConfiguration(
          cfg => cfg.CreateMap<SourceUser, DestUser2>()
            .ForMember(d => d.DestName, opt => opt.MapFrom(s => s.Name))  //指定字段一一對(duì)應(yīng)
            .ForMember(d => d.Birthday, opt => opt.MapFrom(src => src.Birthday.ToString("yy-MM-dd HH:mm")))//指定字段，并轉(zhuǎn)化指定的格式
            .ForMember(d => d.Age, opt => opt.Condition(src => src.Age > 5))//條件賦值
            .ForMember(d => d.A1, opt => opt.Ignore())//忽略該字段，不給該字段賦值
            .ForMember(d => d.A1, opt => opt.NullSubstitute("Default Value"))//如果源字段值為空，則賦值為 Default Value
            .ForMember(d => d.A1, opt => opt.MapFrom(src => src.Name + src.Age * 3 + src.Birthday.ToString("d"))));//可以自己隨意組合賦值
        var mapper2 = config2.CreateMapper();

注釋中都包含了平時(shí)常用的幾種情況，其他的我就沒(méi)有再寫。

下面再給大家把list轉(zhuǎn)化的擴(kuò)展方法代碼貼上：

    /// <summary>
    /// 集合列表類型映射,默認(rèn)字段名字一一對(duì)應(yīng)
    /// </summary>
    /// <typeparam name="TDestination">轉(zhuǎn)化之后的model，可以理解為viewmodel</typeparam>
    /// <typeparam name="TSource">要被轉(zhuǎn)化的實(shí)體，Entity</typeparam>
    /// <param name="source">可以使用這個(gè)擴(kuò)展方法的類型，任何引用類型</param>
    /// <returns>轉(zhuǎn)化之后的實(shí)體列表</returns>
    public static IEnumerable<TDestination> MapToList<TDestination, TSource>(this IEnumerable<TSource> source)
      where TDestination : class
      where TSource : class
    {
      if (source == null) return new List<TDestination>();
      var config = new MapperConfiguration(cfg => cfg.CreateMap<TDestination, TSource>());
      var mapper = config.CreateMapper();
      return mapper.Map<List<TDestination>>(source);
    }

同樣的使用方式：

        var source1 = new Source1
        {
          Name = "source",
          Sub = new SubSource1 { Age = "25" },
          c = "c",
          GetA = "A",
          SetB = "B"
        };
var source3 = new Source1
        {
          Name = "source3",
          Sub = new SubSource1 { Age = "253" },
          c = "c3",
          GetA = "A3",
          SetB = "B3"
        };
        var sourceList = new List<Source1> { source1, source3 };
        var destViewModelList = sourceList.MapToList<Dest1, Source1>();

運(yùn)行結(jié)果：