AutoMapper用法

最新推荐文章于 2024-06-07 07:00:00 发布
最新推荐文章于 2024-06-07 07:00:00 发布
阅读量209 收藏
点赞数

AutoMapper用法

原文：http://www.qeefee.com/article/automapper

配置AutoMapper映射规则

AutoMapper是基于约定的，因此在实用映射之前，我们需要先进行映射规则的配置。

public class Source
{
    public int SomeValue { get; set; }
    public string AnotherValue { get; set; }
}

public class Destination
{
    public int SomeValue { get; set; }
}

在上面的代码中，我们定义了两个类，我们需要将Source类的对象映射到Destination类的对象上面。要完成这个操作，我们需要对AutoMapper进行如下配置：

Mapper.CreateMap<Source, Destination>();

进行一下测试：

Source src = new Source() { SomeValue = 1, AnotherValue = "2" };
Destination dest = Mapper.Map<Destination>(src);

ObjectDumper.Write(dest);

我们可以在控制台看到dest对象的属性值：

image

这样我们就完成了一个简单的AutoMapper映射。

Profile的用法

Profile提供了一个命名的映射类，所有继承自Profile类的子类都是一个映射集合。

我们来看一下Profile的用法，这个例子中仍然使用上面的Source类和Destination类。

public class SourceProfile : Profile
{
    protected override void Configure()
    {
        CreateMap<Source, Destination>();
    }
}

我们可以再Profile中重写Configure方法，从而完成映射规则的配置。从Profile初始化Mapper规则：

Mapper.Initialize(x => x.AddProfile<SourceProfile>());

在一个Profile中，我们可以完成多个、更复杂的规则的约定：

public class Destination2
{
    public int SomeValue { get; set; }
    public string AnotherValue2 { get; set; }
}
public class SourceProfile : Profile
{
    protected override void Configure()
    {
        //Source->Destination
        CreateMap<Source, Destination>();

        //Source->Destination2
        CreateMap<Source, Destination2>().ForMember(d => d.AnotherValue2, opt =>
        {
            opt.MapFrom(s => s.AnotherValue);
        });
    }
}

 

AutoMapper最佳实践

这段内容将讨论AutoMapper的规则写在什么地方的问题。

在上一段中，我们已经知道了如何使用AutoMapper进行简单的对象映射，但是，在实际的项目中，我们会有很多类进行映射（从Entity转换为Dto，或者从Entity转换为ViewModel等），这么多的映射如何组织将成为一个问题。

首先我们需要定义一个Configuration.cs的类，该类提供AutoMapper规则配置的入口，它只提供一个静态的方法，在程序第一次运行的时候调用该方法完成配置。

当有多个Profile的时候，我们可以这样添加：

public class Configuration
{
    public static void Configure()
    {
        Mapper.Initialize(cfg =>
        {
            cfg.AddProfile<Profiles.SourceProfile>();
            cfg.AddProfile<Profiles.OrderProfile>();
            cfg.AddProfile<Profiles.CalendarEventProfile>();
        });
    }
}

在程序运行的时候，只需要调用Configure方法即可。

了解了这些实现以后，我们可以再项目中添加AutoMapper文件夹，文件夹结构如下：

image

Configuration为我们的静态配置入口类；Profiles文件夹为我们所有Profile类的文件夹。如果是MVC，我们需要在Global中调用：

AutoMapper.Configuration.Configure();

扁平化映射（Flattening）

默认情况下，我们的Source类和Destination类是根据属性名称进行匹配映射的。除此之外，默认的映射规则还有下面两种情况，我们称之为扁平化映射，即当Source类中不包含Destination类中的属性的时候，AutoMapper会将Destination类中的属性进行分割，或匹配“Get”开头的方法，例如：

Order类：

public class Order
{
    public Customer Customer { get; set; }

    public decimal GetTotal()
    {
        return 100M;
    }
}

Order类中包含了一个customer对象和一个GetTotal方法，为了方便演示，我直接将GetTotal方法返回100；

Customer类的定义如下：

public class Customer
{
    public string Name { get; set; }
}

OrderDto类的定义如下：

