.Net高級進階,教你如何構建企業模型數據攔截層,動態控制字段驗證


現在,你有一個MVC架構的web項目,你要完成一個注冊功能。

前台傳了3個值到你的控制器,分別是賬號、密碼、郵箱。

如圖:現在你要在控制器里面判斷,賬號名稱、密碼、郵箱不能為空,並且名稱和密碼不超過16位。

上面這個圖只是個理想中的小例子,實際開發情況是,可能一次性要傳十幾個字段甚至更多。

那么在實際開發中,通常為了復用性,我們將這3個參數用一個實體類來代替。

即如下所示。

注:這一步會有個知識點,叫做模型驗證,不懂的童鞋可以百度下,MVC會通過一定規則自動直接將參數反序列化成所對應的實體類,但是因為我這個示例是webapi模式的,寫法略有不同,所以還要在參數前加個[FromBody]才能自動反序列化。

至於具體為什么會自動反序列化,在本篇並不是我要講的主題,所以感興趣的童鞋可以百度下:MVC下的ModelBinder    。

攔截層的解耦

現在,我認為把實體類驗證給帶到控制器里去寫的這種方式有點不美,如果業務規則多的話,那么這樣的驗證代碼就非常龐大,並且如果整個項目都采用這種驗證模式,那么在我日后的維護階段中就顯得有點臃腫的感覺,實體類依賴於控制器方法去驗證,我得先找到這個實體類,然后仔細想想有哪些方法用到了該實體類,又做了哪些驗證判斷,然后維護。

那么我能不能在控制器方法中 驗證實體類這一步 給挪掉,不寫到控制器的方法當中,寫在另一個地方,統一進行管理,實現實體類的驗證與控制器中的方法業務邏輯分除。

這種行為操作有點像httpModule,思想上就是設計模式所謂的降低耦合性了。

那么怎么做呢?

我們可以直接在實體類中加驗證,如圖

上面看到[Required],[StringLength],[RegularExpression]的這些叫做驗證特性,是.net框架已經封裝好的,它會對標注特性的字段采取驗證。

[Required]限制了必須輸入,[Required(ErrorMessage = "請輸入用戶名")]  

[StringLength]限制了規定的長度,[StringLength(10, ErrorMessage = "長度不能超過10個字符")]  

[Range] 限制了值的范圍,[Range(0, 120, ErrorMessage = "年齡范圍在0到120歲之間")]  

[RegularExpression] 限制了必須滿足正則表達式,[RegularExpression(@"^\w+([-+.]\w+)*@\w+([-.]\w+)*\.\w+([-.]\w+)*$", ErrorMessage = "請輸入Email格式")]  

[Compare]限制了與之對應的字段相等,[Compare("pwd", ErrorMessage = "兩次密碼要一致")]  //該特性標注的字段值必須與pwd字段值相等

.net也就封裝了幾個,這5個用的最多(當然,也可以自定義這種驗證特性,對這塊想深入了解的請百度:mvc ValidationAttribute)。

那么我標注了特性后如何進行判斷呢?

  

我們看下控制器方法中的寫法:

如圖,用 ModelState.IsValid  這段話來對驗證結果進行判定,如果實體類上的被標注的特性滿足條件的話,就為true,否則為false。

那么,因為這種模型驗證是種模式,是全局的,所以應該單獨拿出來在攔截層進行注冊。

如圖:

這段代碼的意思就是:每當進入控制器方法之前,會判斷這個方法的名稱,如果包含的有Insert、check、update這三者的任意一個,都會進行攔截驗證(對模型驗證的結果進行判定),如果為false,那么就返回給客戶端一個400狀態碼。

然后注冊一下:(注冊的地方只是個范例,因為我是webapi,只對http進行攔截)

 

model負責填寫規則,驗證由專門的驗證人員去做,邏輯由專門的邏輯人員去寫,這樣就各司其職了。

 不過,這才只是第一步!

(隨着你日常的開發,你肯定會遇到這種情況)

user實體類,是專注於注冊方法,說白了,就是為注冊方法所寫的,

我現在還要寫個登錄方法。

但是登錄的時候,我不需要填寫email,只需要填寫賬號和密碼,對這兩個字段進行驗證。

可是我的實體類里面對email做了[Required]和[RegularExpression]驗證,那么這樣就導致了 如果我登錄方法繼續使用這個user實體類,那么肯定會報錯,會返回個400驗證碼。

這種情況我該怎么解決?難道重新建個model?再重新給一遍規則?這還僅僅只有3個字段,萬一有的表中有十幾個字段,二十幾個字段甚至更多怎么辦?

重新建個model肯定不行,這樣已經失去了   復用性、各司其職  的初衷。

求解決方案!在線等!

...

模型驗證進階:自由控制需要驗證的字段

