Mapster 高效能物件對映框架

對映配置繼承

隱式繼承對映配置

源型別

Mapster 預設會把源型別的對映配置應用到源型別的子類。

如建立了一個 SimplePoco -> SimpleDto 的對映配置:

TypeAdapterConfig<SimplePoco, SimpleDto>.NewConfig()
    .Map(dest => dest.Name, src => src.Name + "_Suffix");

那麼繼承了 SimplePoco 的 DerivedPoco 也將應用同樣的對映配置：

var dest = TypeAdapter.Adapt<DerivedPoco, SimpleDto>(src); 
//dest.Name = src.Name + "_Suffix"

如果不希望子類使用父類對映配置，可以設定 AllowImplicitSourceInheritance 為 false 關閉繼承：

TypeAdapterConfig.GlobalSettings.AllowImplicitSourceInheritance = false;

目標型別

Mapster 預設不會把目標型別的對映配置應用到目標型別的子類。

可以設定 AllowImplicitDestinationInheritance 開啟:

TypeAdapterConfig.GlobalSettings.AllowImplicitDestinationInheritance = true;

顯示繼承對映配置

可以透過 Inherits 方法顯示的繼承型別對映配置：

TypeAdapterConfig<DerivedPoco, DerivedDto>.NewConfig()
        .Inherits<SimplePoco, SimpleDto>();

子類繼承父類對映配置

可以透過 Include 方法顯示的讓子類繼承父類的對映配置：

TypeAdapterConfig<Vehicle, VehicleDto>.NewConfig()
    .Include<Car, CarDto>();

Vehicle vehicle = new Car { Id = 1, Name = "Car", Make = "Toyota" };
var dto = vehicle.Adapt<Vehicle, VehicleDto>();

dto.ShouldBeOfType<CarDto>();
((CarDto)dto).Make.ShouldBe("Toyota"); // "Make" 屬性在 Vehicle 中不存在

配置例項

在 Mapster 中，預設的配置例項為 TypeAdapterConfig.GlobalSettings ，如果需要在不同場景下有不同的對映配置，Mapster 提供了 TypeAdapterConfig 用於實現此需求：

var config = new TypeAdapterConfig();
config.Default.Ignore("Id");

如何給配置例項新增l型別對映配置？

直接使用 NewConfig 和 ForType 方法即可：

config.NewConfig<TSource, TDestination>()
        .Map(dest => dest.FullName,
            src => string.Format("{0} {1}", src.FirstName, src.LastName));

config.ForType<TSource, TDestination>()
        .Map(dest => dest.FullName,
            src => string.Format("{0} {1}", src.FirstName, src.LastName));

透過將配置例項作為引數傳給 Adapt 方法來應用特定的型別對映配置：

注意！配置例項在程式中一定要作為單例存在，否則會影響效能！

var result = src.Adapt<TDestination>(config);

也可以建立一個指定 TypeAdapterConfig 的 Mapper，使用 Mapper 來做對映：

var mapper = new Mapper(config);
var result = mapper.Map<TDestination>(src);

複製配置例項

如果想從現有的配置中建立配置例項，可以使用 Clone 方法。

例如複製全域性配置例項：

var newConfig = TypeAdapterConfig.GlobalSettings.Clone();

或者複製其它配置例項：

var newConfig = oldConfig.Clone();

Fork 配置

Fork 方法內部直接呼叫 Clone 方法，但是使用 Fork 方法的形式與使用 Clone 方法有些許差別。

Fork 方法透過傳入委託方法直接增加新的對映配置：

var forked = mainConfig.Fork(config => 
				{
					config.ForType<Poco, Dto>()
						.Map(dest => dest.code, src => src.Id);
				});

var dto = poco.Adapt<Dto>(forked);

以上程式碼等同於使用 Clone 方法實現的以下程式碼:

var forked = mainConfig.Clone();
forked.ForType<Poco, Dto>()
      .Map(dest => dest.code, src => src.Id);

var dto = poco.Adapt<Dto>(forked);

配置位置

入口

對映配置應該只初始化並且只進行一次配置。因此在編寫程式碼的時候不能將對映配置和對映呼叫放在同一個地方。

例如下面的例子，執行將會丟擲一個異常:

config.ForType<Poco, Dto>().Ignore("Id");
var dto1 = poco1.Adapt<Dto>(config);

config.ForType<Poco, Dto>().Ignore("Id"); //<--- 這裡將丟擲異常，因為在這之前已經觸發過了對映
var dto2 = poco2.Adapt<Dto>(config);

所以，在編寫程式碼時應該將對映配置和對映呼叫分開，將對映配置放到程式的入口，例如：

Main 方法
Global.asax.cs
Startup.cs

// Application_Start in Global.asax.cs
config.ForType<Poco, Dto>().Ignore("Id");

// in Controller class
var dto1 = poco1.Adapt<Dto>(config);
var dto2 = poco2.Adapt<Dto>(config);

保證配置例項和對映配置在同一位置

將配置例項和對映配置分開，可能會導致程式碼處於不同的位置，在程式碼編寫過程中可能會出現遺漏之類的問題。

