詳解c# AutoMapper 使用方式

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

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

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

先說說DTO

DTO是個什么東東？

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

為什么要用DTO?

1、DTO更注重數(shù)據(jù)，對領域對象進行合理封裝，從而不會將領域對象的行為過分暴露給表現(xiàn)層

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

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

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

AutoMapper

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

有兩個思路，我們要么自己寫轉換代碼，要么使用工具。不過就應用而言，我還是覺得用工具比較簡單快捷，那就使用工具吧。其實這樣的轉換工具很多，不過我還是決定使用AutoMapper，因為它足夠輕量級，而且也非常流行，國外的大牛們都使用它。使用AutoMapper可以很方便的實現(xiàn)DTO和領域Model之間的轉換，它是一個強大的Object-Object Mapping工具。

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

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

還有一種情況是：源實體中的字段名字是Getxxx，那么viewmodel中對應的字段可以是xxx，也會自動對應賦值，比如我寫的demo中源實體中GetA,viewmodel中的A；

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

那么destmodel中對應的字段名字可以是：SubAge,那么automapper就可以自動為你賦值了，大家看最后的運行結果。

給大家看下我建的源實體：

  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（要轉化成為你想要的模型）：

  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; }
  }

我封裝的擴展方法：

    /// <summary>
    /// 類型映射,默認字段名字一一對應
    /// </summary>
    /// <typeparam name="TDestination">轉化之后的model，可以理解為viewmodel</typeparam>
    /// <typeparam name="TSource">要被轉化的實體，Entity</typeparam>
    /// <param name="source">可以使用這個擴展方法的類型，任何引用類型</param>
    /// <returns>轉化之后的實體</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>();

運行結果：

2.viewmodel與實體字段名字沒有全部對應，只有幾個字段的名字和源實體中的字段名字是一樣的，其他的字段是通過實體中的幾個字段組合或者是格式或者是類型轉化而來的，

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

        var config2 = new MapperConfiguration(
          cfg => cfg.CreateMap<SourceUser, DestUser2>()
            .ForMember(d => d.DestName, opt => opt.MapFrom(s => s.Name))  //指定字段一一對應
            .ForMember(d => d.Birthday, opt => opt.MapFrom(src => src.Birthday.ToString("yy-MM-dd HH:mm")))//指定字段，并轉化指定的格式
            .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();

注釋中都包含了平時常用的幾種情況，其他的我就沒有再寫。

下面再給大家把list轉化的擴展方法代碼貼上：

    /// <summary>
    /// 集合列表類型映射,默認字段名字一一對應
    /// </summary>
    /// <typeparam name="TDestination">轉化之后的model，可以理解為viewmodel</typeparam>
    /// <typeparam name="TSource">要被轉化的實體，Entity</typeparam>
    /// <param name="source">可以使用這個擴展方法的類型，任何引用類型</param>
    /// <returns>轉化之后的實體列表</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>();

運行結果：