網(wǎng)上關(guān)于abp框架的學(xué)習(xí)的文章很多壕吹。本文大部分也是摘自其他作者的文章。
官方api文檔:https://aspnetboilerplate.com/api-docs/html/N_Abp_AutoMapper.htm
簡單說一下
- 什么是AutoMapper?
AutoMapper是一個對象和對象間的映射器辉哥。對象與對象的映射是通過轉(zhuǎn)變一種類型的輸入對象為一種不同類型的輸出對象工作的桦山。讓AutoMapper有意思的地方在于它提供了一些將類型A映射到類型B這種無聊的事情的有趣慣例攒射。只要類型B遵守AutoMapper已經(jīng)建立的慣例,大多數(shù)情況下恒水,映射兩種類型零配置就可以了会放。 - 為什么使用AutoMapper?
映射代碼是無聊的。測試映射代碼更無聊钉凌。AutoMapper提供了一些簡單配置咧最,還有一些簡單的映射測試。真正的問題可能是“為什么使用對象-對象的映射呢”?映射可能發(fā)生在一個應(yīng)用的許多地方御雕,但大多數(shù)情況下都發(fā)生在層與層之間的邊界矢沿,比如UI/Domain層之間,或者Service/Domain層之間酸纲。關(guān)注一層通常和關(guān)注另一層發(fā)生沖突捣鲸,因此對象-對象間的映射來隔離模型model,這樣就只會影響每一層關(guān)注的類型闽坡。 - 如何使用AutoMapper?
定義
Mapper.CreateMap<<CreateNoteDto, Note>>();
使用
Note note = Mapper.Map<Note>(CreateNoteDto);
映射前后操作
偶爾有時候栽惶,在映射發(fā)生之前或之后,你可能需要執(zhí)行一些自定義的邏輯无午。這可能是很少見的事情媒役,因為在AutoMapper之外處理這些事情是更明顯的。你可以創(chuàng)建一個映射前后的全局操作:
Mapper.CreateMap<Source, Dest>()
.BeforeMap((src, dest) => src.Value = src.Value + 10)
.AfterMap((src, dest) => dest.Name = "John");
條件映射
在屬性映射之前宪迟,AutoMapper允許將必須滿足的條件添加到屬性上酣衷。
//創(chuàng)建映射,映射條件是源類型的Age屬性在區(qū)間(0,149)范圍內(nèi)
Mapper.CreateMap<Aliens, Person>().ForMember(dest => dest.Age, opt => opt.Condition(src => src.Age > 0 && src.Age < 149));
配置
初始化是配置AutoMapper受人歡迎的模式次泽,每個應(yīng)用域應(yīng)該配置一次:
//初始化配置文件
Mapper.Initialize(cfg =>
{
cfg.CreateMap<Aliens, Person>();
cfg.AddProfile<AliensPersonProfile>();//添加一個配置文件
});
自定義一個繼承了Profile類的類穿仪,然后重寫Configure方法,在該方法中放一些映射的配置意荤。這個在我們建立的.net core項目中會看見
public class NoteMapProfile : Profile
{
public NoteMapProfile()
{
CreateMap<CreateNoteDto, Note>();
}
}
自定義類型轉(zhuǎn)換
有時啊片,需要完全控制一個類型到另一個類型的轉(zhuǎn)換。一個類型一點都不像另一個類型玖像,而且轉(zhuǎn)換函數(shù)已經(jīng)存在了紫谷,在這種情況下,你想要從一個“寬松”的類型轉(zhuǎn)換成一個更強(qiáng)壯的類型捐寥,例如一個string的源類型到一個int32的目標(biāo)類型笤昨。
這里有兩個類Source和Destination,要把前者映射到后者握恳,代碼如下:
public class Source
{
public string Value1 { get; set; }
public string Value2 { get; set; }
public string Value3 { get; set; }
}
public class Destination
{
public int Value1 { get; set; }
public DateTime Value2 { get; set; }
public Type Value3 { get; set; }
}
public class CustomTypeConverter : ITypeConverter<Source, Destination>
{
public Destination Convert(ResolutionContext context)
{
Source src = context.SourceValue as Source;
var dest = new Destination
{
Value1 = System.Convert.ToInt32(src.Value1),
Value2 = System.Convert.ToDateTime(src.Value2),
Value3 = context.SourceType
};
return dest;
}
}
Mapper.CreateMap<Source, Destination>().ConvertUsing<CustomTypeConverter>();
自定義值解析
雖然AutoMapper覆蓋了相當(dāng)一部分目標(biāo)成員的映射場景瞒窒,但是還有 1-5%的目標(biāo)值需要解析處理一下。很多時候乡洼,自定義的值解析是可以放在領(lǐng)域?qū)拥念I(lǐng)域邏輯崇裁。然而匕坯,如果該邏輯只是和映射操作有關(guān)的話,那它就會應(yīng)為一些不必要的行為使得源類型很凌亂拔稳。這種場合葛峻,AutoMapper允許我們?yōu)槟繕?biāo)成員配置自定義的值解析器。
我們可以實現(xiàn)抽象類ValueResolver<TSource, TDestination>來實現(xiàn)自定義值解析壳炎。例如:
/// <summary>
/// 文章信息
/// </summary>
public class Note
{
/// <summary>
/// 是否發(fā)布
/// </summary>
public bool IsPublic { get; set; }
}
/// <summary>
/// 用于列表展示
/// </summary>
public class NoteDto
{
/// <summary>
/// 是否發(fā)布
/// </summary>
public string IsPublic { get; set; }
}
public class NoteToNoteDtoResolver : IValueResolver<Note, NoteDto, string>
{
public string Resolve(Note source, NoteDto destination, string destMember, ResolutionContext context)
{
return source.IsPublic ? "已發(fā)布" : "未發(fā)布";
}
}
CreateMap<Note, NoteDto>().ForMember(x=>x.IsPublic,opt=> {
opt.ResolveUsing<NoteToNoteDtoResolver>();
});
因為我們只提供了自定義的解析器類型給AutoMapper泞歉,所以映射引擎會使用反射創(chuàng)建該值解析器的實例。如果我們不想要AutoMapper使用反射創(chuàng)建實例匿辩,我們要么直接提供一個實例,要么使用ConstruceBy方法來提供一個自定義的構(gòu)造函數(shù)方法榛丢。在映射操作期間铲球,AutoMapper不使用反射,直接執(zhí)行此回調(diào)函數(shù):
Mapper.CreateMap<Source, Destination>().ForMember(dest => dest.Total, opt =>
{
opt.ResolveUsing<MyValueResolver>().ConstructedBy(()=>new MyValueResolver());
});