澳门新萄京官方网站-www.8455.com-澳门新萄京赌场网址

中的有趣应用,配置AutoMapper映射规则

2019-10-30 作者:www.8455.com   |   浏览(127)

最近发现了一个比较有趣的东西 AutoMapper,主要将Model转换为DTO,DTO更注重数据,对领域对象进行合理封装,从而不会将领域对象的行为过分暴露给表现层。

 

 

先说说DTO

DTO是个什么东东?

DTO(Data Transfer Object)就是数据传输对象,说白了就是一个对象,只不过里边全是数据而已。

为什么要用DTO?

1、DTO更注重数据,对领域对象进行合理封装,从而不会将领域对象的行为过分暴露给表现层

2、DTO是面向UI的需求而设计的,而领域模型是面向业务而设计的。因此DTO更适合于和表现层的交互,通过DTO我们实现了表现层与领域Model之间的解耦,因此改动领域Model不会影响UI层

3、DTO说白了就是数据而已,不包含任何的业务逻辑,属于瘦身型的对象,使用时可以根据不同的UI需求进行灵活的运用

先来看一点实例,两个类之间的映射。

配置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对象的属性值:

澳门新萄京官方网站 1

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

AutoMapper用法

2014-08-13 16:48

AutoMapper是对象到对象的映射工具。在完成映射规则之后,AutoMapper可以将源对象转换为目标对象。

作者:齐飞

原文:

AutoMapper

现在我们既然知道了使用DTO的好处,那么我们肯定也想马上使用它,但是这里会牵扯一个问题:怎样实现DTO和领域Model之间的转换?

有两个思路,我们要么自己写转换代码,要么使用工具。不过就应用而言,我还是觉得用工具比较简单快捷,那就使用工具吧。其实这样的转换工具很多,不过我还是决定使用AutoMapper,因为它足够轻量级,而且也非常流行,国外的大牛们都使用它。使用AutoMapper可以很方便的实现DTO和领域Model之间的转换,它是一个强大的Object-Object Mapping工具。

摘自让AutoMapper在你的项目里飞一会儿

首先定义两个类Source与DTOSource:

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是基于约定的,因此在实用映射之前,我们需要先进行映射规则的配置。

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对象的属性值:

澳门新萄京官方网站 2

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

AutoMapper6.2.2.0

AutoMapper6.2.2.0与之前的版本有些不同,那么究竟有什么不同,我们一起来实践一下:

1.首先,使用AutoMapper6.2.2.0需要在你的项目中引用NuGet包,右键依赖项,管理NuGet程序包,然后选择浏览,搜索AutoMapper,安装,你就可以在项目中使用啦,你也可以在vs中使用打开工具-库程序包管理器-程序包管理控制平台,输入“Install-Package AutoMapper”命令,就可以把AutoMapper添加到项目中了~

2.让我们开始使用

  (1)一个简单的映射

      首先,创建一个C#控制台应用程序,为了方便,我们在Program直接定义三个类:

      

public class Student
    {
        public string Name { get; set; }
        public int Sex { get; set; }
        public string Age { get; set; }
        public DateTime Birth { get; set; }
    }

    public class Dto_Student
    {
        public string n { get; set; }
        public string s { get; set; }
        public int a { get; set; }
        public string b { get; set; }
    }

    public class V_Student
    {
        public string Name { get; set; }
        public int Sex { get; set; }
        public string Age { get; set; }
        public DateTime Birth { get; set; }
    }

  (2)一个简单的映射,由于Student和V_Student类字段名称一样,类型相同,所以,映射可以这么写

  

//一个简单的映射
            AutoMapper.Mapper.Initialize(map => map.CreateMap<Student, V_Student>());
            var stu = AutoMapper.Mapper.Map<Student>(new V_Student
            {
                Name = "myname",
                Sex = 1,
                Age = "24",
                Birth = DateTime.Now
            });

            var vstu = AutoMapper.Mapper.Map<V_Student>(new Student
            {
                Name = "myname",
                Sex = 1,
                Age = "24",
                Birth = DateTime.Now
            });

  (3)那么,不同字段名称,甚至不同类型的两个类如何映射呢,那就要手动的映射相应字段了:

