AutoMapper的使用

一、为什么要用AutoMapper

　　AutoMapper是一个 对象 - 对象映射器 。对象 - 对象映射的工作原理是将一种类型的输入对象转换为另一种类型的输出对象。

　　一个项目分多层架构，如UI层、业务逻辑层、服务层、数据访问层。层与层访问需要数据载体，也就是类。如果多层通用一个类，一则会暴露出每层的字段，二者会使类字段很多，而且会出现很多冗余字段，这种方式是不可取的；如果每层都使用不同的类，则层与层调用时，一个字段一个字段的赋值又会很麻烦。使用AutoMapper可以帮助我们实现类字段的赋值及转换，AutoMapper提供了映射规则及操作方法，使我们不用过多配置就可以映射两个类。

二、AutoMapper简单使用

先创建两个类用于映射：

    //用户类 Source
   public class UserInfo
    {
        public string Name { get; set; }
        public int Age { get; set; }
    }


     //用户类 destination 
    public class UserInfoDTO
    {
        public string Name { get; set; }
        public int Age { get; set; }
    }

2.1  简单创建映射

Automapper可以使用静态类和实例方法来创建映射，下面分别使用这两种方式来实现 UserInfo-> UserInfoDTO的映射。

• 使用静态方式（使用MapperConfiguration在AppDomain通常只需要一个实例，并且应该在启动期间进行实例化。）

           //静态方式创建映射
              Mapper.Initialize(cfg => cfg.CreateMap<UserInfo, UserInfoDTO>());
              var userInfoDTO1 = Mapper.Map<UserInfoDTO>(userInfo);    

• 使用实例方法

          //实例方法创建映射
              MapperConfiguration configuration = new MapperConfiguration(cfg => cfg.CreateMap<UserInfo, UserInfoDTO>());
              var mapper = configuration.CreateMapper();
              var userInfoDTO2 = mapper.Map<UserInfoDTO>(userInfo);

完整的例子：

    class Program
    {
        static void Main(string[] args)
        {
            //Souce
            UserInfo userInfo = new UserInfo() { Name = "tom", Age = 22 };
            
            //静态方式创建映射
            Mapper.Initialize(cfg => cfg.CreateMap<UserInfo, UserInfoDTO>());
            var userInfoDTO1 = Mapper.Map<UserInfoDTO>(userInfo);

            //实例方法创建映射
            MapperConfiguration configuration = new MapperConfiguration(cfg => cfg.CreateMap<UserInfo, UserInfoDTO>());
            var mapper = configuration.CreateMapper();
            var userInfoDTO2 = mapper.Map<UserInfoDTO>(userInfo);
            
            Console.WriteLine("用户映射1 名字为{0},年龄是{1}", userInfoDTO1.Name, userInfoDTO1.Age);
            Console.WriteLine("用户映射2 名字为{0},年龄是{1}", userInfoDTO2.Name, userInfoDTO2.Age);
            Console.ReadKey();
        }
    }

2.2  配置（Profie）实现映射关系

　　当需要配置的映射关系较多时，使用上边的方式一个一个添加映射关系很不方便，我们可以使用Profile来实现映射关系。

第一步.创建自定义的Profile需要继承Profile类：

   public class MyProfile:Profile
    {  
        public MyProfile()
        {
            CreateMap<RoleInfo, RoleInfoDTO>();
            CreateMap<UserInfo, UserInfoDTO>();
        }
    }

　　第二步.实现配置：

     static void Main(string[] args)
        {
            //Souce
            UserInfo userInfo = new UserInfo() { Name = "tom", Age = 22 };
            RoleInfo roleInfo = new RoleInfo() { RoleId = 1, RoleName = "管理员" };
           
            //配置的方式实现DTO
            var configuration = new MapperConfiguration(cfg => cfg.AddProfile<MyProfile>());
            var roleInfoDTO = configuration.CreateMapper().Map<RoleInfoDTO>(roleInfo);
            var userInfoDTO = configuration.CreateMapper().Map<UserInfoDTO>(userInfo);
          

            Console.WriteLine("角色映射 Id为{0},角色名是{1}", roleInfoDTO.RoleId, roleInfoDTO.RoleName);
            Console.WriteLine("用户映射 名字为{0},年龄是{1}", userInfoDTO.Name, userInfoDTO.Age);
            Console.ReadKey();
        }

