這篇文章主要講解了“ASP.NET怎么自定義數(shù)據(jù)過(guò)濾器”，文中的講解內(nèi)容簡(jiǎn)單清晰，易于學(xué)習(xí)與理解，下面請(qǐng)大家跟著小編的思路慢慢深入，一起來(lái)研究和學(xué)習(xí)“ASP.NET怎么自定義數(shù)據(jù)過(guò)濾器”吧！
目前創(chuàng)新互聯(lián)已為上1000家的企業(yè)提供了網(wǎng)站建設(shè)、域名、雅安服務(wù)器托管、網(wǎng)站改版維護(hù)、企業(yè)網(wǎng)站設(shè)計(jì)、寧津網(wǎng)站維護(hù)等服務(wù)，公司將堅(jiān)持客戶導(dǎo)向、應(yīng)用為本的策略，正道將秉承"和諧、參與、激情"的文化，與客戶和合作伙伴齊心協(xié)力一起成長(zhǎng)，共同發(fā)展。
在數(shù)據(jù)庫(kù)開(kāi)發(fā)中，我們一般會(huì)運(yùn)用軟刪除(soft-delete)模式,即不直接從數(shù)據(jù)庫(kù)刪除數(shù)據(jù),而是標(biāo)記這筆數(shù)據(jù)為已刪除。因此,如果實(shí)體被軟刪除了,那么它就應(yīng)該不會(huì)在應(yīng)用程序中被檢索到。要達(dá)到這種效果,我們需要在每次檢索實(shí)體的查詢語(yǔ)句上添加SQL的Where條件IsDeleted = false。這是個(gè)乏味的工作，但它是個(gè)容易被忘掉的事情。因此,我們應(yīng)該要有個(gè)自動(dòng)的機(jī)制來(lái)處理這些問(wèn)題。
ABP提供數(shù)據(jù)過(guò)濾器(Data filters),它使用自動(dòng)化的，基于規(guī)則的過(guò)濾查詢。ABP已經(jīng)有一些預(yù)定義的過(guò)濾器,當(dāng)然也可以自行創(chuàng)建你專屬的過(guò)濾器。
注意：只針對(duì)EntityFramework:ABP數(shù)據(jù)過(guò)濾器僅實(shí)現(xiàn)在EntityFramework。還無(wú)法在其它ORM工具中使用。見(jiàn)其它ORM章節(jié)于本文末端。
軟刪除過(guò)濾器(Soft-delete filter )會(huì)過(guò)濾從數(shù)據(jù)庫(kù)查詢出來(lái)的實(shí)體且是自動(dòng)套用(從結(jié)果集中提取出來(lái))。如果實(shí)體需要被軟刪除,它需要實(shí)現(xiàn)ISoftDelete接口,該接口僅定義了一個(gè)IsDeleted屬性。例:
重慶分公司
重慶分公司
public class Person : Entity, ISoftDelete { public virtual string Name { get; set; } public virtual bool IsDeleted { get; set; }
}Person實(shí)體實(shí)際上并沒(méi)有從數(shù)據(jù)庫(kù)中被刪除,當(dāng)刪除此實(shí)體時(shí),IsDeleted屬性值會(huì)被設(shè)定為true。當(dāng)你使用IRepository.Delete方法時(shí),ABP會(huì)自動(dòng)完成這些工作(你可以手動(dòng)設(shè)定IsDeleted為true,但是Delete方法更加自然且是較建議的方式)。
當(dāng)實(shí)現(xiàn)了ISoftDelete之后,當(dāng)你已經(jīng)從數(shù)據(jù)庫(kù)中取得了People列表,已被刪除的People實(shí)體并不會(huì)被檢索到。在這里有一個(gè)示例類,該類使用了person倉(cāng)儲(chǔ)來(lái)取得所有的People實(shí)體:
public class MyService {
private readonly IRepository
public MyService(IRepository
_personRepository = personRepository;
}
public List
return _personRepository.GetAllList();
}
}
GetPeople方法僅取得Person實(shí)體,該實(shí)體其IsDeleted = false(非刪除狀態(tài))。所有的倉(cāng)儲(chǔ)方法以及導(dǎo)航屬性都能夠正常運(yùn)作。我們可以添加一些其它的Where條件,Join...等等。它將會(huì)自動(dòng)地添加IsDeleted=false條件到生成的SQL查詢語(yǔ)句中。
注意：何時(shí)啟用?ISoftDelete過(guò)濾器總是啟用,除非你直接禁用它。
提醒:如果你實(shí)現(xiàn)了IDeletionAudited接口(該接口繼承自ISoftDelete),刪除創(chuàng)建時(shí)間和被刪除的用戶Id，這些都會(huì)由ABP進(jìn)行自動(dòng)的處理。
如果你創(chuàng)建一個(gè)多租戶的應(yīng)用程序(儲(chǔ)存所有租戶的數(shù)據(jù)于單一一個(gè)數(shù)據(jù)庫(kù)中),你肯定不會(huì)希望某個(gè)租戶看到其它租戶的資料。你可以實(shí)現(xiàn)IMustHaveTenant接口于此案例中,示例如下:
public class Product : IMustHaveTenant { public virtual int TenantId { get; set; } public virtual string Name { get; set; }
}IMustHaveTenant定義了TenantId來(lái)區(qū)別不同的租戶實(shí)體。ABP使用IAbpSession來(lái)取得當(dāng)前TenantId并且自動(dòng)地替當(dāng)前租戶進(jìn)行過(guò)濾查詢的處理。
注意：何時(shí)啟用?IMustHaveTenant默認(rèn)是啟用的。如果當(dāng)前使用并沒(méi)有登入到系統(tǒng)或是當(dāng)前用戶是一個(gè)管理級(jí)使用者(管理級(jí)使用者即為一個(gè)最高權(quán)限的使用者,它可以管理所有租戶和租戶的資料),ABP會(huì)自動(dòng)地禁用IMustHaveTenant過(guò)濾器。因此,所有的租戶的數(shù)據(jù)都可以被應(yīng)用程序所檢索。注意,這與安全性無(wú)關(guān),你應(yīng)該要對(duì)敏感數(shù)據(jù)進(jìn)行驗(yàn)證授權(quán)處理。
如果一個(gè)實(shí)體類由多個(gè)租戶(tenant)以及管理級(jí)使用者(host)所共享(這意味著該實(shí)體對(duì)象或許由租戶(tenant)或是管理級(jí)使用者(host)所掌控),你可以使用IMayHaveTenantfilter。IMayHaveTenant接口定義了TenantId但是它是可空類(nullable)。
public class Product : IMayHaveTenant {
public virtual int? TenantId { get; set; }
public virtual string Name { get; set; }
}當(dāng)為null值,則代表這是一個(gè)管理級(jí)使用者(host)所掌控的實(shí)體,若為非null值,則代表這個(gè)實(shí)體是由租戶(tenant)所掌控,而其Id值即為TenantId。ABP使用IAbpSession接口來(lái)取得當(dāng)前TenantId。IMayHaveTenant過(guò)濾器并不如IMustHaveTenant普遍常用。但是當(dāng)作為管理級(jí)使用者(host)和租戶(tenant)所需要的通用結(jié)構(gòu)使用時(shí),你或許會(huì)需要用到它。
何時(shí)啟用?IMayHaveTenant接口總是啟用的,除非你直接禁用它。
可以在工作單元(unit of work)中調(diào)用DisableFilter方法來(lái)禁用某個(gè)過(guò)濾器,如下所示:
var people1 = _personRepository.GetAllList();
using(_unitOfWorkManager.Current.DisableFilter(AbpDataFilters.SoftDelete))
{
var people2 = _personRepository.GetAllList(); }
var people3 = _personRepository.GetAllList();DisableFilter方法取得一或多個(gè)過(guò)濾器名稱,且類型皆為string。AbpDataFilters.SoftDelete是一個(gè)常數(shù)字符串其包含了ABP標(biāo)準(zhǔn)的軟刪除過(guò)濾器。
people2亦可取得已標(biāo)記為刪除的People實(shí)體,而people1和people3將會(huì)是唯一的非已標(biāo)記為刪除的People實(shí)體。若配合使用using語(yǔ)法,你可以禁用其控制范圍內(nèi)(Scope)的過(guò)濾器。如果你不使用 using 語(yǔ)法 ,此過(guò)濾器會(huì)被一直禁用，直到工作單元（unit of work）結(jié)束或者再度啟用它。(意思是：如果你使用"using"關(guān)鍵字聲明,過(guò)濾器是啟用狀態(tài)；當(dāng)前工作單元(unit of work)結(jié)束后，過(guò)濾器是禁止?fàn)顟B(tài)。如果不使用"using"關(guān)鍵字聲明，默認(rèn)過(guò)濾器是禁用狀態(tài)，此時(shí)可以手動(dòng)啟用過(guò)濾器。)
你可以注入IUnitOfWorkManager并且在上述示例中使用。同樣的,你可以使用CurrentUnitOfWork屬性作為一個(gè)在應(yīng)用服務(wù)中的簡(jiǎn)便方式(它是從ApplicationService類繼承而來(lái)的)。
注意：關(guān)于using語(yǔ)法:假如過(guò)濾器在你調(diào)用DisableFilter方法并配合using語(yǔ)法之前已是啟用,則過(guò)濾器會(huì)被禁用,并且會(huì)自動(dòng)地在using語(yǔ)法結(jié)束后在度啟用。但是若過(guò)濾器在using語(yǔ)法之前就已經(jīng)被禁用了,DisableFilter方法實(shí)際上并不做任何式,并且過(guò)濾器會(huì)維持禁用狀態(tài)即便是using語(yǔ)法的結(jié)束后。
你可以在工作單元(unit of work)中使用EnableFilter方法啟用過(guò)濾器,如同DisableFilter方法一般(兩者互為正反兩面)。EnableFilter亦會(huì)返回disposable來(lái)自動(dòng)地重新禁用過(guò)濾器。
過(guò)濾器可以被參數(shù)化(parametric)。IMustHaveTenant過(guò)濾器是這類過(guò)濾器的一個(gè)范本,因?yàn)楫?dāng)前租戶(tenant)的Id是在執(zhí)行時(shí)期決定的。對(duì)于這些過(guò)濾器,如果真有需要,我們可以改變過(guò)濾器的值。舉例如下:
CurrentUnitOfWork.SetFilterParameter("PersonFilter", "personId", 42);另一個(gè)示例如下:設(shè)定IMayHaveTenant過(guò)濾器的tenantId值:
CurrentUnitOfWork.SetfilterParameter(AbpDataFilters.MayHaveTenant, AbpDataFilters.Parameters.TenantId, 42);
欲創(chuàng)建定制的過(guò)濾器并且整合到ABP中,首先我們需要定義一個(gè)接口,該接口將會(huì)由使用這個(gè)過(guò)濾器的實(shí)體所實(shí)現(xiàn)。假設(shè)我們想要自動(dòng)化地依PersonId進(jìn)行過(guò)濾,示例如下:
public interface IHasPerson {
int PersonId { get; set; }
}然后我們就可以實(shí)現(xiàn)這個(gè)接口在我們的實(shí)體上了,示例如下:
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; }
}
因?yàn)锳BP使用EntityFramework.DynamicFilters這個(gè)過(guò)濾器,我們使用它的規(guī)則(rule)來(lái)定義過(guò)濾器。在我們的DbContext類中,我們重寫(xiě)了OnModelCreating并且定義了過(guò)濾器如下示例所示:
protected override void OnModelCreating(DbModelBuilder modelBuilder) {
base.OnModelCreating(modelBuilder);
modelBuilder.Filter("PersonFilter", (IHasPerson entity, int personId) => entity.PersonId == personId, 0 );
}PersonFilter過(guò)濾器在這里是一個(gè)唯一的過(guò)濾器名稱。再來(lái)就是過(guò)濾器接口的參數(shù)定義和personId過(guò)濾器參數(shù)(不一定需要,假如過(guò)濾器是屬于不可參數(shù)化(parametric)型),最后一個(gè)參數(shù)為personId的默認(rèn)值。
最后一個(gè)步驟,我們需要注冊(cè)這個(gè)過(guò)濾器到ABP工作單元(unit of work)系統(tǒng)中,設(shè)定的位置在我們模塊里的PreInitialize方法。
Configuration.UnitOfWork.RegisterFilter("PersonFilter", false);第一個(gè)參數(shù)是我們剛剛所定義的唯一名稱,第二個(gè)參數(shù)指示這個(gè)過(guò)濾器預(yù)設(shè)是啟用還是禁用。在聲明完這些可參數(shù)化(parametric)的過(guò)濾器后,我們可以在執(zhí)行期間指定它的值來(lái)操作這個(gè)過(guò)濾器。
using(CurrentUnitOfWork.EnableFilter("PersonFilter")) {
CurrentUnitOfWork.SetFilterParameter("PersonFilter", "personId", 42);
var phone = _phoneRepository.GetAllList(); // ...
}我們可以從有些數(shù)據(jù)源中取得personId而不需要寫(xiě)死在程序代碼中。上述示例是為了要能夠程序化過(guò)濾器。過(guò)濾器可擁有0到更多的參數(shù)。假如是無(wú)參數(shù)的過(guò)濾器,它就不需要設(shè)定過(guò)濾器的值。同樣地,假如它預(yù)設(shè)是啟用,就不需要手動(dòng)啟用(當(dāng)然的,我們也可以禁用它)。
EntityFramework.DynamicFilters的文件:若需要更多關(guān)于動(dòng)態(tài)數(shù)據(jù)過(guò)濾器的相關(guān)信息,可以見(jiàn)其在git上的文件https://github.com/jcachat/EntityFramework.DynamicFilters
我們可以為安全性創(chuàng)建一個(gè)定制化的過(guò)濾器,主/被動(dòng)實(shí)體,多租戶...諸如此類的。
ABP數(shù)據(jù)過(guò)濾器僅實(shí)現(xiàn)在Entity Framework上。對(duì)于其它ORM工具則尚不可用。但是, 實(shí)際上,你可以模仿這個(gè)模式到其它使用倉(cāng)儲(chǔ)來(lái)取得數(shù)據(jù)的案例下。這此案例中, 你可以創(chuàng)建一個(gè)定制的倉(cāng)儲(chǔ)并且覆寫(xiě)GetAll方法,如果有需要的話,可以一起修改其它資料檢索方法。
感謝各位的閱讀，以上就是“ASP.NET怎么自定義數(shù)據(jù)過(guò)濾器”的內(nèi)容了，經(jīng)過(guò)本文的學(xué)習(xí)后，相信大家對(duì)ASP.NET怎么自定義數(shù)據(jù)過(guò)濾器這一問(wèn)題有了更深刻的體會(huì)，具體使用情況還需要大家實(shí)踐驗(yàn)證。這里是創(chuàng)新互聯(lián)，小編將為大家推送更多相關(guān)知識(shí)點(diǎn)的文章，歡迎關(guān)注！
