当前位置：网站首页>4. 对象映射 - Mapping.Mapstercover

4. 对象映射 - Mapping.Mapstercover

2022-07-01 19:30:00 【InfoQ】

前言

在项目中我们会经常遇到对象的映射，比如像Model和Dto之间的映射，或者是对象的深拷贝，这些都是需要我们自己实现的。此时，项目中会出现很多初始化对象的代码，这些代码写起来相当的枯燥乏味，那么有没有什么办法减轻我们的工作量，使得我们可以把时间花费到业务功能上呢？

目前，.Net中的对象映射框架，功能强大且性能极佳的对象映射框架已经存在，其中使用最多的有:

Mapster

AutoMapper

说到对象映射框架，大家想到的最多的是

AutoMapper

，可能很多人连

Mapster

都没听过，但不可否认的是

Mapster

确实是一个很好的对象映射框架，但由于中文文档的缺失，导致在国内知名度不是很高，今天我们就来介绍一下

Mapster

提供了哪些功能，如何在项目中使用它，

Masa

提供的

Mapster

又做了什么？

Mapster 简介

Mapster

是一个使用简单，功能强大的对象映射框架，自2014年开源到现在已经过去8个年头，截止到现在，github上已经拥有2.6k的star，并保持着每年3次的发版频率，其功能与AutoMapper类似，提供对象到对象的映射、并支持IQueryable到对象的映射，与

AutoMapper

相比，在速度和内存占用方面表现的更加优秀，可以在只使用1/3内存的情况下获得4倍的性能提升，那我们下面就来看看

Mapster

如何使用？

准备工作

新建一个控制台项目
Assignment.Mapster
，并安装
Mapster

 dotnet add package Mapster --version 7.3.0

映射到新对象

新建类
UserDto

 public class UserDto
 {
 public int Id { get; set; }
 
 public string Name { get; set; }
 
 public uint Gender { get; set; }
 
 public DateTime BirthDay { get; set; }
 }

新建一个匿名对象，作为待转换的对象源

 var user = new
 {
 Id = 1,
 Name = &quot;Tom&quot;,
 Gender = 1,
 BirthDay = DateTime.Parse(&quot;2002-01-01&quot;)
 };

将user源对象映射到为目标对象 (UserDto)

 var userDto = user.Adapt<UserDto>();
 Console.WriteLine($&quot;映射到新对象，Name: {userDto.Name}&quot;);

运行控制台程序验证转换成功:

数据类型

除了提供对象到对象的映射，还支持数据类型的转换，如：

基本类型

提供类型映射的功能，类似Convert.ChangeType()

 string res = &quot;123&quot;;
 decimal i = res.Adapt<decimal>(); //equal to (decimal)123;
 Console.WriteLine($&quot;结果为：{i == int.Parse(res)}&quot;);

运行控制台程序:

枚举类型

把枚举映射到数字类型，同样也支持字符串到枚举和枚举到字符串的映射，比.NET的默认实现快两倍

 var fileMode = &quot;Create, Open&quot;.Adapt<FileMode>();//等于 FileMode.Create | FileMode.Open
 Console.WriteLine($&quot;枚举类型转换的结果为：{fileMode == (FileMode.Create | FileMode.Open)}&quot;);

运行控制台程序验证转换成功:

Queryable扩展

Mapster提供了Queryable的扩展，用于实现DbContext的按需查找，例如:

新建类
UserDbContext

 using Assignment.Mapster.Domain;
 using Microsoft.EntityFrameworkCore;
 
 namespace Assignment.Mapster.Infrastructure;
 
 public class UserDbContext : DbContext
 {
 public DbSet<User> User { get; set; }
 
 protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
 {
 var dataBaseName = Guid.NewGuid().ToString();
 optionsBuilder.UseInMemoryDatabase(dataBaseName);//使用内存数据库，方便测试
 }
 }

