C# Mapster 对象映射器

前言

谈到对象映射器，AutoMapper 知名度是非常的高，但很少有人知道 Mapster。而为什么选择 Mapster 呢？

理由一：性能优于 AutoMapper ，相关测试位于https://github.com/MapsterMapper/Mapster上查看。

理由二：多学习一项技能

网上查了一下，关于 Mapster 的资料非常少，所以在这里我们详细写下它的用法，以帮助更多的序员宝快速掌握它的用法。

官方文档：https://github.com/MapsterMapper/Mapster/wiki

安装 Mapster

PM> Install-Package Mapster

 或者 

dotnet add package Mapster

定义实体

目的：使用 Mapster 实现 User 到 UserDto 的映射

public class User
{
    public string Name { get; set; }
    public int Age { get; set; }
    public string Sex { get; set; }
    public string like { get; set; }
}
public class UserDto
{
    public string name { get; set; }
    public int UserAge { get; set; }
    public string UserSex { get; set; }
    public string like { get; set; }
}

简单使用

/*
* 默认情况下，无需任何配置，Mapster会根据两个实体字段名称相同进行匹配
* 第一次调用时，配置会被缓存，第二次将会从缓存中取，以此提升性能
*/
var user = new User();
var dto = user.Adapt();//映射为新对象
user.Adapt(dto);//在目标对象的基础上进行映射
//注意：Adapt扩展方法使用的配置为 `TypeAdapterConfig.GlobalSettings`

Mapster 配置 (TypeAdapterConfig)

可以直接使用 Mapster 内置的全局静态配置 

TypeAdapterConfig.GlobalSettings

，也可以实例化一个配置 

new TypeAdapterConfig()

推荐使用实例化的方式，对 TypeAdapterConfig 进行映射配置。

注：Mapster 默认匹配规则是相同字段名之间进行映射。

方式一

直接在 TypeAdapterConfig 配置对象的映射关系

var config = new TypeAdapterConfig();
//映射规则
config.ForType()
    .Map(dest => dest.UserAge, src => src.Age)
    .Map(dest => dest.UserSex, src => src.Sex);
var mapper = new Mapper(config);//务必将mapper设为单实例
var user = new User{Name = "xiaowang",Age = 18,Sex = "boy"};
var dto = mapper.Map(user);

字段带有前后缀，可以使用 

NameMatchingStrategy.ConvertDestinationMemberName

 对目标字段名称进行替换，使得它和源字段名称相同。

还有替换源字段的方法

NameMatchingStrategy.ConvertSourceMemberName

注意：如果一个

ForType

定义多个

NameMatchingStrategy

，后定义的会覆盖先定义的规则，所以只有最后定义的规则会生效

var config = new TypeAdapterConfig();
//使用
config.ForType()
    .NameMatchingStrategy(NameMatchingStrategy.ConvertDestinationMemberName(dest => dest.Replace("User", "")));

方式二

使用接口的方式，需要实现 

IRegister

//实现接口 IRegister
public class UserDtoRegister : IRegister
{
    public void Register(TypeAdapterConfig config)
    {
        config.ForType()
            Map(dest => dest.UserAge, src => src.Age);
            //...
    }
}
//实例化Mapper
var config = new TypeAdapterConfig();
//var config = TypeAdapterConfig.GlobalSettings;
//只有要给定 IRegister 所在的程序集名称，Mapster 会自动识别 IRegister，进行配置注入。
config.Scan("程序集名称1","程序集名称2");
var mapper = new Mapper(config);//务必设置为单实例

忽略字段

var config = new TypeAdapterConfig();
//映射规则
config.ForType()
    .Map(dest => dest.UserAge, src => src.Age)
    .Map(dest => dest.UserSex, src => src.Sex);
    .IgnoreNullValues(true)//忽略空值映射
    .Ignore(dest => dest.UserAge)//忽略指定字段
    .IgnoreAttribute(typeof(DataMemberAttribute))//忽略指定特性的字段
    .NameMatchingStrategy(NameMatchingStrategy.IgnoreCase)//忽略字段名称的大小写
    .IgnoreNonMapped(true);//忽略除以上配置的所有字段
config.ForType()
    .IgnoreMember((member, side) => !member.Type.Namespace.StartsWith("System"));//实现更细致的忽略规则

member

和

side

分别对应

IMemberModel

和

MemberSide

，这里我贴出相应的源码。

//包含了映射类型的信息
public interface IMemberModel
{
    Type Type { get; }
    string Name { get; }
    object? Info { get; }
    AccessModifier SetterModifier { get; }
    AccessModifier AccessModifier { get; }
    IEnumerable
免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！