對象映射 - mapping.mapster

前言

在項目中我們會經常遇到對象的映射，比如像 model 和 dto 之間的映射，或者是對象的深拷貝，這些都是需要我們自己實現的。此時，項目中會出現很多初始化對象的代碼，這些代碼寫起來相當的枯燥乏味，那麼有沒有什麼辦法減輕我們的工作量，使得我們可以把時間花費到業務功能上呢？

目前.net 中的對象映射框架，功能強大且性能極佳的對象映射框架已經存在，其中使用最多的有:

说到对象映射框架，大家想到的最多的是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 = "Tom",
    Gender = 1,
    BirthDay = DateTime.Parse("2002-01-01")
};

將 user 源對象映射到目標對象 (userdto)

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

運行控制台程式驗證轉換成功:

映射到新对象

數據類型

除了提供對象到對象的映射，還支持數據類型的轉換，如：

基本類型

提供類型映射的功能，類似 convert.changetype()

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

運行控制台程式:

基本类型转换

枚舉類型

把枚舉映射到數字類型，同樣也支持字符串到枚舉和枚舉到字符串的映射，比.net 的默認實現快兩倍

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

運行控制台程式驗證轉換成功:

枚举类型转换

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 = "Tom",
        Gender = 1,
        BirthDay = DateTime.Parse("2002-01-01")
    });
    dbContext.SaveChanges();

    var userItemList = dbContext.User.ProjectToType<UserDto>().ToList();
}

運行控制台程式驗證轉換成功:

Queryable扩展

除此之外，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("Hello Masa Mapster!");

IServiceCollection services = new ServiceCollection();
services.AddMapping();

var request = new
{
    Name = "Teach you to learn Dapr ……",
    OrderItem = new OrderItem("Teach you to learn Dapr hand by hand", 49.9m)
};
var serviceProvider = services.BuildServiceProvider();
var mapper = serviceProvider.GetRequiredService<IMapper>();
var order = mapper.Map<Order>(request);

Console.WriteLine($"{nameof(Order.TotalPrice)} is {order.TotalPrice}");//控制台输出49.9

Console.ReadKey();

如果轉換成功，totalprice 的值應該是 49.9，那麼我們運行控制台程式來驗證轉換是否成功：

Mapping.Mapster

如何實現

上面我们提到了Masa.Contrib.Data.Mapping.Mapster可以自动获取并使用最佳构造函数映射，进而完成对象到对象的映射，那么它是如何实现的呢？会不会对性能有什么影响呢？

做到自动获取并使用最佳构造函数映射是使用的Mapster提供的构造函数映射的功能，通过指定构造函数，完成对象到对象的映射。

查看文档

總結

目前Masa.Contrib.Data.Mapping.Mapster的功能相对较弱，当前版本与Mapster的相比仅仅增加了一个自动获取并使用最佳构造函数的功能，让我们在面对无空构造函数且拥有多个构造函数的类时也能轻松的完成映射，不需要额外多写一行代码。

但我觉得Masa版的 Mapping 最大的好处是项目依赖的是BuildingBlocks下的IMapper，而不是Mapster，这也就使得我们的项目与具体的映射器实现脱离，如果我们被要求项目必须要使用AutoMapper，只需要实现AutoMapper版的IMapper即可，无需更改太多的业务代码，仅需要更换一下引用的包即可，这也是BuildingBlocks的魅力所在