百度了一下,網上沒有該方面的教程,博客園中也沒找到,群里也沒交流出個結果,但這種情況卻經常遇到!

 梳理下思路,大致有幾種,第一種是用某種手段控制類中的這些驗證特性,或者控制類中的屬性字段,如啟用或停用,但是c#不能對屬性字段進行停啟用,而控制類中的這些驗證特性也有點天方夜譚,本身就是微軟封裝好的,你得反編譯一下看下源碼,然后重構?或者你直接不用這些框架封裝好的驗證特性,使用自己定義自定義驗證特性,然后把控制方法都寫在里面?這樣太麻煩,而且違背初衷。自定義ModelBinder ?更扯淡。

一番折騰無果,那么就不能從特性本身找突破口了,這時,我把目標轉移到ModelState.IsValid上,換一種思路實現。

我們發現其實現了GetEnumerator方法,於是對其進行遍歷,可以獲取到特性所綁定的字段屬性的名稱以及其狀態。

因為要實現自由控制需要驗證的字段,所以無論怎樣實現,都只能通過 自定義特性 標注在方法體頭上來實現。

而理想的最終呈現效果應該是這樣的:

放圖:

 

或者

 

 

使用方式:

如果方法頭上有KeepZ特性的話,就進入自由控制驗證字段狀態。

 

[KeepZ("字段1","字段2")]  即:只對  字段1 和 字段2   進行驗證

[KeepZ(false,"字段3")]  即:除了  字段3  之外,其余字段都進行驗證

 

 

那么我們放下具體實現代碼:

 

 public override void OnActionExecuting(HttpActionContext actionContext)
        {
            if ((actionContext.ActionDescriptor.ActionName.ToUpper().Contains("INSERT") || actionContext.ActionDescriptor.ActionName.ToUpper().Contains("CHECK") ||
                 actionContext.ActionDescriptor.ActionName.ToUpper().Contains("UPDATE")))
            {
                var ia = actionContext.ActionDescriptor.GetCustomAttributes<KeepZ>();
                if (ia.Count != 1)
                {
                    goto result;
                }
                foreach (KeyValuePair<string, ModelState> item in actionContext.ModelState.ToArray())
                {
                    if (ia[0].Modes == false)
                    {
                        foreach (string PropertysValue in ia[0].Propertys)
                        {
                            if (item.Key.Contains(PropertysValue))
                            {
                                actionContext.ModelState.Remove(item.Key);
                            }
                        }
                    }
                    else
                    {
                        bool re = false;
                        foreach (string PropertysValue in ia[0].Propertys)
                        {
                            if (item.Key.Contains(PropertysValue))
                            {
                                re = true;
                            }
                        }
                        if (re == false)
                        {
                            actionContext.ModelState.Remove(item.Key);
                        }
                    }
                }
                result: if (!actionContext.ModelState.IsValid)
                {
                  
                    actionContext.Response = actionContext.Request.CreateErrorResponse(HttpStatusCode.BadRequest, actionContext.ModelState);
                   
                      
                }
            }
        }
/// <summary>
    ///  保持
    /// </summary>
    public class KeepZ : Attribute
    {
        public string[] Propertys = null;
        public bool Modes = true;
        public KeepZ(params string[] Property)
        {
            Propertys = Property;
        }
        public KeepZ(bool Mode, params string[] Property)
        {
            Propertys = Property;
            Modes = Mode;
        }
    }

如此一來,就不用再重建Model這樣費時費力的方法了,現在MVC架構大多都用這種驗證模式,但是卻沒有  自由選擇驗證字段的解決方案,每每遇到該情況,只能無奈重新建個實體類,對比之下,根本沒有食得這種攔截層模型驗證的精髓,只學個模子,反而弄巧成拙不成本意,所以我寫了此篇和大家一起分享,加入了KeepZ來控制需要驗證的字段,就是真正的實現了  可 復用  ,邏輯與攔截分層  了。

Demo雖小,但是這種情況下的解決方案,我在博客園中沒找到,應該是園子里第一篇吧。

注意,BindAttribute 這個特性,是 針對賦值上的處理, 選擇賦值 和 選擇驗證 是 兩個 看似相同卻截然不同的兩個分支,本文是 自由控制驗證攔截 ,所適用性在某些場景要比 BindAttribute 要多,當然,不介意的話, 你也可以 將 BindAttribute  帶入本實例中,也是可以的, 剔除驗證的時候 剔除賦值。

 

作者:小曾
出處:http://www.cnblogs.com/1996V/p/7423834.html 歡迎轉載,但任何轉載必須保留完整文章,在顯要地方顯示署名以及原文鏈接。如您有任何疑問或者授權方面的協商,請給我留言
.Net交流群, QQ群:166843154 欲望與掙扎 


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM