Mapster 高性能对象映射框架

映射配置继承

隐式继承映射配置

源类型

Mapster 默认会把源类型的映射配置应用到源类型的子类。

如创建了一个 SimplePoco -> SimpleDto 的映射配置:

TypeAdapterConfig<SimplePoco, SimpleDto>.NewConfig()
    .Map(dest => dest.Name, src => src.Name + "_Suffix");

那么继承了 SimplePoco 的 DerivedPoco 也将应用同样的映射配置：

var dest = TypeAdapter.Adapt<DerivedPoco, SimpleDto>(src); 
//dest.Name = src.Name + "_Suffix"

如果不希望子类使用父类映射配置，可以设置 AllowImplicitSourceInheritance 为 false 关闭继承：

TypeAdapterConfig.GlobalSettings.AllowImplicitSourceInheritance = false;

目标类型

Mapster 默认不会把目标类型的映射配置应用到目标类型的子类。

可以设置 AllowImplicitDestinationInheritance 开启:

TypeAdapterConfig.GlobalSettings.AllowImplicitDestinationInheritance = true;

显示继承映射配置

可以通过 Inherits 方法显示的继承类型映射配置：

TypeAdapterConfig<DerivedPoco, DerivedDto>.NewConfig()
        .Inherits<SimplePoco, SimpleDto>();

子类继承父类映射配置

可以通过 Include 方法显示的让子类继承父类的映射配置：

TypeAdapterConfig<Vehicle, VehicleDto>.NewConfig()
    .Include<Car, CarDto>();

Vehicle vehicle = new Car { Id = 1, Name = "Car", Make = "Toyota" };
var dto = vehicle.Adapt<Vehicle, VehicleDto>();

dto.ShouldBeOfType<CarDto>();
((CarDto)dto).Make.ShouldBe("Toyota"); // "Make" 属性在 Vehicle 中不存在

配置实例

在 Mapster 中，默认的配置实例为 TypeAdapterConfig.GlobalSettings ，如果需要在不同场景下有不同的映射配置，Mapster 提供了 TypeAdapterConfig 用于实现此需求：

var config = new TypeAdapterConfig();
config.Default.Ignore("Id");

如何给配置实例添加l类型映射配置？

直接使用 NewConfig 和 ForType 方法即可：

config.NewConfig<TSource, TDestination>()
        .Map(dest => dest.FullName,
            src => string.Format("{0} {1}", src.FirstName, src.LastName));

config.ForType<TSource, TDestination>()
        .Map(dest => dest.FullName,
            src => string.Format("{0} {1}", src.FirstName, src.LastName));

通过将配置实例作为参数传给 Adapt 方法来应用特定的类型映射配置：

注意！配置实例在程序中一定要作为单例存在，否则会影响性能！

var result = src.Adapt<TDestination>(config);

也可以创建一个指定 TypeAdapterConfig 的 Mapper，使用 Mapper 来做映射：

var mapper = new Mapper(config);
var result = mapper.Map<TDestination>(src);

复制配置实例

如果想从现有的配置中创建配置实例，可以使用 Clone 方法。

例如复制全局配置实例：

var newConfig = TypeAdapterConfig.GlobalSettings.Clone();

或者复制其它配置实例：

var newConfig = oldConfig.Clone();

Fork 配置

Fork 方法内部直接调用 Clone 方法，但是使用 Fork 方法的形式与使用 Clone 方法有些许差别。

Fork 方法通过传入委托方法直接增加新的映射配置：

var forked = mainConfig.Fork(config => 
				{
					config.ForType<Poco, Dto>()
						.Map(dest => dest.code, src => src.Id);
				});

var dto = poco.Adapt<Dto>(forked);

以上代码等同于使用 Clone 方法实现的以下代码:

var forked = mainConfig.Clone();
forked.ForType<Poco, Dto>()
      .Map(dest => dest.code, src => src.Id);

var dto = poco.Adapt<Dto>(forked);

配置位置

入口

映射配置应该只初始化并且只进行一次配置。因此在编写代码的时候不能将映射配置和映射调用放在同一个地方。

例如下面的例子，运行将会抛出一个异常:

config.ForType<Poco, Dto>().Ignore("Id");
var dto1 = poco1.Adapt<Dto>(config);

config.ForType<Poco, Dto>().Ignore("Id"); //<--- 这里将抛出异常，因为在这之前已经触发过了映射
var dto2 = poco2.Adapt<Dto>(config);

所以，在编写代码时应该将映射配置和映射调用分开，将映射配置放到程序的入口，例如：

Main 方法
Global.asax.cs
Startup.cs

// Application_Start in Global.asax.cs
config.ForType<Poco, Dto>().Ignore("Id");

// in Controller class
var dto1 = poco1.Adapt<Dto>(config);
var dto2 = poco2.Adapt<Dto>(config);

保证配置实例和映射配置在同一位置