//属性不同名,属性类型不同映射
            AutoMapper.Mapper.Initialize(map => map.CreateMap<Student, Dto_Student>()
                .ForMember(d => d.n, opt =>
                {
                    opt.MapFrom(s => s.Name);
                })
                .ForMember(d => d.s, opt =>
                {
                    opt.MapFrom(s => s.Sex == 1 ? "男" : "女");
                })
                .ForMember(d => d.a, opt =>
                {
                    opt.MapFrom(s => Convert.ToInt32(s.Age));
                })
                .ForMember(d => d.b, opt =>
                {
                    opt.MapFrom(s => s.Birth.ToString("yyyy-MM-dd"));
                })
            );

            var dto_stu = AutoMapper.Mapper.Map<Dto_Student>(new Student
            {
                Name = "myname",
                Sex = 1,
                Age = "24",
                Birth = DateTime.Now
            });

            var stu = AutoMapper.Mapper.Map<Student>(new Dto_Student
            {
                n = "myname",
                s = "男",
                a = 24,
                b = DateTime.Now.ToString("yyyy-MM-dd")
            });

  这边一运行,发现报错了,为什么呢,原来是因为,由于映射字段类型不同,无法反向映射,那么,如何再添加一个映射呢,这时候就需要用到Profile这个类,我们需要继承这个类,并在里面写下映射配置,具体如下:

新建Dto_StudentProfile类和StudentProfile类:

public class Dto_StudentProfile:Profile
    {
        public Dto_StudentProfile()
        {
            base.CreateMap<Dto_Student, Student>()
                .ForMember(s => s.Name, opt =>
                {
                    opt.MapFrom(stu => stu.n);
                })
                .ForMember(s => s.Sex, opt =>
                {
                    opt.MapFrom(stu => stu.s.Equals("男")?1:0);
                })
                .ForMember(s => s.Age, opt =>
                {
                    opt.MapFrom(stu => stu.a.ToString());
                })
                .ForMember(s => s.Birth, opt =>
                {
                    opt.MapFrom(stu =>DateTime.Parse( stu.b " 00:00:00"));
                });
        }
    }

public class StudentProfile:Profile
    {
        public StudentProfile()
        {
            base.CreateMap<Student, Dto_Student>()
                .ForMember(d => d.n, opt =>
                {
                    opt.MapFrom(stu => stu.Name);
                })
                .ForMember(d => d.s, opt =>
                {
                    opt.MapFrom(stu => stu.Sex == 1 ? "男" : "女");
                })
                .ForMember(d => d.a, opt =>
                {
                    opt.MapFrom(stu => Convert.ToInt32(stu.Age));
                })
                .ForMember(d => d.b, opt =>
                {
                    opt.MapFrom(stu => stu.Birth.ToString("yyyy-MM-dd"));
                });
        }
    }

  那么,我们如何使用两个配置呢?

//配置映射
AutoMapper.Mapper.Initialize(map => map.AddProfiles(new[] {
    typeof(Dto_StudentProfile),
    typeof(StudentProfile)
}));
var dto_stu = AutoMapper.Mapper.Map<Dto_Student>(new Student
            {
                Name = "myname",
                Sex = 1,
                Age = "24",
                Birth = DateTime.Now
            });

            var stu = AutoMapper.Mapper.Map<Student>(new Dto_Student
            {
                n = "myname",
                s = "男",
                a = 24,
                b = DateTime.Now.ToString("yyyy-MM-dd")
            });

  这样,我们就完成了两个不同字段名称,不同类型的映射

(4)映射List<T>

  如何进行实体列表的映射呢,其实,配置上并没有任何不同,只需要在使用上,换成list就可以了:

List<Student> estu = new List<Student>();
            estu.Add(new Student
            {
                Name = "myname",
                Sex = 1,
                Age = "24",
                Birth = DateTime.Now
            });
            estu.Add(new Student
            {
                Name = "myname",
                Sex = 1,
                Age = "24",
                Birth = DateTime.Now
            });
            List<Dto_Student> slist = AutoMapper.Mapper.Map<List<Student>, List<Dto_Student>>(estu);

  (5)你可能觉得不太方便,那么,我们可以将AutoMapper的Initialize放到应用开始的时候运行

  Mvc项目,可以放到程序的Global中,如果是.NET Core 2.0的MVC项目,可以放到StartUp中运行:

澳门新萄京官方网站 3

这边直接摘了前人的方法,有兴趣可以看一下

  (6)那么,你可以使用拓展的方法进行映射,这里定义一个AutoMapperHelper操作类:

using System;
using System.Collections;
using System.Collections.Generic;
using System.Text;

namespace AutoMapperTest
{
    public static class AutoMapperHelper
    {
        public static T MapTo<T>(this object obj)
        {
            if (obj == null) return default(T);
            return AutoMapper.Mapper.Map<T>(obj);
        }

        public static List<TDestination> MapToList<TDestination>(this object source)
        {
            return AutoMapper.Mapper.Map<List<TDestination>>(source);
        }
    }
}

  这样,你就可以这么使用:

List<Student> estu = new List<Student>();
            estu.Add(new Student
            {
                Name = "myname",
                Sex = 1,
                Age = "24",
                Birth = DateTime.Now
            });
            estu.Add(new Student
            {
                Name = "myname",
                Sex = 1,
                Age = "24",
                Birth = DateTime.Now
            });
            var slist = estu.MapToList<Dto_Student>();

  非list的实体映射也是一样的,这里不再多说,如果有什么疑问,欢迎提出来,共同讨论进步,感谢你的阅读

 

 

 1  public class Source
 2     {
 3         public int Id { get; set; }
 4         public string Content { get; set; }
 5     }
 6 
 7     public class DTOSource
 8     {
 9         public int Id { get; set; }
10         public string Content { get; set; }
11     }

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文件夹,文件夹结构如下:

澳门新萄京官方网站 4

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

AutoMapper.Configuration.Configure();

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);
        });
    }
}

 

 Source与DTOSource字段完全相同,来看看它俩如何通过AutoMapper转换,代码很简单。

扁平化映射(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);

测试结果:

澳门新萄京官方网站 5

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文件夹,文件夹结构如下:

澳门新萄京官方网站 6

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

AutoMapper.Configuration.Configure();
1 Mapper.Initialize(x=>{
2      x.CreateMap<Source,DTOSource>();
3 });
4 
5 Source s = new Source{Id=1,Content="123"};
6 
7 DTOSource dto = Mapper.Map<DTOSource>(s);

指定映射字段(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);

测试结果:

澳门新萄京官方网站 7

扁平化映射(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);

测试结果:

澳门新萄京官方网站 8

第一步建立Source到DTOSource之间的映射,初始化一个Source实例后,来看下执行结果:

验证配置项(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异常:

澳门新萄京官方网站 9

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

解决这种异常的方法有:

指定映射字段,例如:

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

中的有趣应用,配置AutoMapper映射规则。或者使用Ignore方法:

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

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

指定映射字段(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);

测试结果:

澳门新萄京官方网站 10

澳门新萄京官方网站 11

自定义解析器(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);

测试结果:

澳门新萄京官方网站 12

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

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

new CustomResolver

());
    });

验证配置项(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异常:

澳门新萄京官方网站 13

这是因为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();
    });

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

澳门新萄京官方网站,执行完成后,可以看到dto中的数据与之前初始化的s的数据是一样的,就像是直接将s拷贝了一份给dto,在两个类字段名定全相同的情况下如此,那么如果DTOSource中的字段名与Source中的不相同如何,其实也很简单,只需