使用 Fork 函式可以使配置例項與對映配置在同一位置：

var dto = poco.Adapt<Dto>(
	config.Fork(forked => forked.ForType<Poco, Dto>().Ignore("Id"));

不用擔心效能問題，只有第一次使用配置例項時會編譯，之後的呼叫將從快取中獲取。

在泛型類或方法中使用 Fork

Fork 方法預設使用檔名、行號作為鍵值。但是如果在在泛型類或泛型方法中呼叫Fork方法，必須指定鍵和型別全名稱，防止 Fork 從不同的型別引數返回無效的配置。

IQueryable<TDto> GetItems<TPoco, TDto>()
{
    var forked = config.Fork(
        f => f.ForType<TPoco, TDto>().Ignore("Id"), 
        $"MyKey|{typeof(TPoco).FullName}|{typeof(TDto).FullName}");
    return db.Set<TPoco>().ProjectToType<TDto>(forked);
}

不同的程式集

對映配置處於多個不同的程式集是比較常見的情況。

也許你的域程式集有一些對映到域物件的規則，而你的 web api 有一些特定的規則來對映到您的 api 約定。

Scan 方法

Mapster 支援掃描程式集註冊對映配置，可以幫助你快速註冊對映配置並減小忘記編碼註冊配置的機率。

在某些特定的情況下可以順序註冊程式集，以達到重寫對映配置的目的。

掃描程式集註冊對映配置非常簡單，只需要在程式集中建立一個或多個 IRegister 的實現，然後呼叫 TypeAdapterConfig 例項的 Scan 方法即可：

public class MyRegister : IRegister
{
	public void Register(TypeAdapterConfig config)
	{
		config.NewConfig<TSource, TDestination>();

		//OR to create or enhance an existing configuration
		config.ForType<TSource, TDestination>();
	}
}

使用全域性配置例項掃描程式集中的配置註冊器：

TypeAdapterConfig.GlobalSettings.Scan(assembly1, assembly2, assemblyN)

或使用特定的配置例項掃描程式集中的配置註冊器:

var config = new TypeAdapterConfig();
config.Scan(assembly1, assembly2, assemblyN);

Apply 方法

如果你使用的是其它程式集掃描庫（如 MEF ）, 那麼你可以呼叫配置例項的 Apply 方法將對映配置註冊器新增到配置例項中：

var registers = container.GetExports<IRegister>();
config.Apply(registers);

Apply 方法允許你選擇某些對映配置註冊器新增到配置例項中，而不是像 Scan 方法把程式集裡的所有對映配置註冊器新增到配置例項中：

var register = new MockingRegister();
config.Apply(register);

特性標籤

Mapster 支援透過為型別增加特性標籤的方式新增型別對映配置：

[AdaptTo(typeof(StudentDto), PreserveReference = true)]
public class Student { 
    ...
}

Method	Mean	StdDev	Error	Gen 0	Gen 1	Gen 2	Allocated
'Mapster 6.0.0'	108.59 ms	1.198 ms	1.811 ms	31000.0000	-	-	124.36 MB
'Mapster 6.0.0 (Roslyn)'	38.45 ms	0.494 ms	0.830 ms	31142.8571	-	-	124.36 MB
'Mapster 6.0.0 (FEC)'	37.03 ms	0.281 ms	0.472 ms	29642.8571	-	-	118.26 MB
'Mapster 6.0.0 (Codegen)'	34.16 ms	0.209 ms	0.316 ms	31133.3333	-	-	124.36 MB
'ExpressMapper 1.9.1'	205.78 ms	5.357 ms	8.098 ms	59000.0000	-	-	236.51 MB
'AutoMapper 10.0.0'	420.97 ms	23.266 ms	35.174 ms	87000.0000	-	-	350.95 MB

Mapster 高效能物件對映框架

Mapster 簡介

為什麼選擇 Mapster ？

效能 & 記憶體佔用

基本用法

對映到一個新的物件

對映到現有物件

Queryable Extensions

對映器

擴充套件方法

對映器例項 ( Mapper )

構建器 ( Builder )

資料型別

基本型別

列舉型別

字串型別

集合

可對映物件

對映配置

對映配置

全域性設定

基於規則的對映配置

只配置目標型別

泛型型別對映

對映配置繼承

隱式繼承對映配置

源型別

目標型別

顯示繼承對映配置

子類繼承父類對映配置

配置例項

配置例項

複製配置例項

Fork 配置

配置位置

入口

保證配置例項和對映配置在同一位置

在泛型類或方法中使用 Fork

不同的程式集

Scan 方法

Apply 方法

特性標籤

對映配置驗證和編譯

顯式對映

檢查目標型別程式

驗證對映配置

配置編譯

配置巢狀對映

Fork

Mapster.Tool

安裝 Mapster.Tool

安裝 Mapster

命令列

整合到csproj檔案

手動生成

在Build時自動生成

清理

生成完整型別名

動態輸出和名稱空間

生成Dto和對映程式碼

Sample

相關文章