DDD领域驱动设计初探（五）：AutoMapper使用

标签 标签 标签

• 一句话的事儿：

前言：前篇搭建了下WCF的代码，就提到了DTO的概念，对于为什么要有这么一个DTO的对象，上章可能对于这点不太详尽，在此不厌其烦再来提提它的作用：

• 从安全上面考虑，领域Model都带有领域业务，让Client端引用Domain Model就意味着Client端可以绕过应用层直接完成业务逻辑的调用，这样是一种不安全的机制。
• 从对象传递效率上面考虑，领域Model带有业务，而这些业务一般对于UI层是没有意义的，所以带有业务的model传递起来会加重网络负担。
• 网上还说了DTOmodel最大的意义在于跨平台，Domain Model都是与特定的语言的数据类型有关，而这些数据类型是不能跨平台的，比如Java的类型就不能被C#使用。但在分布式模式下，Client端与Server端的平台不同是很正常的，如果Service直接返回Domain Model，Client端根本无法解析，这就要求Service返回的结果必须是标准的格式字节流。让Domain Model只使用简单类型（字符和数值）？让数据类型约束Domain Model显然不是一个好想法，所以DTO似乎是必不可少的了。

既然我们要使用DTO，那么有一件事我们就非做不可了，我们从领域层得到的是领域Model，如何把领域Model转换成只带有数据属性的DTO传递到前台呢？又或者我们从前台提交一个DTO对象，如何将DTO转换成领域Model而提交到后台呢？这个时候就需要我们的对象映射工具，目前市面上对象映射工具较多，但博主最熟悉的还是Automapper，这章就来分享下Automapper的使用。
DDD领域驱动设计初探系列文章：

• C#进阶系列——DDD领域驱动设计初探（一）：聚合
• C#进阶系列——DDD领域驱动设计初探（二）：仓储Repository（上）
• C#进阶系列——DDD领域驱动设计初探（三）：仓储Repository（下）
• C#进阶系列——DDD领域驱动设计初探（四）：WCF搭建
• C#进阶系列——DDD领域驱动设计初探（五）：AutoMapper使用
• C#进阶系列——DDD领域驱动设计初探（六）：领域服务

