.Net Dto对象模型 与工具 AutoMapper

编辑于 2020/03/12

一. Dto是什么 '?'

DTO是Data Transfer Object 的简写，既数据传输对象。
那viewModel和DTO又是什么关系呢？
viewModel更偏向于展示的数据，而DTO是数据的传输，用于在服务器与客户端之间或服务器与服务器之间进行数据传递，实际上是不一样的。

二. Dto的作用

DTO本身不是业务对象，他是根据UI需求进行设计的。简单来说Model面向业务，我们是通过后端业务来定义Model的。而DTO是面向UI，通过UI的需求来定义的，通过DTO我们实现了表现层与Model层之间的解耦，表现层不引用Model。如果开发过程中我们的模型变了，而界面没变，我们只需改Model而不需要去改动表现层。

三. 博主的理解

1.举个例子，假设我本身就是个“对象模型”，我是个博主，.net程序员。这些信息是可以暴露出来的，就是dto传输的内容，但是“我”这个对象模型不仅仅包含了这些信息，还有地址，电话。这些信息是我不想暴露出来的

2.再举个例子，一个人的字段信息性别表示在数据库为 null,0,1
在windows客户端可能需要显示“男人”
在ios端可能需要显示“man”
在android端可能需要显示“male”

有些字段我可能不想，也不需要发送给前端接收，有些字段我可能需要加工一下
这就可以通过Dto来实现

四. 实现的方式

环境

visual studio 2019
Core 3.1 WebApi

Models文件

实体类

public class GoodsEntity
{
    public int Id { get; set; }
    public string Name { get; set; }
    public decimal Price { get; set; }
    public DateTime? CreateTime { get; set; }
    public bool IsDeleted { get; set; }
}

Dto类

public class GoodsDto
{
    public string GoodsName { get; set; }
    public decimal Price { get; set; }
    public string CreateTime { get; set; }
    public string Content { get; set; }
    public bool IsDeleted { get; set; }
}

可以发现Dto中3个变化
createTime字段变成了String
没有Id字段
多了Content字段

1. 通过类与类属性赋值来实现

Action方法

这种方式简单，但是当是一个List时，或者属性很多时，就会比较麻烦。

2. 通过AutoMapper实现

1. 安装AutoMapper
   使用nuget搜索AutoMapper安装
   

   AutoMapper包

2. 在Startup中添加AutoMapper

   public void ConfigureServices(IServiceCollection services)
   {
       services.AddControllers();
       #region Automapper
       services.AddAutoMapper(typeof(Startup));
       #endregion
   }
   

3. 创建AutoMapper映射规则，得告诉AutoMapper映射关系

   文件目录

   AutoMapperConfigs.cs

   public class AutoMapperConfigs
   {
       public static MapperConfiguration RegisterMappings()
       {
           return new MapperConfiguration(cfg =>
           {
               cfg.AddProfile(new GoodsProfile());
           });
       }
   }
   

   GoodsProfile.cs

   // 添加你的实体映射关系.
   public class GoodsProfile : Profile
   {
       public GoodsProfile()
       {
           // GoodsEntity转GoodsDto.
           CreateMap<GoodsEntity, GoodsDto>()
               // 映射发生之前
               // 映射之前统一处理
               .BeforeMap((ent, dto) => ent.Price = ent.Price + 10)
               // 默认赋值
               .BeforeMap((src, dest) => src.CreateTime = src.CreateTime == null ? (new DateTime(2012, 12, 12)) : src.CreateTime)
   
   
               // 映射匹配   把GoodsEntity.Name匹配到GoodsDto.Name
               .ForMember(dto => dto.GoodsName, opt => opt.MapFrom(ent => ent.Name))
               .ForMember(dto => dto.CreateTime, opt => opt.MapFrom(ent => ((DateTime)ent.CreateTime).ToString("yyyy-MM-dd")))
               // 匹配的过程中赋值
               .ForMember(dto => dto.Price, opt => opt.MapFrom(ent => ent.Price + 10))
   
   
               // 映射发生之后
               .AfterMap((ent, dto) => dto.GoodsName = dto.Price < 40 ? "N/A." : dto.GoodsName)
               .AfterMap((src, dest) => dest.Content = "完成映射后");
   
   
           // 最简单的匹配，属性字段/类型等完全一致
           // GoodsDto转GoodsEntity.
           CreateMap<GoodsDto, GoodsEntity>();
       }
   }
   

4. 在DtoController中修改添加代码

   [HttpGet]
   [Route(nameof(GetGoods))]
   public ActionResult GetGoods()
   {
       ////实例化实体
       GoodsEntity goodsEntity = new GoodsEntity()
       {
           Id = 1,
           Name = "商品1",
           Price = 23.25M,
           CreateTime = DateTime.Now,
           IsDeleted = true,
       };
   
       var goodsDtos = _mapper.Map<GoodsDto>(goodsEntity);
       return Ok(goodsDtos);
   }
   

5. 运行后结果如下

   
   运行结果

源码链接

下载dtoAutoMapper分支即可

码云