• 基礎
  • DTO和實體
  • 麻煩的對映
  • AutoMapper 整合
  • IObjectMapper/ObjectMapper
  • 物件拓展

本篇主要講解 ABP 中如何配置、使用物件對映，其中大部分跟 AutoMapper 這個框架有關，建議讀者預先學習這個框架，可參考筆者的另一篇部落格：淺入 AutoMapper

基礎

DTO和實體

實體

實體是領域驅動設計(Domain Driven Design)中的概念，實體通常一一對映某些物件的固有屬性，最常使用的是關係型資料庫中的表。

在 ABP 中，實體位於領域層中，實體類需要實現 IEntity<TKey>

public class Book : Entity<Guid>
{
    public string Name { get; set; }

    public float Price { get; set; }
}

DTO

資料傳輸物件(Data Transfer Object），作為資料傳輸過程中的資料模型，用於在應用層和表示層之間傳輸資料。

在 ABP 中，DTO 位於應用服務層，即本系列文章示例原始碼中的 AbpBase.Application 專案。

通常表示層或其它型別的客戶端呼叫應用服務時，將 DTO 作為引數傳遞，它使用領域物件（實體）執行某些特定的業務邏輯

DTO 類 可能會跟 實體類的欄位/屬性高度相似，為每個服務的每個方法建立 DTO 類可能會很枯燥且費時間。

ABP 的 DTO 類示例如下：

    public class ProductDto : EntityDto<Guid>
    {
        public string Name { get; set; }
        //...
    }

麻煩的對映

前面提到，領域層和應用服務層是要隔離的，例如以下虛擬碼：

class HomeController
{
    AddService _service;
    
    [HttpPost]
    public int AddEquip(EquipDto dto)
    {
        return _service.Add(dto).Id;
    }
}

class AddService
{
    DataContext _context;  
    EquipDto Add(EquipDto dto)
    {
        Equip equip = new Equip()
        {
          Name = dto.Name;  
        };
        _context.Equip.Add(equip);
        _context.SaveChange();
        dto.Id = equip.Id;
        return dto;
    }
}

class EquipDto
{
    int Id;
    string Name;
}

----------

class Equip
{
    int Id;
    string Name;
}
 

這樣每次都需要手動為 DTO 類和 實體類手動對欄位賦值對映，當一個實體有數十個欄位時，寫出的程式碼會很冗長，而且容易忽略了某些欄位，最終導致了 Bug。

大家都知道， AutoMapper 正好可以解決這個問題。

AutoMapper 整合

ABP 的 Volo.Abp.AutoMapper 模組封裝或集成了 AutoMapper，所以我們正好使用模組，為 ABP 應用定義物件對映。

關於 AutoMapper 的使用，如何配置 Profile 等，筆者已經單獨寫到 淺入 AutoMapper，請點選連結另外學習 AutoMapper 的使用。

我們可以在 AbpBase.Application 專案中，新建 一個 AbpBaseApplicationAutoMapperProfile.cs 檔案，這個檔案用於實現 Profile 以及定義對映。將服務領域的對映集中到這個檔案中；或者新建一個 Profiles 資料夾，在其中存放一些 Profile 類。

其內容如下：

    public class AbpBaseApplicationAutoMapperProfile:Profile
    {
        public AbpBaseApplicationAutoMapperProfile()
        {
            //base.CreateMap<MyEntity,MyDto>();
        }
    }

定義完畢後，需要配置 AutoMapper 依賴注入，可在 AbpBaseApplicationModule 的 ConfigureServices 方法中，增加以下程式碼：

            Configure<AbpAutoMapperOptions>(options =>
            {
                // 以模組為單位註冊對映
                options.AddMaps<AbpBaseApplicationModule>();
                //// 以單個 Profiel 為單位註冊對映
                //options.AddProfile<AbpBaseApplicationAutoMapperProfile>();
            });

在 Debug 階段，我們擔心專案改動程式碼時，新增的欄位忘記了加入到對映配置中，或者其它情況，在 AutoMapper 中，我們可以使用 configuration.AssertConfigurationIsValid(); 來檢查對映；在 ABP 中則可使用 validate: true 引數來開啟檢查。

            Configure<AbpAutoMapperOptions>(options =>
            {
                // 以模組為單位註冊對映
                options.AddMaps<AbpBaseApplicationModule>(validate: true);
                //// 以單個 Profiel 為單位註冊對映
                //options.AddProfile<AbpBaseApplicationAutoMapperProfile>(validate: true);
            });

IObjectMapper/ObjectMapper

在 AbpBase.Application 專案中，新增 Nuget 包，搜尋 Volo.Abp.ObjectMapping 並下載相應的穩定版本。

IObjectMapper 有兩個，一個是 AutoMapper 的介面，一個是 Volo.Abp.ObjectMapping 的 泛型介面。

AutoMapper 的 IObjectMapper 不好用，所以別用；用 Volo.Abp.ObjectMapping 的 IObjectMapper <介面>。

ObjectMapper 是 AutoMapper 中的，我們可以直接在控制器等位置，使用 ObjectMapper 注入，然後通過 ObjectMapper 例項對映物件。

ObjectMapper 只有 .Map() 這個方法用得順手。

        private readonly ObjectMapper<T1,T2> _mapper;
        public TestController(ObjectMapper<T1,T2> mapper)
        {
            _mapper = mapper;

            // ... 使用示例
            _ = mapper.Map<T1> ();
        }

也可以通過依賴注入使用 IObjectMapper 介面。

但是因為 ObjectMapper 是泛型類，每種型別的 DTO 都要注入一次的話，會很麻煩，因此這種方案也可以拋棄。

而 泛型的 IObjectMapper<TModule> 是一個抽象，我們使用 IObjectMapper<TModule> 做依賴注入的話，後續如果替換為別的物件對映框架，則不需要修改原有程式碼即可完成替代。而且 IObjectMapper<TModule> 比較舒服。

使用示例：

        private readonly IObjectMapper<AbpBaseApplicationModule> _mapper;
        public TestController(IObjectMapper<AbpBaseApplicationModule> mapper)
        {
            _mapper = mapper;

            // ... 使用示例
            _ = mapper.Map<...>();
        }

物件拓展

ABP框架提供了 實體擴充套件系統 允許你 新增額外屬性 到已存在的物件 無需修改相關類。這句話是抄 ABP 官方文件的。

要支援物件拓展對映，則需要開啟配置：

public class MyProfile : Profile
{
    public MyProfile()
    {
        CreateMap<User, UserDto>()
            .MapExtraProperties();
    }
}

時間有限，筆者這裡只把官方文件的內容講清楚，讀者看完後，需要繼續查閱官方文件，完整了解物件拓展。

ObjectExtensionManager 是一個拓展物件對映類，可以顯式為類拓展一些額外的屬性，這個型別在 Volo.Abp.ObjectMapping 中定義。

ObjectExtensionManager 是一個型別，但是我們不能直接 new 它，或者使用依賴注入，只能通過 ObjectExtensionManager.Instance 這個屬性獲取新的型別。我們無需關心它是用了啥設計模式，還是因為快取之類的原因這樣設計。

ObjectExtensionManager 有兩種屬性，其說明如下：

• AddOrUpdate ：是定義物件額外屬性或更新物件額外屬性的主要方法；
• AddOrUpdateProperty：快捷地定義單個拓展屬性的方法；

AddOrUpdateProperty 用於定義單個屬性，AddOrUpdate 是一個容器，可以包含多個 AddOrUpdateProperty 。

AddOrUpdateProperty 示例程式碼如下：

ObjectExtensionManager.Instance
    .AddOrUpdateProperty<TestA, string>("Name");
// 為 TestA 類添加了一個 G 屬性

AddOrUpdate 的示例程式碼如下：

ObjectExtensionManager.Instance
    .AddOrUpdate<TestA>(options =>
        {
            options.AddOrUpdateProperty<string>("Name");
            options.AddOrUpdateProperty<bool>("Nice");
        }
    );

當然，我們還可以同時為多個型別同時定義一個額外的屬性：

ObjectExtensionManager.Instance
    .AddOrUpdateProperty<string>(
        new[]
        {
            typeof(TestA),
            typeof(TestB),
            typeof(TestC)
        },
        "Name"
    );

如果需要定義多個屬性，則可以使用 AddOrUpdate：

            ObjectExtensionManager.Instance
                .AddOrUpdate(options =>
                {
                    options.AddOrUpdateProperty<string>("Name");
                }, new[]{
                    typeof(TestA),
                    typeof(TestB)
                    });

另外它還可以設定預設值、增加驗證規則等，這些筆者就不再贅述，讀者感興趣可以點選連結進入官方文件檢視。

https://docs.abp.io/zh-Hans/abp/latest/Object-Extensions#validation