正在学习的开源博客项目Blog .NET Core中采用mapster实现对象映射,个人理解对象映射框架主要用于不同类型间的数据转换,比起个人实现的定制化的类型对类型的转换代码,采用对象映射框架更便捷,同时也能支撑各式各样的对象映射场景。本文学习并测试mapster对象映射框架的基本用法,后续再学习并记录开源博客项目Blog .NET Core中mapster的使用方式。
新建控制台程序,添加master包引用,同时复制开源博客项目Blog .NET Core中的ArticleInfo类和ArticleInputDto类定义进行对象映射测试。
mapster支持int、bool、dobule、decimal等基本类型的数据转换(原文是只要C#支持类型转换的类型,那么在 Mapster 中也同样支持转换),主要通过调用对象实例的Adapt函数进行数据转换(添加mapster命名空间后),其函数原型及使用示例如下所示。
public static TDestination Adapt<TDestination>(this object? source)string strValue = "3.14";
float fltValue=strValue.Adapt<float>();
Console.WriteLine(fltValue);
mapster支持将字符串转换为枚举类型,无论字符串中保存的是枚举显示值,还是实际值,其使用示例如下图所示:
public enum CreativeType{Original=5,Reprint=10}//以下两种方式都能正确的从字符串转换为对应的枚举值//测试方式1string strValue = "10";CreativeType cType=strValue.Adapt<CreativeType>();Console.WriteLine(cType);//测试方式2string strValue = "Reprint";CreativeType cType=strValue.Adapt<CreativeType>();Console.WriteLine(cType);
mapster支持列表、数组、集合等类型的映射,使用示例如下所示:
List<string> lstValues= new List<string>();
lstValues.Add("5");
lstValues.Add("Reprint");
lstValues.Add("10");
lstValues.Add("Original");var values = lstValues.Adapt<List<CreativeType>>();
将int、string等基本数据类型替换为自定义类型,即可实现数据类型之间的对象映射,根据mapster帮助文档中的介绍(参考文献2),默认情况下根据以下规则进行对象映射,下面使用ArticleInfo类和ArticleInputDto类对以下规则逐一进行测试。
1)源类型和目标类型属性名称相同。 例如: dest.Name = src.Name
2)源类型有 GetXXXX 方法。例如: dest.Name = src.GetName()
3)源类型属性有子属性,可以将子属性的赋值给符合条件的目标类型属性
首先测试的是属性名称相同时的对象映射,代码及运行截图如下所示,可以看出只要是名称相同的属性,映射后均能正常赋值,而两个类型中名称不一致的属性则值为null。
ArticleInfo info = new ArticleInfo();
info.DeleteMark = false;
info.Content = "测试对象映射";
info.Source = "csdn";
info.Title = "test mapster";
info.Author = "csdn";
info.CreativeType = CreativeType.Original;
info.CreatorTime = DateTime.Now;
info.Id = "20231017";
info.IsTop = true;
info.PublishDate = DateTime.Now;
info.ReadTimes = 1000;
info.SourceLink = "csdn";
info.Summary = "test";
info.Thumbnail = "Thumbnail";
info.Visible = true;var infoDto = info.Adapt<ArticleInputDto>();
其次测试源类型没有相同名称的属性,但却有 GetXXXX 方法的情况,将ArticleInfo类型中的Author、CreatorTime、Visible属性转换为GetAuthor、GetCreatorTime、GetVisible函数,然后进行对象映射,代码及运行截图如下所示。
public class ArticleInfo
{...public string GetAuthor(){return "csdn";}public bool GetVisible(){return true;}public DateTime GetPublishDate(){return DateTime.Now;}...
}ArticleInfo info = new ArticleInfo();
info.DeleteMark = false;
info.Content = "测试对象映射";
info.Source = "csdn";
info.Title = "test mapster";
info.CreativeType = CreativeType.Original;
info.CreatorTime = DateTime.Now;
info.Id = "20231017";
info.IsTop = true;
info.ReadTimes = 1000;
info.SourceLink = "csdn";
info.Summary = "test";
info.Thumbnail = "Thumbnail";var infoDto = info.Adapt<ArticleInputDto>();
最后测试源类型属性有子属性的情况,感觉是目标类型中的属性名称等于源类型中复杂属性各级名称拼接的名称,代码及运行截图如下所示。
public class SourceInfo
{public string Name;public string Link;
}
ArticleInfo info = new ArticleInfo();
info.DeleteMark = false;
info.Content = "测试对象映射";
info.Title = "test mapster";
info.CreativeType = CreativeType.Original;
info.CreatorTime = DateTime.Now;
info.Id = "20231017";
info.IsTop = true;
info.ReadTimes = 1000;
info.Summary = "test";
info.Thumbnail = "Thumbnail";
info.Source = new SourceInfo();
info.Source.Name = "csdn";
info.Source.Link = "csdn.net";var infoDto = info.Adapt<ArticleInputDto>();
参考文献:
[1]https://github.com/MapsterMapper/Mapster
[2]https://github.com/rivenfx/Mapster-docs
[3]https://blog.csdn.net/sD7O95O/article/details/123287748
[4]https://blog.csdn.net/sunwork888/article/details/125330714