public class OrderDto
{
    public string CustomerName { get; set; }
    public string Total { get; set; }
}

我们在进行映射的时候，不需要进行特殊的配置，既可以完成从Order到OrderDto的映射。

public class OrderProfile : Profile
{
    protected override void Configure()
    {
        CreateMap<Entity.Order, Dto.OrderDto>();
    }
}

测试代码：

Entity.Customer customer = new Entity.Customer() { Name = "Tom" };
Entity.Order order = new Entity.Order() { Customer = customer };
Dto.OrderDto orderDto = Mapper.Map<Dto.OrderDto>(order);
ObjectDumper.Write(order, 2);
ObjectDumper.Write(orderDto);

测试结果：

image

指定映射字段（Projection）

在实际的业务环境中，我们的Source类和Destination类的字段不可能一对一的匹配，这个时候我们就需要来指定他们的实际映射关系，例如：

public class CalendarEvent
{
    public DateTime Date { get; set; }
    public string Title { get; set; }
}

public class CalendarEventForm
{
    public DateTime EventDate { get; set; }
    public int EventHour { get; set; }
    public int EventMinute { get; set; }
    public string DisplayTitle { get; set; }
}

在这两个类中，CalendarEvent的Date将被拆分为CalendarEventForm的日期、时、分三个字段，Title也将对应DisplayTitle字段，那么相应的Profile定义如下：

public class CalendarEventProfile : Profile
{
    protected override void Configure()
    {
        CreateMap<Entity.CalendarEvent, Entity.CalendarEventForm>()
            .ForMember(dest => dest.EventDate, opt => opt.MapFrom(src => src.Date.Date))
            .ForMember(dest => dest.EventHour, opt => opt.MapFrom(src => src.Date.Hour))
            .ForMember(dest => dest.EventMinute, opt => opt.MapFrom(src => src.Date.Minute))
            .ForMember(dest => dest.DisplayTitle, opt => opt.MapFrom(src => src.Title));
    }
}

测试代码：

Entity.CalendarEvent calendarEvent = new Entity.CalendarEvent()
{
    Date = DateTime.Now,
    Title = "Demo Event"
};
Entity.CalendarEventForm calendarEventForm = Mapper.Map<Entity.CalendarEventForm>(calendarEvent);
ObjectDumper.Write(calendarEventForm);

测试结果：

image

验证配置项（Configuration Validation）

AutoMapper提供了一种验证机制，用来判断Destination类中的所有属性是否都被映射，如果存在未被映射的属性，则抛出异常。

验证的用法：

Mapper.AssertConfigurationIsValid();

例如：

public class Source
{
    public int SomeValue { get; set; }
    public string AnotherValue { get; set; }
}

Destination代码：

public class Destination
{
    public int SomeValuefff { get; set; }
}

测试：

Mapper.CreateMap<Entity.Source, Entity.Destination>();
Mapper.AssertConfigurationIsValid();

运行程序将会出现AutoMapperConfigurationException异常：

image

这是因为SomeValuefff在Source类中没有对应的字段造成的。

解决这种异常的方法有：

指定映射字段，例如：

Mapper.CreateMap<Entity.Source, Entity.Destination>()
    .ForMember(dest => dest.SomeValuefff, opt =>
    {
        opt.MapFrom(src => src.SomeValue);
    });

或者使用Ignore方法：

Mapper.CreateMap<Entity.Source, Entity.Destination>()
    .ForMember(dest => dest.SomeValuefff, opt =>
    {
        opt.Ignore();
    });

或者使用自定义解析器，自定义解析器在下面讲到。

自定义解析器（Custom value resolvers）

AutoMapper允许我们自定义解析器来完成Source到Destination的值的转换。例如：

public class Source
{
    public int Value1 { get; set; }
    public int Value2 { get; set; }
}

public class Destination
{
    public int Total { get; set; }
}

Total属性在Source中不存在，如果现在创建映射规则，在映射的时候必然会抛出异常。这个时候我们就需要使用自定义解析器来完成映射。

自定义解析器需要实现 IValueResolver 接口，接口的定义如下：

public interface IValueResolver
{
    ResolutionResult Resolve(ResolutionResult source);
}

