9.2 ABP基础设施层 - 集成NHibernate

ABP可以与任何ORM框架协同工作，它内置了对NHibernate的集成支持。本文将介绍如何在ABP中使用NHibernate。本文假定你已经初步掌握了NHibernate。

  1. 译者注：怎么才算初步掌握了NHibernate呢？译者认为应当懂得使用NHibernate进行CRUD，懂得使用Fluent模式进行映射。

9.2.1 Nuget包

要在ABP中使用NHibernate作为ORM框架的话，需要到Nuget上下载一个名为Abp. NHibernate 的包。比较好的做法是：新建一个独立的程序集(dll)，然后在这个程序集中调用这个包和NHibernate。

  1. 译者注：ABP 官方提供的模板程序就是这样做的。模板程序的下载方法详见《 ABP 系列之 2、 ABP 入门教程》。

9.2.2 配置

要使用Nhibernate，首先要对它进行配置，配置的方法是在模块的PreInitialize方法中编写配置代码，如下所示：

  1. [DependsOn(typeof(AbpNHibernateModule))]
  2. public class SimpleTaskSystemDataModule : AbpModule
  3. {
  4.     public override void PreInitialize()
  5.     {
  6.         var connStr = ConfigurationManager.ConnectionStrings["Default"].ConnectionString;
  8.         Configuration.Modules.AbpNHibernate().FluentConfiguration
  9.             .Database(MsSqlConfiguration.MsSql2008.ConnectionString(connStr))
  10.             .Mappings(m => m.FluentMappings.AddFromAssembly(Assembly.GetExecutingAssembly()));
  11.     }
  13.     public override void Initialize()
  14.     {
  15.         IocManager.RegisterAssemblyByConvention(Assembly.GetExecutingAssembly());
  16.     }
  17. }

ABP之所以能与Nhibernate协同工作，是因为内置的AbpNHibernateModule模块提供了必要的适配器。

1. 实体映射（Entity mapping）

在下面的示例中，我们使用Fluent映射模式来对所有的实体类进行映射：

  1. public class TaskMap : EntityMap<Task>
  2. {
  3.     public TaskMap()
  4.         : base("TeTasks")
  5.     {
  6.         References(x => x.AssignedUser).Column("AssignedUserId").LazyLoad();
  7.         Map(x => x.Title).Not.Nullable();
  8.         Map(x => x.Description).Nullable();
  9.         Map(x => x.Priority).CustomType<TaskPriority>().Not.Nullable();
  10.         Map(x => x.Privacy).CustomType<TaskPrivacy>().Not.Nullable();
  11.         Map(x => x.State).CustomType<TaskState>().Not.Nullable();
  12.     }
  13. }

EntityMap类是ABP中的一个内置类，它派生自ClassMap类，可以自动地对Id属性进行映射，并且在构造函数中获取表名。在上例中我们从EntityMap中派生，然后使用FluentNHibernate来映射其它属性。当然，你也可以直接从ClassMap中派生。在ABP中，你可以使用FluentNHibernate中定义的所有API。

在上例中我们使用了Fluent映射模式，你也可以使用其它映射模式，比如基于xml文件的映射模式

  1. 译者注： Nhibernate有四种映射模式：（1）基于XML的映射。（2）基于特性的映射。（3）Fluent映射。（4）基于约定的映射，也称为自动映射。

9.2.3 仓储实现

如果需求比较简单的话，你甚至不需要创建单独的仓储类，直接使用仓储的默认实现即可。如果实在需要创建单独的仓储类的话，建议从NhRepositoryBase中派生。

1. 默认实现（Default implementation)

如果你只想使用预定义的仓储方法的话，你甚至不需要为实体创建单独的仓储类。如下所示：

  1. public class PersonAppService : IPersonAppService
  2. {
  3.     private readonly IRepository<Person> _personRepository;
  5.     public PersonAppService(IRepository<Person> personRepository)
  6.     {
  7.         _personRepository = personRepository;
  8.     }
  10.     public void CreatePerson(CreatePersonInput input)
  11.     {        
  12.         person = new Person { Name = input.Name, EmailAddress = input.EmailAddress };
  14.         _personRepository.Insert(person);
  15.     }
  16. }

