AutoMapper的基本用法
AutoMapper的使用场景安装AutoMapper注册AutoMapperProfile的用法控制器中注入你的IMapper创建Model对象和Dto对象单个对象转Dto多个对象转Dto
AutoMapper的使用场景
AutoMapper是对象到对象的映射工具。在完成映射规则之后,AutoMapper可以将源对象转换为目标对象。 一般情况下,表现层与应用层之间是通过DTO(数据传输对象Data Transfer Object)来进行交互的,数据传输对象是没有行为的POCO对象(简单CLR对象Plain Old CLR Object),他的目的是为了对领域对象进行数据封装,实现层与层之间的数据传递。为何不直接将领域对象进行数据传递?因为领域对象更注重领域,DTO更注重数据。由于“富领域模型”的特点,这样会直接将领域对象的行为暴露给表现层。 DTO本身不是业务对象,它是根据UI需求进行设计的。简单来说Model面向业务,我们是通过业务来定义Model的。而DTO是面向UI,通过UI的需求来定义的,通过DTO我们实现了表现层与Model层之间的解耦,表现层不引用Model。如果开发过程中我们的模型变了,而界面没变,我们只需改Model而不需要去改动表现层。
安装AutoMapper
从NuGet程序包中搜索:AutoMapper,下载对应的包,安装即可。
注册AutoMapper
Core项目在StartUp中的ConfigureServices方法中注册: services.AddAutoMapper(); 否则在Global文件中注册: protected override void Application_Start(object sender, EventArgs e) { AutoMapperConfig.RegisterMappings(); }
Profile的用法
Profile提供了一个命名的映射类,所有继承自Profile类的子类都是一个映射集合。这里我创建了一个UserProfile继承Profile类。 CreateMap创建映射规则。 BeforeMap:在映射之前执行的方法。 AfterMap:反之,映射之后执行的方法。 自动扁平化映射:AutoMapper会将类中的属性进行分割,或匹配“Get”开头的方法。 ForMember:指定映射字段。
public class UserProfile : Profile
{
//添加你的实体映射关系.
public UserProfile()
{
//UserInfoEntity转UserInfoDto.
CreateMap<UserInfo, UserInfoDTO>()
.BeforeMap((source, dto) =>
{
//可以较为精确的控制输出数据格式
//dto.CreateTime = Convert.ToDateTime(source.CreateTime).ToString("yyyy-MM-dd");
if (string.IsNullOrEmpty(source.GetCreateTime))
{
source.GetCreateTime = Convert.ToDateTime(source.GetCreateTime).ToString("yyyy-MM-dd");
}
//dto.Role = "admin";
})
//指定映射字段。将UserInfo.GetCreateTime映射到UserInfoDTO.TestTime
.ForMember(dto => dto.TestTime, opt => opt.MapFrom(info => info.GetCreateTime))
.ForMember(dto => dto.Role, opt => opt.Ignore())
.ForMember(dto => dto.CreateTime, opt => opt.Ignore());
CreateMap<StudentInfo, UserInfoDTO>();
}
}
控制器中注入你的IMapper
private readonly IMapper _mapper;
public ValuesController(IMapper mapper)
{
_mapper = mapper;
}
创建Model对象和Dto对象
public class UserInfo
{
private string _username;
private string _userpwd;
private string _getcreatetime = DateTime.Now.ToShortDateString();
public string UserName
{
get { return _username; }
set { _username = value; }
}
public string UserPwd
{
get { return _userpwd; }
set { _userpwd = value; }
}
public string GetCreateTime
{
get { return _getcreatetime; }
set { _getcreatetime = value; }
}
}
public class UserInfoDTO
{
private string _username;
private string _userpwd;
private string _role;
private DateTime _createtime;
private string _testtime;
public string UserName
{
get { return _username; }
set { _username = value; }
}
public string UserPwd
{
get { return _userpwd; }
set { _userpwd = value; }
}
public string Role
{
get { return _role; }
set { _role = value; }
}
public DateTime CreateTime
{
get { return _createtime; }
set { _createtime = value; }
}
public string TestTime
{
get { return _testtime; }
set { _testtime = value; }
}
}
单个对象转Dto
public UserInfoDTO GetUserDto()
{
//模拟数据
var user = new UserInfo() { UserName = "临沂", UserPwd = "9527" };
//单个实体对象转单个Dto对象.
var userDto = _mapper.Map<UserInfoDTO>(user);
return userDto ;
}
多个对象转Dto
public class StudentInfo
{
private string _stuname;
private string _stuno;
private DateTime _createtime = DateTime.Now;
private string _username;
public string UserName
{
get { return _username; }
set { _username = value; }
}
public string StuName
{
get { return _stuname; }
set { _stuname = value; }
}
public string StuNo
{
get { return _stuno; }
set { _stuno = value; }
}
public DateTime CreateTime
{
get { return _createtime; }
set { _createtime = value; }
}
}
public UserInfoDTO GetUserStuDto()
{
//模拟数据
var user = new UserInfo() { UserName = "临沂", UserPwd = "9527" };
var stu = new StudentInfo() { StuName = "stu", StuNo = "007", UserName = "kobi" };
//单个实体对象转单个Dto对象.
var userDto = _mapper.Map<UserInfoDTO>(user);
//多个实体对象转单个Dto对象
var finalDto = _mapper.Map(stu, userDto);
return finalDto;
}
以上。 如有不合理的地方或更好的建议,请不吝赐教,谢谢!