常用的方式：我们可以同时使用Mapper和Profile，也可以添加多个配置，如下边的Configuration2所示（通过这种方式很容易进行封装）：

    static void Main(string[] args)
        {
            //Souce
            UserInfo userInfo = new UserInfo() { Name = "tom", Age = 22 };
            RoleInfo roleInfo = new RoleInfo() { RoleId = 1, RoleName = "管理员" };
           
            //配置的方式实现DTO
            var configuration = new MapperConfiguration(cfg => cfg.AddProfile<MyProfile>());
            var configuration2 = new MapperConfiguration(cfg => {
                cfg.AddProfile<MyProfile>();
                cfg.CreateMap<ProductEntity, ProductDTO>();
                //...可以有很多
            });
            var roleInfoDTO = configuration.CreateMapper().Map<RoleInfoDTO>(roleInfo);
            var userInfoDTO = configuration.CreateMapper().Map<UserInfoDTO>(userInfo);

            Console.WriteLine("角色映射 Id为{0},角色名是{1}", roleInfoDTO.RoleId, roleInfoDTO.RoleName);
            Console.WriteLine("用户映射 名字为{0},年龄是{1}", userInfoDTO.Name, userInfoDTO.Age);
            Console.ReadKey();
        }

2.3  属性不同名/反向映射

还是上边的UserInfo和UserInfoDTO的例子，如果UserInfo中的Name属性变成UName，那么我们怎样实现映射：UserInfo.UName->UserInfoDTO.Name？方法也很简单，直接上代码

     static void Main(string[] args)
        {
            Mapper.Initialize(cfg =>
            {
                //UserInfo中的属性Name改为UName,那么可以进行以下设置
                cfg.CreateMap<UserInfo, UserInfoDTO>()
                        .ForMember(d => d.Name, opt =>
                        {
                            opt.MapFrom(s => s.UName);
                        });//.ReverseMap();注册映射关系的时候，加上这句就可以就进行双向映射了
            });

            //不加 ReverseMap(),只能从UserInfo->UserInfoDTO,下边代码会抛异常（没有UserInfoDTO->UserInfo的映射）
            UserInfoDTO userDto = new UserInfoDTO(){Name = "貂蝉",Age = 20};
            var user = Mapper.Map<UserInfo>(userDto);

            UserInfo user2 = new UserInfo { UName = "刘备", Age = 30 };
            var user2Dto = Mapper.Map<UserInfoDTO>(user2);

            Console.WriteLine(user.UName);
            Console.WriteLine(user2Dto.Name);
            Console.ReadKey();
        }

2.4  集合和数组的映射

　　AutoMapper only requires configuration of element types, not of any array or list type that might be used.

　　AutoMapper只需要配置元素的类型，不用配置数值/列表的类型。配置了元素类型，我们可以转换为IEnumerable / ICollection / IList / List/ Arrays中的任一种类型

    public class Source
    {
        public int Value { get; set; }
    }
    public class Destination
    {
        public int Value { get; set; }
    }
    //-----------------------------------------------//
    class Program
    {
        static void Main(string[] args)
        {
            //只配置元素的类型
            var configuration = new MapperConfiguration(cfg =>
            {
                cfg.CreateMap<Source, Destination>().ReverseMap();
            });

            var sources = new[]
                {
                new Source { Value = 5 },
                new Source { Value = 6 },
                new Source { Value = 7 }
                };
            //可以转为很多格式
            IEnumerable<Destination> ienumerableDest = configuration.CreateMapper().Map<Source[], IEnumerable<Destination>>(sources);
            ICollection<Destination> icollectionDest = configuration.CreateMapper().Map<Source[], ICollection<Destination>>(sources);
            IList<Destination> ilistDest = configuration.CreateMapper().Map<Source[], IList<Destination>>(sources);
            List<Destination> listDest = configuration.CreateMapper().Map<Source[], List<Destination>>(sources);
            Destination[] arrayDest = configuration.CreateMapper().Map<Source[], Destination[]>(sources);

            Console.WriteLine(ienumerableDest.All(s => s.Value >= 5));
            Console.ReadKey();
        }
    }

这里只记录了一些AutoMapper的简单使用方法，更多功能可以参考官方文档：http://automapper.readthedocs.io/en/latest/Lists-and-arrays.html