基於DDD的現代ASP.NET開發框架--ABP系列之13、ABP領域層——資料過濾器（Data filters）

ABP是“ASP.NET Boilerplate Project (ASP.NET樣板專案)”的簡稱。

介紹

在資料庫開發中，我們一般會運用軟刪除(soft-delete)模式,即不直接從資料庫刪除資料,而是標記這筆資料為已刪除。因此,如果實體被軟刪除了,那麼它就應該不會在應用程式中被檢索到。要達到這種效果,我們需要在每次檢索實體的查詢語句上新增SQL的Where條件IsDeleted = false。這是個乏味的工作，但它是個容易被忘掉的事情。因此,我們應該要有個自動的機制來處理這些問題。

ABP提供資料過濾器(Data filters),它使用自動化的，基於規則的過濾查詢。ABP已經有一些預定義的過濾器,當然也可以自行建立你專屬的過濾器。

注意：只針對EntityFramework:ABP資料過濾器僅實現在EntityFramework。還無法在其它ORM工具中使用。見其它ORM章節於本文末端。 

預定義過濾器

軟刪除介面(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();
      // ...
   }

我們可以從有些資料來源中取得personId而不需要寫死在程式程式碼中。上述示例是為了要能夠程式化過濾器。過濾器可擁有0到更多的引數。假如是無引數的過濾器,它就不需要設定過濾器的值。同樣地,假如它預設是啟用,就不需要手動啟用(當然的,我們也可以禁用它)。

我們可以為安全性建立一個定製化的過濾器,主/被動實體,多租戶...諸如此類的。

其它物件關係對映工具

ABP資料過濾器僅實現在Entity Framework上。對於其它ORM工具則尚不可用。但是, 實際上,你可以模仿這個模式到其它使用倉儲來取得資料的案例下。這此案例中, 你可以建立一個定製的倉儲並且覆寫GetAll方法,如果有需要的話,可以一起修改其它資料檢索方法。

希望更多國內的架構師能關注到ABP這個專案，也許這其中有能幫助到您的地方，也許有您的參與，這個專案可以發展得更好。

歡迎加ABP架構設計交流QQ群：134710707