上一篇文章中,我们知道了如何在asp.net中使用Automapper,这次,我们进行深入了解
CreateMap方法
CreateMap是一个单向mapping,也就是说,如果定义了这样的mapper:
AutoMapper.Mapper.CreateMap<Book, BookViewModel>();
我们就可以将Book
映射到BookViewModel
: var bookViewModel = AutoMapper.Mapper.Map<BookViewModel>(book);
; 但是,如果反向映射,则会报错:var book = AutoMapper.Mapper.Map<Book>(bookViewModel);
.
我们当然可以定义多个映射:
AutoMapper.Mapper.CreateMap<Book, BookViewModel>();
AutoMapper.Mapper.CreateMap<BookViewModel, Book>();
但如果两个类没有什么特殊转换,我们也可以简单的使用reverse
映射:
AutoMapper.Mapper.CreateMap<Book, BookViewModel>().ReverseMap();
这样两个类就可以来回互转了。
Conventions-约定
Automapper的最基本约定是,转换源和目标的字段名相同时将会自动对应:
public class Book
{
public string Title { get; set; }
}
public class NiceBookViewModel
{
public string Title { get; set; }
}
public class BadBookViewModel
{
public string BookTitle { get; set; }
}
按照约定,NiceBookViewModel和Book类具有相同字段,可以自动mapping,但是BadBookViewModel字段名不一致所以无法对应。我们就必须自定义映射关系:
AutoMapper.Mapper.CreateMap<Book, BadBookViewModel>()
.ForMember(dest => dest.BookTitle,
opts => opts.MapFrom(src => src.Title));
另一个约定是包含类名称约定,如:
public class Author
{
public string Name { get; set; }
}
public class Book
{
public string Title { get; set; }
public Author Author { get; set; }
}
public class BookViewModel
{
public string Title { get; set; }
public string Author { get; set; }
}
尽管Book类和BookViewModel类都含有Author,(一个是类名,一个是字段名),automaper都无法自动映射。但如果我们对BookViewModel稍作修改:
public class BookViewModel
{
public string Title { get; set; }
public string AuthorName { get; set; }
}
即可以了。其实AuthorName
字段就相当于Author.Name
。
这种约定虽然方便,但还是建议大家手动指定mapper放心一点:
AutoMapper.Mapper.CreateMap<Book, BookViewModel>()
.ForMember(dest => dest.Author,
opts => opts.MapFrom(src => src.Author.Name));
复杂映射
如果Author类是这个样子:
public class Author
{
public string FirstName { get; set; }
public string LastName { get; set; }
}
而我们想将其映射到BookViewModel中,而且用BookViewModel中的一个字段包含全名,该怎么做呢?
AutoMapper.Mapper.CreateMap<Book, BookViewModel>()
.ForMember(dest => dest.Author,
opts => opts.MapFrom(
src => string.Format("{0} {1}",
src.Author.FirstName,
src.Author.LastName)));
对目标类中的Author字段,我们使用源类中的FirstName+LastName进行替换。
更加复杂的映射
上面的例子是将源类在目标类中进行组合,如果我们想使用源类“组合”成目标类怎么办呢?
public class Address
{
public string Street { get; set; }
public string City { get; set; }
public string State { get; set; }
public string ZipCode { get; set; }
}
public class Person
{
public string FirstName { get; set; }
public string LastName { get; set; }
public Address Address { get; set; }
}
public class PersonDTO
{
public string FirstName { get; set; }
public string LastName { get; set; }
public string Street { get; set; }
public string City { get; set; }
public string State { get; set; }
public string ZipCode { get; set; }
}
我们想建立PersonDTO→Person类映射,那可以这样:
AutoMapper.Mapper.CreateMap<PersonDTO, Person>()
.ForMember(dest => dest.Address,
opts => opts.MapFrom(
src => new Address
{
Street = src.Street,
City = src.City,
State = src.State,
ZipCode = src.ZipCode
}));
BTW,这种情况非常多见,前台传进来的表单字段(PersonDTO),可以通过mapping自动组成复杂类(Person),爽歪歪。
mapping到新实例 vs mapping到已有实例
类似这样:var destinationObject = AutoMapper.Mapper.Map<DestinatationClass>(sourceObject);
的语法,举例:var model = Mapper.Map<BookViewModel>(book);
我们将创建一个目标类的新实例。
但有时我们不想创建新实例,比如在Update时,那我们可以用这样的语法:AutoMapper.Mapper.Map(sourceObject, destinationObject);
; 举例:Mapper.Map<BookViewModel>(book,bookViewModel)
数组/列表的mapping
一般情况下,当定义好了mapper,列表就可以被自动mapping,不需要额外代码
var destinationList = AutoMapper.Mapper.Map<List<DestinationClass>>(sourceList);
适用于所有集合类型: List<T>, ICollection<T>, IEnumerable<T>
, etc.