我们来自定义一个Resolver：

public class CustomResolver : ValueResolver<Source, int>
{
    protected override int ResolveCore(Source source)
    {
        return source.Value1 + source.Value2;
    }
}

然后在映射规则中使用这个解析器：

public class SourceProfile : Profile
{
    protected override void Configure()
    {
        //Source->Destination
        CreateMap<Source, Destination>()
            .ForMember(dest => dest.Total, opt =>
            {
                opt.ResolveUsing<CustomResolver>();
            });
    }
}

测试代码：

Source src = new Source()
{
    Value1 = 1,
    Value2 = 2
};
Destination dest = Mapper.Map<Destination>(src);
ObjectDumper.Write(dest);

测试结果：

image

在使用自定义Resolver中，我们还可以指定Resolver的构造函数，例如：

//Source->Destination
CreateMap<Source, Destination>()
    .ForMember(dest => dest.Total, opt =>
    {
        opt.ResolveUsing<CustomResolver>()
            .ConstructedBy(() => 
                new CustomResolver();
            );
    });

自定义类型转换器（Custom type converters）

AutoMapper通过ConvertUsing来使用自定义类型转换器。ConvertUsing有三种用法：

void ConvertUsing(Func<TSource, TDestination> mappingFunction);
void ConvertUsing(ITypeConverter<TSource, TDestination> converter);
void ConvertUsing<TTypeConverter>() where TTypeConverter : ITypeConverter<TSource, TDestination>;

当我们有如下的Source类和Destination类：

public class Source
{
    public string Value1 { get; set; }
}

public class Destination
{
    public int Value1 { get; set; }
}

我们可以使用如下配置：

public class SourceProfile : Profile
{
    protected override void Configure()
    {
        //string->int
        CreateMap<string, int>()
            .ConvertUsing(Convert.ToInt32);
        //Source->Destination
        CreateMap<Source, Destination>();
    }
}

在上面的配置中，我们首先创建了从string到int的类型转换，这里使用了系统自带的Convert.ToInt32转换方法。

除了这种方法之外，我们还可以自定义类型转换器：

public class CustomConverter : ITypeConverter<Source, Destination>
{
    public Destination Convert(ResolutionContext context)
    {
        Source src = context.SourceValue as Source;
        Destination dest = new Destination();
        dest.Value1 = System.Convert.ToInt32(src.Value1);

        return dest;
    }
}

通过这个转换器，我们可以绕过string到int的转换，直接将Source类的对象转换为Destination类的对象。

对应的配置如下：

public class SourceProfile : Profile
{
    protected override void Configure()
    {
        //Source->Destination
        CreateMap<Source, Destination>()
            .ConvertUsing<CustomConverter>();
    }
}

或者，我们也可以使用下面的配置：

public class SourceProfile : Profile
{
    protected override void Configure()
    {
        //Source->Destination
        CustomConverter converter = new CustomConverter();
        CreateMap<Source, Destination>()
            .ConvertUsing(converter);
    }
}

空值替换（Null substitution）

空值替换允许我们将Source对象中的空值在转换为Destination的值的时候，使用指定的值来替换空值。

public class Source
{
    public string Value { get; set; }
}

public class Destination
{
    public string Value { get; set; }
}

配置代码：

public class SourceProfile : Profile
{
    protected override void Configure()
    {
        //Source->Destination
        CreateMap<Source, Destination>()
            .ForMember(dest => dest.Value, opt =>
            {
                opt.NullSubstitute("原始值为NULL");
            });
    }
}

测试代码：

Source src = new Source();
Destination dest = Mapper.Map<Destination>(src);
ObjectDumper.Write(dest);

测试结果：

image

条件映射（Conditional mapping）

条件映射只当Source类中的属性值满足一定条件的时候才进行映射。例如：

public class Foo
{
    public int baz;
}

public class Bar
{
    public uint baz;
}

对应的配置代码如下：

Mapper.CreateMap<Foo, Bar>()
    .ForMember(dest => dest.baz, opt =>
    {
        opt.Condition(src => (src.baz >= 0));
    });

 