• C#进阶系列——DDD领域驱动设计初探（七）：Web层的搭建

  一、AutoMapper

  Automapper是一个object-object mapping（对象映射）工具，一般主要用于两个对象之间数据映射和交换。当然你也可以自己通过反射去写对象的映射，对于简单的两个属性间的数据转换，肯定没什么问题。但是如果遇到某些复杂的数据转换，比如指定某一个对象的某个属性映射到另一个对象的某一个属性，这种情况如果我们自己手动映射，恐怕就有点麻烦了吧。既然我们有现成的工具，为什么不用呢？

  二、AutoMapper引用到项目中

  向项目中添加AutoMapper的引用有两种方式：

  1、Nuget方式

  在需要使用AutoMapper的项目文件上面右键→管理Nuget程序包，打开Nuget界面，搜索Automapper，然后安装第一个即可。如下图：
  

  2、程序包管理控制台方式

  点击Visual Studio的工具菜单→程序包管理控制台，然后选择需要安装Automapper的项目（下图中的默认项目），最后在控制台里面输入命令“Install-Package AutoMapper”命令即可按照Automapper包：
  

  三、AutoMapper使用代码示例

  1、最简单的对象映射

  AutoMapper使用起来还是比较简单的，最简单的用法你只需要两句话：
  var oMenu = new TB_MENU() { MENU_NAME=”权限管理”, MENU_LEVEL=”1” };
  Mapper.CreateMap();
  var oDto = Mapper.Map(oMenu);
  首先创建映射，然后传入需要映射的对象执行映射。相信在项目中使用过AutoMapper的原因肯定也写过类似这样的AutoMapperHelper

  /// <summary>
  /// AutoMapper帮助类
  /// </summary>
  public static class AutoMapperHelper
  {
    /// <summary>
    ///  单个对象映射
    /// </summary>
    public static T MapTo<T>(this object obj)
    {
        if (obj == null) return default(T);
        Mapper.CreateMap(obj.GetType(), typeof(T));
        return Mapper.Map<T>(obj);
    }
    /// <summary>
    /// 集合列表类型映射
    /// </summary>
    public static List<TDestination> MapToList<TSource, TDestination>(this IEnumerable<TSource> source)
    {
        Mapper.CreateMap<TSource, TDestination>();
        return Mapper.Map<List<TDestination>>(source);
    }
  }

  当然，这是最简单的用法，稍微复杂点的用法我们在后面慢慢介绍。

  2、指定字段的对象映射

  前面说了，对于指定某一个对象的某个属性映射到另一个对象的某一个属性，这种场景，我们先来看看下面代码：
  

  public partial class TB_USERS : BaseEntity
  {
    public string USER_ID { get; set; }
    public string USER_NAME { get; set; }
    public string USER_PASSWORD { get; set; }
    public string FULLNAME { get; set; }
    public string DEPARTMENT_ID { get; set; }
  public virtual TB_DEPARTMENT TB_DEPARTMENT { get; set; }
  //...后面肯定还有其他领域行为
  }
  public partial class TB_DEPARTMENT : BaseEntity
  {
    public string DEPARTMENT_ID { get; set; }
    public string NAME { get; set; }
  }

  领域层有这两个实体model，然后我们需要得到下面的DTO_TB_USERS这一个对象

  public class DTO_TB_USERS
  {
    [DataMember]
    public string USER_ID { get; set; }
    [DataMember]
    public string USER_NAME { get; set; }
    [DataMember]
    public string USER_PASSWORD { get; set; }
    [DataMember]
    public string FULLNAME { get; set; }
    [DataMember]
    public string DEPARTMENT_ID { get; set; }
     [DataMember]
  　  public string DEPARTMENT_NAME { get; set; }
  }

  这个时候DTO_TB_USERS这个对象的属性分布在其他两个领域实体里面，我们看看AutoMapper如何解决：
  var oDomainUser = userRepository.Entities.FirstOrDefault();
  var map = Mapper.CreateMap();
  map.ForMember(d => d.DEPARTMENT_NAME, opt => opt.MapFrom(x => x.TB_DEPARTMENT.NAME));
  var oDto = Mapper.Map(oDomainUser);
  通过上面的代码，ForMember()方法会指定哪个字段转换为哪个字段，这样就完美的将对象的层级结构由二级变成了一级（即将TB_USERS下面TB_DEPARTMENT对象的NAME值转换成了DTO_TB_USERS的DEPARTMENT_NAME值）。除此之外，Automapper里面还可以通过ForMember帮我们做其他很多我们想不到的事情，比如可以设置某个属性值保留初始值，只需要通过
  map.ForMember(d => d.DEPARTMENT_NAME, opt => opt.Ignore());
  这一句就帮我们搞定。

  3、传递lamada的表达式映射

  还记得我们在仓储里面封装了传递lamada表达式的查询方法么？试想，如果我们在Web层里面也希望传递lamada表达式去后台查询，那么这个时候就有点问题了，因为我们Web里面只能访问DTO的Model，所以只能传入DTO Model的lamada，而我们仓储里面需要传入的是领域Model的lamada，那么问题就来了，这两个lamada表达式之间必须存在一个转换关系，试想，这些东西如果让我们手动去处理，还是有难度的吧！还好，我们神奇的Automapper替我们想到了。它能够帮我们将DTO的lamada转换成领域Model的lamada，来看看代码吧：

  [Import]
  public IUserRepository userRepository { get; set; }
  public virtual IList<DTO> Find(Expression<Func<DTO, bool>> selector)
  {
    //得到从Web传过来和DTOModel相关的lamaba表达式的委托
    Func<DTO, bool> match = selector.Compile();
    //创建映射Expression的委托
    Func<T, DTO> mapper = AutoMapper.QueryableExtensions.Extensions.CreateMapExpression<T, DTO>(Mapper.Engine).Compile();
    //得到领域Model相关的lamada
    Expression<Func<T, bool>> lamada = ef_t => match(mapper(ef_t));
    List<T> list = userRepository.Find(lamada).ToList();
    return Mapper.Map<List<T>, List<DTO>>(list);
  }

  上面方法完美实现了两种lamada之间的转换，但根据博主的使用经历，这种转换对属性的类型有很严格的要求，必须保证领域model和DTO的Model同一个属性的类型完全相同，否则容易报异常。使用的时候需要注意。实际使用的方法：

  public List<DtoModel> GetDtoByLamada<DtoModel,DomainModel>(IRepository<DomainModel> oRepository,  Expression<Func<DtoModel, bool>> selector = null)
    where DomainModel : AggregateRoot
    where DtoModel : DTO_BASEMODEL
  {
    if (selector == null)
    {
        var lstDomainModel = oRepository.Entities.ToList();
        return Mapper.Map<List<DomainModel>, List<DtoModel>>(lstDomainModel);
    }
    //得到从Web传过来和DTOModel相关的lamaba表达式的委托
    Mapper.CreateMap<DtoModel, DomainModel>();
    Mapper.CreateMap<DomainModel, DtoModel>();
    Func<DtoModel, bool> match = selector.Compile();
    //创建映射Expression的委托
    Func<DomainModel, DtoModel> mapper = AutoMapper.QueryableExtensions.Extensions.CreateMapExpression<DomainModel, DtoModel>(Mapper.Engine).Compile();
    //得到领域Model相关的lamada
    Expression<Func<DomainModel, bool>> lamada = ef_t => match(mapper(ef_t));
    List<DomainModel> list = oRepository.Find(lamada).ToList();
    return Mapper.Map<List<DomainModel>, List<DtoModel>>(list);
  }

  调用

  public class PowerManageWCFService :BaseService, IPowerManageWCFService
  {
    #region Fields
    [Import]
    private IUserRepository userRepository { get; set; }
    [Import]
    private IDepartmentRepository departmentRepository { get; set; }
    [Import]
    private IRoleRepository roleRepository { get; set; }
    [Import]
    private IMenuRepository menuRepository { get; set; } 
    #endregion
    #region Constust
    public PowerManageWCFService()
    {
        //注册MEF
        Regisgter.regisgter().ComposeParts(this);
    }
    #endregion
    #region WCF服务接口实现
    public List<DTO_TB_USERS> GetUsers(Expression<Func<DTO_TB_USERS, bool>> selector)
    {
        return base.GetDtoByLamada<DTO_TB_USERS, TB_USERS>(userRepository, selector);
    }
    public List<DTO_TB_DEPARTMENT> GetDepartments(Expression<Func<DTO_TB_DEPARTMENT, bool>> selector)
    {
        return base.GetDtoByLamada<DTO_TB_DEPARTMENT, TB_DEPARTMENT>(departmentRepository, selector);
    }
    public List<DTO_TB_ROLE> GetRoles(Expression<Func<DTO_TB_ROLE, bool>> selector)
    {
        return base.GetDtoByLamada<DTO_TB_ROLE, TB_ROLE>(roleRepository, selector);
    }
    public List<DTO_TB_MENU> GetMenus(Expression<Func<DTO_TB_MENU, bool>> selector)
    {
        return base.GetDtoByLamada<DTO_TB_MENU, TB_MENU>(menuRepository, selector);
    } 
    #endregion
  }

  4、Automapper的其他应用

  除了上面介绍的Automapper的几个简单使用，其他还有其他的一些用法。
  网上很多介绍DataReader对象和实体类之间的映射：

  using (IDataReader reader = db.ExecuteReader(command))
  {
    if (reader.Read())
    {
        return AutoMapper.Mapper.DynamicMap<Product>(reader);
    }
  }

  至此，AutoMapper的常见用法基本分享完了，至于更高级的用法，有兴趣可以看看蟋蟀兄的【AutoMapper官方文档】DTO与Domin Model相互转换（上）。虽然很多高级用法在实际项目中很难用上，但多了解一点似乎也并没有坏处。

• 本文作者：GeekPower - Felix Sun
• 版权声明： 本博客所有文章除特别声明外，均采用 MIT 许可协议。转载请注明出处！