自定义类型转换器(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);
    }
}

自定义解析器(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);

测试结果:

澳门新萄京官方网站 14

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

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

要改成一点点的代码既可:

空值替换(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);

测试结果:

澳门新萄京官方网站 15

自定义类型转换器(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);
    }
}

我们将DTOSource中的Content的字段名改成Desc,此时只需要建立映射关系时,指定字段就可以了:

条件映射(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));
    });


转自:http://www.cnblogs.com/youring2/p/automapper.html

空值替换(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);

测试结果:

澳门新萄京官方网站 16

1 Mapper.Initialize(x => {
2    x.CreateMap<Source, DTOSource>().ForMember(c=>c.Desc,q=> {
3       q.MapFrom(z => z.Content);
4      });
5 });

条件映射(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));
    });

 

来看看运行结果如何;

总结

AutoMapper的一些常用方法都已经整理出来,代码也都在文章中,不再提供下载。

作者:齐飞

原文:

澳门新萄京官方网站 17

可以看到与之前的运行结果是相同的。

那么如何映射两个List,其实也很简单,和上述代码几乎可以说是无差别,只是在最后一步时,要做一点点的修改就可以了。如下面代码:

 1  Mapper.Initialize(x => {
 2                 x.CreateMap<Source, DTOSource>().ForMember(c => c.Desc, q =>
 3                 {
 4                     q.MapFrom(z => z.Content);
 5                 });
 6             });
 7 
 8             s.Add(new Source { Id = 1, Content = "123" });
 9 
10             var dto = Mapper.Map<List<DTOSource>>(s);

 

可以看到除了最后一句代码,其它几乎是完全相同的,只是在最后一句代码中,目标类型改成了List<DTOSource>仅此而已。看下运行结果如何:

澳门新萄京官方网站 18

结果符合预期。

在实际的项目中,这样的写法肯定是不符合要求的,一般会做一个封装,新建一个SourceProfile继承自Profile:

1  public SourceProfile()
2         {
3             base.CreateMap<Source, DTOSource>().ForMember(c => c.Desc, q => {
4                 q.MapFrom(z => z.Content);
5             });
6         }

所有映射关系都可以写在这一个类里,只需要在程序初始化的时候调用一次就可以了:

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

博主使用的AutoMapper版本6.1.1.0,因为AutoMapper在6.0版本时移除了Profile中的Configure,所以与6.0版本以下写法有点不同,6.0以下版本写法为:

1 public class SourceProfile : Profile
2     {
3         protected override void Configure()
4         {
5             CreateMap<Source, DTOSource>().ForMember(c => c.Desc, q => {
6                 q.MapFrom(z => z.Content);
7             });
8         }
9     }

继承Profile重写其Configure即可,调用方式与上述没有太大差别。 Mapper.Initialize中可添加一个或多个Profile。

在MVC项目的应用中,可以将Mapper.Initialize封装到一个类里;

 public static class AutoMapperForMvc
    {
        public  static void Register()
        {
            Mapper.Initialize(x => {
                x.AddProfile<SourceProfile>();
            });
        }

    }

 进而在MVC的Global中进一次性注册:

 1 public class MvcApplication : System.Web.HttpApplication
 2     {
 3         protected void Application_Start()
 4         {
 5             AreaRegistration.RegisterAllAreas();
 6             FilterConfig.RegisterGlobalFilters(GlobalFilters.Filters);
 7             RouteConfig.RegisterRoutes(RouteTable.Routes);
 8             BundleConfig.RegisterBundles(BundleTable.Bundles);
 9             //注册
10             AutoMapperForMvc.Register();
11         }
12     }

 更多有趣的东西可以查看官方网站

本文由澳门新萄京官方网站发布于www.8455.com,转载请注明出处:中的有趣应用,配置AutoMapper映射规则

关键词: