ASP.NET怎么自定義數據過濾器

這篇文章主要講解了“ASP.NET怎么自定義數據過濾器”，文中的講解內容簡單清晰，易于學習與理解，下面請大家跟著小編的思路慢慢深入，一起來研究和學習“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到更多的參數。假如是無參數的過濾器,它就不需要設定過濾器的值。同樣地,假如它預設是啟用,就不需要手動啟用(當然的,我們也可以禁用它)。

EntityFramework.DynamicFilters的文件:若需要更多關于動態數據過濾器的相關信息,可以見其在git上的文件https://github.com/jcachat/EntityFramework.DynamicFilters

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

其它對象關系映射工具

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

感謝各位的閱讀，以上就是“ASP.NET怎么自定義數據過濾器”的內容了，經過本文的學習后，相信大家對ASP.NET怎么自定義數據過濾器這一問題有了更深刻的體會，具體使用情況還需要大家實踐驗證。這里是億速云，小編將為大家推送更多相關知識點的文章，歡迎關注！