ABP(現代ASP.NET樣板開發框架)系列之1三、ABP領域層——數據過濾器（Data filters）

時間 2019-12-13

標籤 abp 現代 asp.net asp 樣板開發框架系列領域數據過濾器 data filters 欄目 ASP 简体版

原文原文鏈接

點這裏進入ABP系列文章總目錄html

基於DDD的現代ASP.NET開發框架--ABP系列之1三、ABP領域層——數據過濾器（Data filters）
git

ABP是「ASP.NET Boilerplate Project (ASP.NET樣板項目)」的簡稱。github

ABP的官方網站：http://www.aspnetboilerplate.com數據庫

ABP在Github上的開源項目：https://github.com/aspnetboilerplate安全

介紹

在數據庫開發中，咱們通常會運用軟刪除(soft-delete)模式,即不直接從數據庫刪除數據,而是標記這筆數據爲已刪除。所以,若是實體被軟刪除了,那麼它就應該不會在應用程序中被檢索到。要達到這種效果,咱們須要在每次檢索實體的查詢語句上添加SQL的Where條件IsDeleted = false。這是個乏味的工做，但它是個容易被忘掉的事情。所以,咱們應該要有個自動的機制來處理這些問題。架構

ABP提供數據過濾器(Data filters),它使用自動化的，基於規則的過濾查詢。ABP已經有一些預約義的過濾器,固然也能夠自行建立你專屬的過濾器。框架

注意：只針對EntityFramework:ABP數據過濾器僅實如今EntityFramework。還沒法在其它ORM工具中使用。見其它ORM章節於本文末端。 ide

預約義過濾器

軟刪除接口(ISoftDelete)

軟刪除過濾器(Soft-delete filter )會過濾從數據庫查詢出來的實體且是自動套用(從結果集中提取出來)。若是實體須要被軟刪除,它須要實現ISoftDelete接口,該接口僅定義了一個IsDeleted屬性。例:工具

  public class Person : Entity, ISoftDelete {
      public virtual string Name { get; set; }
      public virtual bool IsDeleted { get; set; }
   }

Person實體實際上並無從數據庫中被刪除,當刪除此實體時,IsDeleted屬性值會被設定爲true。當你使用IRepository.Delete方法時,ABP會自動完成這些工做(你能夠手動設定IsDeleted爲true,可是Delete方法更加天然且是較建議的方式)。網站

當實現了ISoftDelete以後,當你已經從數據庫中取得了People列表,已被刪除的People實體並不會被檢索到。在這裏有一個示例類,該類使用了person倉儲來取得全部的People實體:

   public class MyService {
      private readonly IRepository<Person> _personRepository;

      public MyService(IRepository<Person> personRepository) {
         _personRepository = personRepository;
      }

      public List<Person> GetPeople() {
         return _personRepository.GetAllList();
      }
   }

GetPeople方法僅取得Person實體,該實體其IsDeleted = false(非刪除狀態)。全部的倉儲方法以及導航屬性都可以正常運做。咱們能夠添加一些其它的Where條件,Join...等等。它將會自動地添加IsDeleted=false條件到生成的SQL查詢語句中。

注意：什麼時候啓用?ISoftDelete過濾器老是啓用,除非你直接禁用它。

提醒:若是你實現了IDeletionAudited接口(該接口繼承自ISoftDelete),刪除建立時間和被刪除的用戶Id，這些都會由ABP進行自動的處理。

多租接口(IMustHaveTenant)

若是你建立一個多租戶的應用程序(儲存全部租戶的數據於單一一個數據庫中),你確定不會但願某個租戶看到其它租戶的資料。你能夠實現IMustHaveTenant接口於此案例中,示例以下:

   public class Product : IMustHaveTenant {
      public virtual int TenantId { get; set; }

      public virtual string Name { get; set; }
   }

IMustHaveTenant定義了TenantId來區別不一樣的租戶實體。ABP使用IAbpSession來取得當前TenantId而且自動地替當前租戶進行過濾查詢的處理。

注意：什麼時候啓用?IMustHaveTenant默認是啓用的。若是當前使用並無登入到系統或是當前用戶是一個管理級使用者(管理級使用者即爲一個最高權限的使用者,它能夠管理全部租戶和租戶的資料),ABP會自動地禁用IMustHaveTenant過濾器。所以,全部的租戶的數據均可以被應用程序所檢索。注意,這與安全性無關,你應該要對敏感數據進行驗證受權處理。

多租接口(IMayHaveTenant)

若是一個實體類由多個租戶(tenant)以及管理級使用者(host)所共享(這意味着該實體對象或許由租戶(tenant)或是管理級使用者(host)所掌控),你可使用IMayHaveTenantfilter。IMayHaveTenant接口定義了TenantId可是它是可空類(nullable)。

   public class Product : IMayHaveTenant {
      public virtual int? TenantId { get; set; }

      public virtual string Name { get; set; }
   }