将配置实例和映射配置分开，可能会导致代码处于不同的位置，在代码编写过程中可能会出现遗漏之类的问题。

使用 Fork 函数可以使配置实例与映射配置在同一位置：

var dto = poco.Adapt<Dto>(
	config.Fork(forked => forked.ForType<Poco, Dto>().Ignore("Id"));

不用担心性能问题，只有第一次使用配置实例时会编译，之后的调用将从缓存中获取。

在泛型类或方法中使用 Fork

Fork 方法默认使用文件名、行号作为键值。但是如果在在泛型类或泛型方法中调用Fork方法，必须指定键和类型全名称，防止 Fork 从不同的类型参数返回无效的配置。

IQueryable<TDto> GetItems<TPoco, TDto>()
{
    var forked = config.Fork(
        f => f.ForType<TPoco, TDto>().Ignore("Id"), 
        $"MyKey|{typeof(TPoco).FullName}|{typeof(TDto).FullName}");
    return db.Set<TPoco>().ProjectToType<TDto>(forked);
}

不同的程序集

映射配置处于多个不同的程序集是比较常见的情况。

也许你的域程序集有一些映射到域对象的规则，而你的 web api 有一些特定的规则来映射到您的 api 约定。

Scan 方法

Mapster 支持扫描程序集注册映射配置，可以帮助你快速注册映射配置并减小忘记编码注册配置的机率。

在某些特定的情况下可以顺序注册程序集，以达到重写映射配置的目的。

扫描程序集注册映射配置非常简单，只需要在程序集中创建一个或多个 IRegister 的实现，然后调用 TypeAdapterConfig 实例的 Scan 方法即可：

public class MyRegister : IRegister
{
	public void Register(TypeAdapterConfig config)
	{
		config.NewConfig<TSource, TDestination>();

		//OR to create or enhance an existing configuration
		config.ForType<TSource, TDestination>();
	}
}

使用全局配置实例扫描程序集中的配置注册器：

TypeAdapterConfig.GlobalSettings.Scan(assembly1, assembly2, assemblyN)

或使用特定的配置实例扫描程序集中的配置注册器:

var config = new TypeAdapterConfig();
config.Scan(assembly1, assembly2, assemblyN);

Apply 方法

如果你使用的是其它程序集扫描库（如 MEF ）, 那么你可以调用配置实例的 Apply 方法将映射配置注册器添加到配置实例中：

var registers = container.GetExports<IRegister>();
config.Apply(registers);

Apply 方法允许你选择某些映射配置注册器添加到配置实例中，而不是像 Scan 方法把程序集里的所有映射配置注册器添加到配置实例中：

var register = new MockingRegister();
config.Apply(register);

特性标签

Mapster 支持通过为类型增加特性标签的方式添加类型映射配置：

[AdaptTo(typeof(StudentDto), PreserveReference = true)]
public class Student { 
    ...
}

Method	Mean	StdDev	Error	Gen 0	Gen 1	Gen 2	Allocated
'Mapster 6.0.0'	108.59 ms	1.198 ms	1.811 ms	31000.0000	-	-	124.36 MB
'Mapster 6.0.0 (Roslyn)'	38.45 ms	0.494 ms	0.830 ms	31142.8571	-	-	124.36 MB
'Mapster 6.0.0 (FEC)'	37.03 ms	0.281 ms	0.472 ms	29642.8571	-	-	118.26 MB
'Mapster 6.0.0 (Codegen)'	34.16 ms	0.209 ms	0.316 ms	31133.3333	-	-	124.36 MB
'ExpressMapper 1.9.1'	205.78 ms	5.357 ms	8.098 ms	59000.0000	-	-	236.51 MB
'AutoMapper 10.0.0'	420.97 ms	23.266 ms	35.174 ms	87000.0000	-	-	350.95 MB

yswenli

http://www.cnblogs.com/yswenli/

Mapster 简介

为什么选择 Mapster ？

性能 & 内存占用

基本用法

映射到一个新的对象

映射到现有对象

Queryable Extensions

映射器

扩展方法

映射器实例 ( Mapper )

构建器 ( Builder )

数据类型

基本类型

枚举类型

字符串类型

集合

可映射对象

映射配置

映射配置

全局设置

基于规则的映射配置

只配置目标类型

泛型类型映射

映射配置继承

隐式继承映射配置

源类型

目标类型

显示继承映射配置

子类继承父类映射配置

配置实例

配置实例

复制配置实例

Fork 配置

配置位置

入口

保证配置实例和映射配置在同一位置

在泛型类或方法中使用 Fork

不同的程序集

Scan 方法

Apply 方法

特性标签

映射配置验证和编译

显式映射

检查目标类型程序

验证映射配置

配置编译

配置嵌套映射

Fork

Mapster.Tool

安装 Mapster.Tool

安装 Mapster

命令行

集成到csproj文件

手动生成

在Build时自动生成

清理

生成完整类型名

动态输出和名称空间

生成Dto和映射代码

Sample

公告