OOM框架AutoMapper基本使用

Posted 2020-10-13

出于安全考虑，在后台与前台进行数据传输时，往往不会直接传输实体模型，而是使用Dto（Data transfer object 数据传输对象），这样在后台往前台传递数据时可以省略不必要的信息，只保留必要的信息，大大增强数据安全性。

下面给出两个相互对应的关系模型User、UserDto

public class User
{
  private const int NameMaxLength = 20;
  private const int PassWordMaxLength = 16;
  [Key]
  public long Id { get; }
  [MaxLength(NameMaxLength)]
  public string Name { get; set; }
  [MaxLength(PassWordMaxLength)]
  [DataType(DataType.Password)]
  public string PassWord { get; set; }
}
public class UserDto
{
  private const int NameMaxLength = 20;
  private const int PassWordMaxLength = 16;
  [MaxLength(NameMaxLength)]
  public string Name { get; set; }
  [MaxLength(PassWordMaxLength)]
  public string PassWord { get; set; }
}

这里将 Id 定义为自增长主键，在注册页面，这个 Id 应不可见，这个时候使用Dto的好处就体现出来了，这个时候，在存入数据库时会涉及到 UserDto 往 User 的类型转换，按照之前的经验，肯定可以按照下面这样来写：

user.Name=userDto.Name;
user.PassWord=UserDto.PassWord;

这样的转换固然可以，但是如果一个 User 对象足够复杂，有十几个甚至二十几个属性，这个时候这种写法就会显得十分笨拙。

这个时候我们就可以借助AutoMapper来帮助我们完成 UserDto 到 User 的转换了。

首先安装Nuget包

在 Tools - Nuget Package Manage - Package Manage Console 输入

Install-Package AutoMapper 

安装相应的Nuget包。

根据 Github 上给出的帮助文档来看，有两种方法可以创建映射，一种是静态的 Initalize 一种是动态创建。

下面使用两种不同的方法来进行单元测试

public void Using_Initlalize_Test()
  {
    UserDto dto = new UserDto
    {
      Name = "Niko",
      PassWord = "1234",
    };
    Mapper.Initialize(ctx => ctx.CreateMap<UserDto, User>());
    User user = Mapper.Map<UserDto, User>(dto);
    user.Name.ShouldBe("Niko");
    user.PassWord.ShouldBe("1234");
    user.Id.ToString().ShouldBe("0");
  }
  public void Using_MapperConfiguration_Test()
  {
    var config = new MapperConfiguration(ctx => ctx.CreateMap<UserDto, User>());
    var mapper = config.CreateMapper();
    // var mapper = new Mapper(config);
    UserDto dto = new UserDto
    {
      Name = "Niko",
      PassWord = "1234",
    };
    User user = mapper.Map<User>(dto);
    //User user = Mapper.Map<User>(dto);
    user.Name.ShouldBe("Niko");
    user.PassWord.ShouldBe("1234");
    user.Id.ToString().ShouldBe("0");
  }

这里使用到 Shouldly 断言框架，具体用法参考官方文档。

写完规则之后 通常会调用 AssertConfigurationIsValid 方法，检查规则是否完整 

  Mapper.AssertConfigurationIsValid();

两种方法，单元测试均通过。这样的话，借助 Automapper 处理复杂的对象映射，将大大简化我们的代码量。

为了更加便捷地使用 AutoMappper ,对AutoMapper进行扩展

public static class AutoMapperExtension
{
  /// <summary>
  /// 对象到对象
  /// </summary>
  /// <typeparam name="T"></typeparam>
  /// <param name="obj"></param>
  /// <returns></returns>
  public static T MapTo<T>(this object obj)
  {
    if (obj == null) return default(T);
    Mapper.Initialize(ctx=>ctx.CreateMap(obj.GetType(),typeof(T)));
    return Mapper.Map<T>(obj);
  }
  /// <summary>
  /// 集合到集合
  /// </summary>
  /// <typeparam name="T"></typeparam>
  /// <param name="obj"></param>
  /// <returns></returns>
  public static List<T> MapTo<T>(this IEnumerable obj )
  {
    if (obj == null) throw new ArgumentNullException();
    Mapper.Initialize(ctx => ctx.CreateMap ( obj.GetType(), typeof(T))) ;
    return Mapper.Map<List<T>>(obj);
  }
}

使用上面的方法进行单元测试：

 public void testme()
  {
    UserDto dto = new UserDto
    {
      Name = "Niko",
      PassWord = "1234",
    };
    User user=dto.MapTo<User>();
    user.Name.ShouldBe("Niko");
    user.PassWord.ShouldBe("1234");
    user.Id.ToString().ShouldBe("0");
  }