新建类
User

 public class User
 {
 public int Id { get; set; }
 
 public string Name { get; set; }
 
 public uint Gender { get; set; }
 
 public DateTime BirthDay { get; set; }
 
 public DateTime CreationTime { get; set; }
 
 public User()
 {
 CreationTime = DateTime.Now;
 }
 }

使用基于Queryable的扩展方法
ProjectToType

 using (var dbContext = new UserDbContext())
 {
 dbContext.Database.EnsureCreated();
 
 dbContext.User.Add(new User()
 {
 Id = 1,
 Name = &quot;Tom&quot;,
 Gender = 1,
 BirthDay = DateTime.Parse(&quot;2002-01-01&quot;)
 });
 dbContext.SaveChanges();
 
 var userItemList = dbContext.User.ProjectToType<UserDto>().ToList();
 }

运行控制台程序验证转换成功:

除此之外，

Mapster

还提供了映射前/后处理，拷贝与合并以及映射配置嵌套支持，详细可查看

文档

，既然

Mapster

已经如此强大，那我直接使用它就可以了，为什么还要使用

Masa

提供的Mapper呢？

什么是Masa.Contrib.Data.Mapping.Mapster？

Masa.Contrib.Data.Mapping.Mapster

是基于

Mapster

的一个对象到对象的映射器，并在原来

Mapster

的基础上增加自动获取并使用最佳构造函数映射，支持嵌套映射，减轻映射的工作量。

映射规则

目标对象没有构造函数时：使用空构造函数，映射到字段和属性。

目标对象存在多个构造函数：获取最佳构造函数映射

最佳构造函数: 目标对象构造函数参数数量从大到小降序查找，参数名称一致（不区分大小写）且参数类型与源对象属性一致

准备工作

新建一个控制台项目
Assignment.Masa.Mapster
，并安装
Masa.Contrib.Data.Mapping.Mapster
，
Microsoft.Extensions.DependencyInjection

 dotnet add package Masa.Contrib.Data.Mapping.Mapster --version 0.4.0-rc.4
 dotnet add package Microsoft.Extensions.DependencyInjection --version 6.0.0

新建类
OrderItem

 public class OrderItem
 {
 public string Name { get; set; }
 
 public decimal Price { get; set; }
 
 public int Number { get; set; }
 
 public OrderItem(string name, decimal price) : this(name, price, 1)
 {
 
 }
 
 public OrderItem(string name, decimal price, int number)
 {
 Name = name;
 Price = price;
 Number = number;
 }
 }

新建类
Order

 public class Order
 {
 public string Name { get; set; }
 
 public decimal TotalPrice { get; set; }
 
 public List<OrderItem> OrderItems { get; set; }
 
 public Order(string name)
 {
 Name = name;
 }
 
 public Order(string name, OrderItem orderItem) : this(name)
 {
 OrderItems = new List<OrderItem> { orderItem };
 TotalPrice = OrderItems.Sum(item => item.Price * item.Number);
 }
 }

修改类
Program

 using Assignment.Masa.Mapster.Domain.Aggregate;
 using Masa.BuildingBlocks.Data.Mapping;
 using Masa.Contrib.Data.Mapping.Mapster;
 using Microsoft.Extensions.DependencyInjection;
 
 Console.WriteLine(&quot;Hello Masa Mapster!&quot;);
 
 IServiceCollection services = new ServiceCollection();
 services.AddMapping();
 
 var request = new
 {
 Name = &quot;Teach you to learn Dapr ……&quot;,
 OrderItem = new OrderItem(&quot;Teach you to learn Dapr hand by hand&quot;, 49.9m)
 };
 var serviceProvider = services.BuildServiceProvider();
 var mapper = serviceProvider.GetRequiredService<IMapper>();
 var order = mapper.Map<Order>(request);
 
 Console.WriteLine($&quot;{nameof(Order.TotalPrice)} is {order.TotalPrice}&quot;);//控制台输出49.9
 
 Console.ReadKey();