使用 AutoMapper 處理類別之間的對映轉換

以往使用傳統 ADO.NET 方式對資料庫存取資料時都會碰上資料對映的處理，這是指已經在系統中使用物件導向開發的情況（而沒有使用物件導向的程式中大多是不會遇到這個問題），當從資料庫取得資料後為了要對映到我們所定義的類別，如果沒有使用輔助方法的話，很多人都是乖乖地在程式中去將一筆筆的資料做迴圈處理，然後再一個欄位對映到類別指定的屬性，因為這樣一筆一筆地對映實在太花時間了，所以就有很多輔助方法的產生，有些人會自己寫，而我則是使用 Enterprise Library Data Access Application Block 裡的 RowMapper 方法，在我之前的文章也曾經介紹過，如下：

「簡述 Oracle + Enterprise Library 5.0 Data Access Application Block 的操作」
「Entity Framework 與 Stored Procedure - 回傳多種資料集」

而 Microsoft MVP - 91 也曾經發表了他所設計的 RowMapper 模組「[.NET]RowMapper模組」「[.NET]透過 T4 產生對應 DB table 的 entity」，都是用在資料與類別對映的處理上。

而到了完全以物件導向開發的時候，尤其是已經在專案中使用 ORM Solution，如：ADO.NET Entity Framework or nHibernate 等，大多都是資料庫的 Table 對映到專案的類別，這一段的對映處理不必由我們動手做，在大部分的專案開發上都是一個類別用到底，但有些專案開發時會因為需求而產生了 一些類別，這些類別的屬性可能來自不同的原生類別，而在 ASP.NET MVC 裡最常碰到的就是 ViewModel 類別，而處理這些類別的對映，又遇到上面我所描述過的狀況，如果沒有使用輔助方法的話，又需要一筆一筆資料去做對映，但只少比一般 ADO.NET 的對映處理已經是方便許多，而 AutoMapper 就是可以幫我們簡化這種類別之間的對映轉換處理，讓程式在處理時可以更加簡易也可以更加優雅些，也可以省下更多的開發時間；接著就來讓我簡單介紹怎麼使用 AutoMapper。

 

---

先來看看之前文章所遇到的狀況，可以先看「Entity Framework 與 Stored Procedure - 基本的 Select」做個了解，在那篇文章裡是使用 EF 執行 Stored Procedure 然後取得資料，而所取得的資料是 Customer 資料，取回的是全部的欄位，但是執行 Stored Procedure 所取得的資料在最後由 EF 所回傳後的物件類別並不是預設 Entity Framework 對映 Table 所產生的類別，而是「ObjectResult<T>」，如下：

在 CustomerController 需要去面對兩個結構大致相同的類別，如果後續要處理這種資料類別轉換的情況越來越多，那麼 CustomerController 就會需要面對很多的類別，而這些類別的結構彼此又有很多雷同，那個混亂的情況也就會越來越多。

其實可以把這個可能發生的情形給單純化，那就是在 CustomerController 所要處理的類別只有一種「Customer」，而至於那些由 EF 去執行 Stored Procedure 所產生的 ObjectResult<T> 就當做是一種 DTO（Data Transfer Object），只是用來傳輸資料而已，不需要拿到流程控制或是商業邏輯處理中。

但如果像我所說的要把 ObjectResult<T> 轉換成指定類別時，最常見的作法：

如果欄位少的話是還好，如果欄位數量多的話，這樣的處理光是想就很累人，有些開發人員就會使用 Reflection 去寫個專門處理這個類別對映轉換的方法， 不過我會優先考慮使用 AutoMapper 來做這樣的處理。

 

---

AutoMapper

http://automapper.org/
https://github.com/AutoMapper/AutoMapper

 

安裝

我們在 Visual Studio 裡透過 NuGet 安裝 AutoMapper 到專案中，

 

使用

我們把剛剛的那個手動對映的程式改用 AutoMapper 來處理，首先要先建立好怎麼對映，

然後再使用 Map() 方法執行對映，

完成的程式內容，

與之前的手動對映做個比較，兩者比較之下就知道差別了，

下個中斷點做個觀察，可以看到資料都有對映，除了關連屬性，

 

設定忽略屬性對映

以上面的例子，建立對映是使用預設處理，會由 AutoMapper 去判斷 Source 類別與 Destination 類別的屬性然後去做對映，這通常是會用在兩個結構一致的情況，有的時候會有些屬性是不必去做對映處理，例如 usp_GetAllCustomerResult 就沒有 Customer 的 CustomerDemographics 與 Orders 屬性，所以我們可以設定忽略這兩個數性的對映處理，

 

自定對映格式化

如果現在 usp_GetAllMember_Result 要做對映轉換的類別不是 Customer 而是另一個自定類別時，例如一個 ViewModel，

其中有些屬性是需要做字串組合的，例如 ContactData 是 ContactName + ContactTitle，FullAddress 是 Country + City + PostalCode + Address，那麼我們可以在建立對映的時侯使用 ForMember() 方法去對對映的值做處理，

執行結果

 

---

這一篇就先介紹到這裡，從簡單的設定以進階一點的設定來入門，AutoMapper 在 ASP.NET MVC 的應用中最常拿來用在 ViewModel 的對映上，也的確簡化了設定以及編輯程式的時間，同時也可以藉由設定來統一管理 Entity Model 與 ViewModel 的對映，減少各種對映的散亂，所以下一篇就來說明有關 Configuration 的部份。

 

以上