如何配置ABP框架使用對象映射

小編給大家分享一下如何配置ABP框架使用對象映射，相信大部分人都還不怎么了解，因此分享這篇文章給大家參考一下，希望大家閱讀完這篇文章后大有收獲，下面讓我們一起去了解一下吧！

DTO和實體

實體

實體是領域驅動設計(Domain Driven Design)中的概念，實體通常一一映射某些對象的固有屬性，最常使用的是關系型數據庫中的表。

在 ABP 中，實體位于領域層中，實體類需要實現 IEntity<TKey> 接口或繼承 Entity<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 不是同一個)返回到表示層中，因此表示層與領域層完全隔離。

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

以上是“如何配置ABP框架使用對象映射”這篇文章的所有內容，感謝各位的閱讀！相信大家都有了一定的了解，希望分享的內容對大家有所幫助，如果還想學習更多知識，歡迎關注億速云行業資訊頻道！