當爲null值,則表明這是一個管理級使用者(host)所掌控的實體,若爲非null值,則表明這個實體是由租戶(tenant)所掌控,而其Id值即爲TenantId。ABP使用IAbpSession接口來取得當前TenantId。IMayHaveTenant過濾器並不如IMustHaveTenant廣泛經常使用。可是看成爲管理級使用者(host)和租戶(tenant)所須要的通用結構使用時,你或許會須要用到它。

什麼時候啓用?IMayHaveTenant接口老是啓用的,除非你直接禁用它。

禁用過濾器

能夠在工做單元(unit of work)中調用DisableFilter方法來禁用某個過濾器,以下所示:

var people1 = _personRepository.GetAllList();
using(_unitOfWorkManager.Current.DisableFilter(AbpDataFilters.SoftDelete)) {
      var people2 = _personRepository.GetAllList();
   }

var people3 = _personRepository.GetAllList();

DisableFilter方法取得一或多個過濾器名稱,且類型皆爲string。AbpDataFilters.SoftDelete是一個常數字符串其包含了ABP標準的軟刪除過濾器。

people2亦可取得已標記爲刪除的People實體,而people1和people3將會是惟一的非已標記爲刪除的People實體。若配合使用using語法,你能夠禁用其控制範圍內(Scope)的過濾器。若是你不使用 using 語法 ,此過濾器會被一直禁用，直到工做單元（unit of work）結束或者再度啓用它。(意思是：若是你使用"using"關鍵字聲明,過濾器是啓用狀態；當前工做單元(unit of work)結束後，過濾器是禁止狀態。若是不使用"using"關鍵字聲明，默認過濾器是禁用狀態，此時能夠手動啓用過濾器。)

你能夠注入IUnitOfWorkManager而且在上述示例中使用。一樣的,你可使用CurrentUnitOfWork屬性做爲一個在應用服務中的簡便方式(它是從ApplicationService類繼承而來的)。

注意：關於using語法:假如過濾器在你調用DisableFilter方法並配合using語法以前已經是啓用,則過濾器會被禁用,而且會自動地在using語法結束後在度啓用。可是若過濾器在using語法以前就已經被禁用了,DisableFilter方法實際上並不作任何式,而且過濾器會維持禁用狀態即使是using語法的結束後。

啓用過濾器

你能夠在工做單元(unit of work)中使用EnableFilter方法啓用過濾器,如同DisableFilter方法通常(二者互爲正反兩面)。EnableFilter亦會返回disposable來自動地從新禁用過濾器。

設定過濾器參數

過濾器能夠被參數化(parametric)。IMustHaveTenant過濾器是這類過濾器的一個範本,由於當前租戶(tenant)的Id是在執行時期決定的。對於這些過濾器,若是真有須要,咱們能夠改變過濾器的值。舉例以下:

CurrentUnitOfWork.SetFilterParameter("PersonFilter", "personId", 42);

另外一個示例以下:設定IMayHaveTenant過濾器的tenantId值:

 
  CurrentUnitOfWork.SetfilterParameter(AbpDataFilters.MayHaveTenant, AbpDataFilters.Parameters.TenantId, 42); 
 

自定義過濾器

欲建立定製的過濾器而且整合到ABP中,首先咱們須要定義一個接口,該接口將會由使用這個過濾器的實體所實現。假設咱們想要自動化地依PersonId進行過濾,示例以下:

 public interface IHasPerson {
      int PersonId { get; set; }
   }

而後咱們就能夠實現這個接口在咱們的實體上了,示例以下:

   public class Phone : Entity, IHasPerson {
      [ForeignKey("PersonId")]
      public virtual Person Person { get; set; }

      public virtual int PersonId { get; set; }

      public virtual string Number { get; set; }
   }

由於ABP使用EntityFramework.DynamicFilters這個過濾器,咱們使用它的規則(rule)來定義過濾器。在咱們的DbContext類中,咱們重寫了OnModelCreating而且定義了過濾器以下示例所示:

  protected override void OnModelCreating(DbModelBuilder modelBuilder) {
      base.OnModelCreating(modelBuilder);
      modelBuilder.Filter("PersonFilter", (IHasPerson entity, int personId) => entity.PersonId == personId, 0 );
   }

PersonFilter過濾器在這裏是一個惟一的過濾器名稱。再來就是過濾器接口的參數定義和personId過濾器參數(不必定須要,假如過濾器是屬於不可參數化(parametric)型),最後一個參數爲personId的默認值。

最後一個步驟,咱們須要註冊這個過濾器到ABP工做單元(unit of work)系統中,設定的位置在咱們模塊裏的PreInitialize方法。

Configuration.UnitOfWork.RegisterFilter("PersonFilter", false);

第一個參數是咱們剛剛所定義的惟一名稱,第二個參數指示這個過濾器預設是啓用仍是禁用。在聲明完這些可參數化(parametric)的過濾器後,咱們能夠在執行期間指定它的值來操做這個過濾器。

   using(CurrentUnitOfWork.EnableFilter("PersonFilter")) {
      CurrentUnitOfWork.SetFilterParameter("PersonFilter", "personId", 42);
      var phone = _phoneRepository.GetAllList();
      // ...
   }