杨Zhu
关注
专栏目录
C# 的 AutoMapper 库入门：刨根问底的深度解析
java专栏
08-19 1109
Automapper 允许我们定义自定义映射逻辑。set;set;set;set;set;set;set;// 初始化 AutoMapperget;set;get;set;get;set;get;set;get;set;get;set;get;set;// 初始化 AutoMapper var config = new MapperConfiguration(cfg => {});// 创建 Person 对象 var person = new Person {
AutoMapper基本用法
CHIZHIDA
05-31 1万+
AutoMapper的基本用法AutoMapper的使用场景 AutoMapper的使用场景 AutoMapper是对象到对象的映射工具。在完成映射规则之后，AutoMapper可以将源对象转换为目标对象。 表现层于应用层之间是通过DTO来进行交互的，数据传输对象是没有行为的POCO对象，他的目的是为了对领域对象进行数据封装，实现层与层之间的数据传递。为何不直接将领域对象进行数据传递？因为领域对...
AutoMapper详解
热门推荐
李宥的博客
06-10 1万+
简单来说，AutoMapper是以.NET(C#)语言开发的一个轻量的处理一个实体对象到另一个实体对象之间映射关系的组件库。开发人员需要做的是通过AutoMapper配置两个实体对象之间的一些映射关系。就可以直接实现映射关系的复用，提高开发效率，减少重复代码。为了降低现代开发框架的复杂度，往往需要做代码分层，分层之后，必然出现不同的数据承载对象VO、BO、Entity ，从设计的角度来说，VO、BO、Entity 的设计思路并不违反 DRY 原则，为了分层清晰、减少耦合，多维护几个类的成本也并不是不能接受的
AutoMapper使用笔记
cxzhq2002的杂记
11-07 1136
AutoMapper是一个.NET的对象映射工具。 项目地址：https://github.com/AutoMapper/AutoMapper。 帮助文档：https://github.com/AutoMapper/AutoMapper/wiki 主要用途 领域对象与DTO之间的转换、数据库查询结果映射至实体对象。 使用笔记 场景1：源类型BlogEntry，目标类型BlogPostD
Automapper源码分析
极客神殿
03-09 658
是一个对象映射库，可以用来将一个对象的属性映射到另一个对象上。它通过使用一组规则来自动地映射对象的属性，从而减少了手动编写大量重复代码的工作。在映射属性时，它会先根据属性名查找对应的映射规则，然后根据规则执行属性值的映射操作。是一个功能强大、易于使用的对象映射库，通过使用一组灵活的映射规则，可以大大简化编写对象映射代码的工作。这个方法接受两个泛型参数，分别表示源类型和目标类型，然后可以通过调用各种方法来指定映射规则，例如。如果找到了映射规则，则会根据规则执行属性的映射操作。方法可以指定某个属性的映射规则，
AutoMapper 基本使用 Mapster
KingCruel的专栏
08-03 1548
1、Initialize：Mapper 初始化 Mapper.Initialize(x => x.CreateMap<Destination, Source>() ); Mapper.Initialize(cfg => { cfg.CreateMap<Aliens, Person>(); }); Mapper.Initialize(cfg...
C# AutoMapper 使用方法总结
08-19
C# AutoMapper 使用方法总结 Automapper 是一个对象-对象映射器，可以将一个对象映射到另一个对象。它可以帮助我们简化对象之间的映射工作，提高开发效率。 AutoMapper 的使用方法可以分为三个步骤：注册、配置...
ASP.NET 6 集成 AutoMapper
07-25
在`Get`方法中，我们创建了一个`SourceClass`实例，并使用AutoMapper将其转换为`DestinationClass`。 总结一下，ASP.NET 6集成AutoMapper的主要步骤包括：安装AutoMapper相关包，定义映射规则，注册配置，以及在...
c# Automapper使用方法
05-27
使用AutoMapper可以简化对象映射的过程，提高开发效率。下面是使用AutoMapper的基本步骤： 1. 在项目中安装AutoMapper NuGet包。 2. 创建一个映射配置类，用于定义源对象和目标对象之间的映射关系。例如： ``` ...
MapStructPlus 自定义对象的属性自动转换
qq_66364463的博客
04-19 312
MapStructPlus自定义对象的属性自动转换
AutoMapper的简单用法
qq_37189288的博客
03-30 7907
第一步 ，下载组件（我选择的是8.1.1） 第二步 ，创建一个文件夹AutoMapper,这样我们把所有文件放在这里 第三步，创建一个Configration类，用来配置Mapper 在这里用到了MapperConfiguration类，并添加了两个Profile文件，通常把一个model转换成另一个model的映射都写成一个Profile文件，并添加到mapperconfiguration中，最后利用createmapper实例化Mapper,方便我们将来使用。 接下来看看两个Profile文件是怎
AutoMapper 通过 Profile来 配置 Mapper
dongnihao的博客
06-30 906
一般的mapper：使用AutoMapper转化： 这里的DTO对象就被AutoMapper自动转化成了Model对象，所以modelData中的userName、age、job的值即为GetdtoDataFromDB（）方法取出来的值。实际项目中会通过 Profile来 配置 Mapper：.........
推荐：AutoMapper —— 轻量级数据映射神器
gitblog_00058的博客
05-25 366
推荐：AutoMapper —— 轻量级数据映射神器 AutoMapper.Extensions.Microsoft.DependencyInjection项目地址:https://gitcode.com/gh_mirrors/au/AutoMapper.Extensions.Microsoft.DependencyInjection 1、项目介绍 请注意： 这篇文章介绍的开源项目AutoMap...
AutoMapper 配置实现深度拷贝的对象映射
技术广场
05-12 1026
默认情况下，AutoMapper执行的是浅拷贝，只复制源对象的属性到目标对象的对应属性。无论是针对所有字段还是特定的属性，通过自定义转换器或自定义映射规则，你可以实现灵活的深度拷贝逻辑。但是，如果我们需要在对象映射过程中实现深度拷贝，包括嵌套对象的属性字段，我们可以通过一些配置来实现。总结起来，AutoMapper是一个强大的对象映射库，通过适当的配置，我们可以实现深度拷贝的对象映射。另外，如果你需要在多个映射中重复使用相同的深度拷贝逻辑，你可以将其封装为可重用的自定义转换器，然后在需要的地方进行调用。
.NET开发中合理使用对象映射库，简化和提高工作效率
最新发布
专注于C#/.NET/.NET Core学习、工作、面试干货和实战教程分享。这里聚焦了大量的C#/.NET/.NET Core优质文章、开源项目、实用工具和学习、工作、面试心得。
06-07 657
在日常开发中，我们常常需要将一个对象映射到另一个对象，这个过程中可能需要编写大量的重复性代码，如果每次都手动编写，不仅会影响开发效率，而且当项目越来越复杂，庞大的时候还容易出现错误。为了解决这个问题，对象映射库就随之而出了，这些库可以自动完成对象之间的映射，从而减少了开发工作量，提高了开发效率。AutoMapper是一个流行的.NET对象映射库，它可以自动进行对象之间的转换和映射，极大的简化了开发人员在处理对象映射时的工作量。
Solr.NET快速入门(一)【基本使用,映射字段】
极客神殿
03-18 2812
字典映射和动态字段Solr dynamicFields可以根据用例不同地映射。 它们可以被“静态地”映射，例如，给定：<dynamicField name="price_*" type="integer" indexed="true" stored="true"/>一个特定的dynamicField实例可以映射为：[SolrField("price_i")] public decimal? P
.net core 使用 Mapster 进行VO与PO映射（前后端视图映射）
zouzh的专栏
10-26 2846
1、安装nuget包 2、创建映射类 public static class EntityMapper { /// <summary> /// 实体映射 /// </summary> static EntityMapper() { InitMapper(); } /// <summary> //
学习AutoMapper（一）：映射模型
weixin_45132755的博客
01-04 635
AutoMapper：1、我使用的是 .net 7.0 WebAPI，以下代码是在Controllers里面实现。2、图一是我数据库的数据，自己可创建Model模拟数据，图一role必须要有name，图二必须要有roleName3、目的是为了做 model 模型的映射，图二不想要那么多模型，只想拿取图一role里面的name值，映射到图二roleName
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值