PersonAppService类采用构造函数注入的方式注入了一个IRepository\对象，然后调用了预定义的Insert方法。采用这种方式，你可以方便地注入IRepository\ （或者IRepository\）对象，然后调用预定义的方法。请查看仓储文档以获得预定义方法的列表。

2. 自定义仓储（Custom repositories）

如果你想添加自定义方法，最佳的作法是，首先将它添加到仓储接口中，然后在仓储类中实现。ABP提供了一个名为 NhRepositoryBase 的基类，这使得实现仓储变得简单快捷，要实现IRepository接口，只需要从这个基类中派生。

假定我们有一个名为Task的实体，它可以被赋予Person实体。Task有一个State属性（值为新建、已分配、已完成等）。我们需要编写一个自定义方法，这个方法能根据某些条件获取Task列表，并且使得Task的AssisgnedPerson属性可以在一次数据库查询中被加载（使用NHibernate的立即加载方法Fetch）。如下所示：

  1. public interface ITaskRepository : IRepository<Task, long>
  2. {
  3.     List<Task> GetAllWithPeople(int? assignedPersonId, TaskState? state);
  4. }
  6. public class TaskRepository : NhRepositoryBase<Task, long>, ITaskRepository
  7. {
  8.     public TaskRepository(ISessionProvider sessionProvider)
  9.         : base(sessionProvider)
  10.     {
  11.     }
  13.     public List<Task> GetAllWithPeople(int? assignedPersonId, TaskState? state)
  14.     {
  15.         var query = GetAll();
  17.         if (assignedPersonId.HasValue)
  18.         {
  19.             query = query.Where(task => task.AssignedPerson.Id == assignedPersonId.Value);
  20.         }
  22.         if (state.HasValue)
  23.         {
  24.             query = query.Where(task => task.State == state);
  25.         }
  27.         return query
  28.             .OrderByDescending(task => task.CreationTime)
  29.             .Fetch(task => task.AssignedPerson)
  30.             .ToList();
  31.     }
  32. }

预定义方法 GetAll() 返回了一个 IQueryable\ 对象，接着我们将参数放入到 Where 筛选器中，最后调用 ToList() 来获得一个Task列表。

你也能在仓储方法中使用 Session 对象，这样你就可以调用NHibernate所有API了。

注意：在 domain/core 层定义自定义仓储接口，并分层应用在 NHibernate 项目中实现定义的仓储接口。因此，你可以在任何项目中注入仓储接口，而不需要引用NH。

3. 应用程序专用的仓储基类（Application specific base repository class）

要实现仓储类，只需要从NhRepositoryBase中派生即可。但是更好的做法是，自定义一个派生自NhRepositoryBase的基类，然后在这个基类中添加一些通用的方法。这样做的好处是，所有派生自这个基类的仓储都继承了这些通用方法。

  1. // 应用程序中的所有仓储的基类
  2. public abstract class MyRepositoryBase<TEntity, TPrimaryKey> : NhRepositoryBase<TEntity, TPrimaryKey>
  3.     where TEntity : class, IEntity<TPrimaryKey>
  4. {
  5.     protected MyRepositoryBase(ISessionProvider sessionProvider)
  6.         : base(sessionProvider)
  7.     {
  8.     }
  9.     // 添加仓储基类的通用方法
  10. }
  11. //为所有拥有整型 Id 的实体添加一个快捷方式
  12. public abstract class MyRepositoryBase<TEntity> : MyRepositoryBase<TEntity, int>
  13.     where TEntity : class, IEntity<int>
  14. {
  15.     protected MyRepositoryBase(ISessionProvider sessionProvider)
  16.         : base(sessionProvider)
  17.     {
  18.     }
  19. // 不 要 在 这 里 添 加 任 何 通 用 方 法 ，通 用 方 法 应 当 被添加到 上 面 的 基 类 中（MyRepositoryBase<TEntity, TPrimaryKey>）
  20. }
  21. public class TaskRepository : MyRepositoryBase<Task>, ITaskRepository
  22. {
  23.     public TaskRepository(ISessionProvider sessionProvider)
  24.         : base(sessionProvider)
  25.     {
  26.     }
  27.     // 添加本仓储类的专用方法
  28. }

（6.1、6.2由深圳-Leo翻译）