首先,先創建一個控制台項目,引用AutoMapper程序集,創建三個類User,UserDto,UserMappingProfile,下面的知識點的演示都以此項目為基礎,代碼分別如下:
namespace MiddleAutoMapper { public class User { public User() { } public int Age { get; set; } } }
namespace MiddleAutoMapper { public class UserDto { public UserDto(int age) { this.age = age; } private int age; public int Age { get { return age; } } } }
namespace MiddleAutoMapper { public class UserMappingProfile:Profile { protected override void Configure() { //添加配置方法 } } }
namespace MiddleAutoMapper { class Program { static void Main(string[] args) { //初始化配置 Mapper.Initialize(cfg => { cfg.AddProfile<UserMappingProfile>(); }); var u1 = Mapper.Map<UserDto>(new User() {Age = 23}); Console.WriteLine(u1.Age); Console.Read(); } } }
構造
AutoMapper可以根據源類型的成員映射到目標類型的構造函數里:
在UserMappingProfile文件中添加配置方法代碼:
Mapper.CreateMap<User, UserDto>();
因為AutoMapper會對大小不敏感(case insensitive),所以會將User的Age屬性通過UserDto的構造函數進行映射,並對UserDto的私有字段賦值,最后通過公有的Age屬性打印出來。
但是,這是在UserDto的構造函數參數名和User的Age屬性名相同的情況下,如果不相同呢?比如,將構造函數的參數名改為age1呢?
發現報錯了,所以我們要修改配置方法,如下:
Mapper.CreateMap<User, UserDto>().ForCtorParam("age1", opt => opt.MapFrom(src => src.Age));
解釋一下ForCtorParam()方法,看名字是針對構造函數參數的,官方解釋該方法的作用是對於個別的構造函數參數進行自定義配置。該方法有兩個參數,第一個是string類型的構造函數參數名,第二個是一個參數選項Action方法。
我上面這句代碼的意思就是說將目標類型的構造函數的參數“age1”從源類型的Age屬性進行映射。
容器
AutoMapper支持使用靜態服務地址構造自定義值格式化器,自定義值解析器和自定義類型轉換器(后面會說):
Mapper.Initialize(cfg => { cfg.ConstructServicesUsing(ObjectFactory.GetInstance); cfg.CreateMap<Source, Destination>(); });
或者在基於實例的容器使用的動態服務地址(包括子容器或嵌套容器):
var dest = Mapper.Map<Source, Destination>(new Source { Value = 15 }, opt => opt.ConstructServicesUsing(childContainer.GetInstance));
慣例
條件對象映射器
條件對象映射器基於源類型和目標類型之間的條件生成新的類型映射。
首先將User和UserDto的構造函數去掉,配置文件中Configure方法中的代碼只寫入下面這句代碼:
AddConditionalObjectMapper().Where((s, d) => d.Name == s.Name + "Dto");
解釋:如果目標類型的名稱等於源類型的名稱加上“Dto”,那么就生成一個源類型和目標類型的對象映射器。添加了這一句,就不需要CreateMap方法了。
在這連個類中加入屬性:
public string UserName { get; set; }
可見,即使沒有使用CreateMap方法,同樣映射成功了。
成員配置
成員配置就像配置(Configuration)一樣,但是你可以完全控制用什么和不用什么。
Mapper.Initialize(cfg => { cfg.AddMemberConfiguration(); });
AddMemberConfiguration()方法以空白狀態開啟。默認情況下,應用到Configuration中的所有東西都是從這里開始的。
- 命名慣例
AddMemberConfiguration().AddMember<NameSplitMember>();
這句代碼可以獲得默認的命名慣例。也可以通過參數傳遞Lambda重寫源和目標的命名慣例。如果你沒設置任何東西,那么AutoMapper會使用DefaultMember,它會只檢測用到的屬性名稱。PS:如果沒設置這個,那么對象的扁平化(Flattening)就不可用。 - 替換字符
AddMemberConfiguration().AddName<ReplaceName>(_ => _.AddReplace("Ä", "A").AddReplace("í", "i"));
- 識別前后綴
AddMemberConfiguration().AddName<PrePostfixName>(_ => _.AddStrings(p => p.Prefixes, "Get", "get").AddStrings(p => p.DestinationPostfixes, "Set"));
- 特性支持
AddMemberConfiguration().AddName<SourceToDestinationNameMapperAttributesMember>();
這個默認總是開啟的。它會尋找含有“SourceToDestinationMapperAttribute”特性的屬性所在的實例,並且調用用戶定義的isMatch函數類找出匹配的成員。
MapToAttribute是特性之一,它可以匹配基於給定名稱的屬性。
在User類中加入代碼:
[MapToAttribute("Phone")] public string Tel { get; set; }
public string Phone { get; set; }
var u3 = Mapper.Map<UserDto>(new User() {Tel = "123456"}); Console.WriteLine(u3.Phone);//123456
- 獲取AutoMapper默認值
AddMemberConfiguration().AddMember<NameSplitMember>().AddName<PrePostfixName>(_ => _.AddStrings(p => p.Prefixes, "Get"))
如果沒使用AddMemberConfiguration方法,那么這就是Configuration設置的默認值。
擴展性
AddName和AddMember中的每個類型都是基於ISourceToDestinationNameMapper和IChildMemberConfiguration接口的。也可以創建自己的類通過Lambda語句參數來配置屬性,因此你可以微調AutoMapper如何解析屬性映射。
配置文件
配置文件可以加到Profile和ConfigurationStore中。
每一個配置文件都獨立於另外一個,且不會共享任何條件。如果一個映射是從一個配置文件(profile)中的AddConditionalObjectMapper生成的,那么可以使用此配置文件的AddMemberConfigurations來解析屬性映射。