AutoMapper搬運工之初探AutoMapper

寫在前面

知道AutoMapper很久了，但是一直沒有用，最近剛好有個場景需要就用了，果然是利器。看了git上的wiki，發現內容其實wiki上寫的很全面了，深入的暫時還沒挖掘到。不過和群里的朋友交流了下，覺得充當下搬運工，小小的翻譯下還是挺好的，小弟不才，希望看客大牛們輕拍磚。

什么是AutoMapper?

 AutoMapper是一個完善的Mapping工具，所謂Mapping即數據對象轉換，借用群里朋友的話是多用於領域對象和DTO對象的Mapping或者是SqlDataReader的Mapping。

 Git主頁：https://github.com/AutoMapper/AutoMapper

 Wiki主頁：https://github.com/AutoMapper/AutoMapper/wiki

簡單的例子

場景是這樣的在訂單業務里，有Order、Customer、Product三個對象如下，其中Product被包含在OrderLinItem對象中：

public class Order
{
　　private readonly IList<OrderLineItem> _orderLineItems = new List<OrderLineItem>();

　　public Customer Customer { get; set; }

　　public OrderLineItem[] GetOrderLineItems()
　　{
　　　　return _orderLineItems.ToArray();
　　}

　　public void AddOrderLineItem(Product product, int quantity)
　　{
　　　　_orderLineItems.Add(new OrderLineItem(product, quantity));
　　}

　　public decimal GetTotal()
　　{
　　　　return _orderLineItems.Sum(li => li.GetTotal());
　　}
}
}

public class OrderLineItem
{
　　public OrderLineItem(Product product, int quantity)
　　{
　　　　Product = product;
　　　　Quantity = quantity;
　　}

　　public Product Product { get; private set; }
　　public int Quantity { get; private set;}

　　public decimal GetTotal()
　　{
　　　　return Quantity*Product.Price;
　　}
}

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

public class Product
{
　　public decimal Price { get; set; }
　　public string Name { get; set; }
}

　　然后在頁面上我需要展示一些數據，為了保持頁面ViewModel的獨立，定義一個DTO（OrderDto）只包含了頁面需要的字段，如下：

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

然后問題來了，怎么轉換呢？

我想最簡單的方法肯定是這樣子：

//定義一個order
var customer = new Customer
{
    Name = "George Costanza";
}
var order = new Order
{
    Customer = customer;
}
var bosco = new Product
{
    Name = "Bosco",
    Price = 4.99m;
}
order.AddOrderLineItem(bosco, 15);

//轉換
var dto = new OrderDto();
dto.CustomerName = order.Customer.Name;
dto.Total = order.GetTotal();

上面的代碼看起來很簡單沒什么問題，但是如果dto屬性有很多個呢？反復的手動Mapping會不會有點累？這時候攻城獅就得發揮偷懶精神，以下是使用了AutoMapper的代碼：

// 配置一個 AutoMapper 映射

Mapper.CreateMap<Order, OrderDto>();

// 執行 mapping
OrderDto dto = Mapper.Map<Order, OrderDto>(order);

是不是很簡單簡潔了，但是細心的會發現，這個Mapping稍微有點復雜，CustomerName對應的是order.Customer.Name;Total對應的是GetTotal方法。AutoMaper是如何做到，又是如何定義這個規則的呢？

AutoMapper的簡單默認Mapping規則

1. 針對復雜對象到簡單對象的映射，Mapping遵循駝峰命名的規則，即當目標dto屬性名稱在源對象中找不到時，AutoMapper會根據駝峰命名規則拆分dto屬性名（例如：CustomerName=>Customer.Name）去尋找相應的關系。

2. 針對是源對象中存在Get開頭的屬性（例如 Total => GetTotal），如果找不到同名屬性，則會匹配Get+PropertyName的方法。

 

本文搬運自AutoMapper Wiki之Flattening：https://github.com/AutoMapper/AutoMapper/wiki/Flattening

上面的規則是最簡單的匹配規則，對於復雜的Mapping，完全不符合上面的兩條特性的，那么就需要進行Mapping的自定義配置，下節 《AutoMapper之自定義映射》里，我會為大家搬運。有啥疑問和意見可以給我留言，咱們來探討一番，請大拿不吝賜教～！