ASP.NET MVC ModelState與數據驗證【轉】

ViewData有一個ModelState的屬性，這是一個類型爲ModelStateDictionary的ModelState類型的字典集合。在進行數據驗證的時候這個屬性是比較有用的。在使用Html.ValidationMessage()的時候，就是從ViewData.ModelState中檢測是否有指定的KEY，若是存在，就提示錯誤信息。例如在前一篇文章ASP.NET MVC 入門七、Hellper與數據的提交與綁定中使用到的UpdateModel方法：

咱們在View中使用Html.ValidationMessage(string modelName)來對指定的屬性進行驗證：

Html.ValidationMessage()有幾個重載：

其中ValidationSummary()是用於顯示所有的驗證信息的。跟ASP.NET裏面的ValidationSummary驗證控件差很少。

咱們測試一下/Admin/Setting頁面：

在用UpdateModel方法更新BlogSettings.Instance.PostsPerPage的時候，當咱們如圖所示填寫"10d"的時候，因爲PostsPerPage爲整型的，因此UpdateModel方法就會出錯，同時會往ViewData.ModelState添加相應的錯誤信息，從而Html.ValidationMessage()方法就能夠從ViewData.ModelState中檢測到錯誤並提示。同時Html.ValidationMessage()方法會爲出錯的屬性的輸入框添加一個名爲"input-validation-error"的CSS類，同時後面的提示信息的CSS類名爲"field-validation-error"：

CSS類的樣式是能夠由咱們本身自由定義的。如上圖的紅色高亮顯示。

好，下面咱們來實現發表新隨筆的功能。咱們先寫一個提供用戶輸入隨筆內容的表單頁面：

<p>
<label for="Title">標題</label>
<%=Html.TextBox("Title", new { id = "Title", @class = "required" })%>
<%=Html.ValidationMessage("Title")%>
</p>
<p>
<label for="Content">內容</label>
<%=Html.TextArea("Content")%>
<%=Html.ValidationMessage("Content")%>
</p>
<p>
<label for="Slug">URL地址別名(若是爲空則和標題同名)</label>
<%=Html.TextBox("Slug", new { id = "Slug", @class = "required" })%>
<%=Html.ValidationMessage("Slug")%>
</p>

而後咱們對用戶提交過來的數據進行保存：

[AcceptVerbs("POST"), ActionName("NewPost")]
public ActionResult SaveNewPost(FormCollection form)
{
    Post post = new Post();
try
    {
        UpdateModel(post, new[] { "Title", "Content", "Slug" });
    }
catch
    {
return View(post);
    }
    post.Save();
return ShowMsg(new List<string>() { "發表新隨筆成功" });
}

因爲這三個值都是字符串類型，因此若是值爲空的話，UpdateModel也是不會出錯的，而咱們的Title和Content是不容許爲空的，或者咱們想咱們的Slug的長度不能超過100，也就是須要有咱們本身的業務規則。這時候咱們或許會這樣寫：

try
{
    UpdateModel(post, new[] { "Title", "Content", "Slug" });
}
catch
{
return View(post);
}
if (string.IsNullOrEmpty(post.Title))
{
    ViewData.ModelState.AddModelError("Title", post.Title, "標題不能爲空");
}
if (string.IsNullOrEmpty(post.Content))
{
    ViewData.ModelState.AddModelError("Content", post.Content, "內容不能爲空");
}
if (!ViewData.ModelState.IsValid)
{
return View(post);
}

ViewData.ModelState提供了一個AddModelError的方法，方便咱們添加驗證失敗的信息。咱們能夠如上代碼這樣進行對象的業務規則驗證，可是一旦業務規則多了，這樣的代碼是很是壯觀的，並且很差控制。那麼咱們該怎麼更好的進行業務規則的驗證呢？得意於BlogEngine.Net的良好架構，咱們能夠很輕鬆的完成這一點。

首先，讓咱們修改一下BlogEngine.Core裏面BusinessBase的代碼。咱們前面說過，BusinessBase實現了IDataErrorInfo接口，該接口有個索引器，致使ViewData.Eval()方法調用時搜索索引器的值時返回String.Empty而使ViewData.Eval()認爲是找到值了，從而失效。

咱們能夠將return string.Empty修改成return null。但咱們這裏並不須要用到這個接口，因此咱們把該接口去掉,並把相應的代碼註釋了。而後咱們再暴露一個BrokenRules的屬性，用於返回當前的全部破壞性業務規則(紅框部分代碼爲咱們添加的)：

BusinessBase提供了一個抽象的ValidationRules方法，用於在業務類重寫這個方法往裏面添加驗證規則(具體請看BusinessBase的Validation節)。

#region Validation

private StringDictionary _BrokenRules = new StringDictionary();
/// <summary>
/// 獲取全部的破壞性規則。
/// 在獲取前請用IsValid進行判斷。
/// </summary>
public StringDictionary BrokenRules
{
get
{
return _BrokenRules;
    }
}

/// <summary>
/// Add or remove a broken rule.
/// </summary>
/// <param name="propertyName">The name of the property.</param>
/// <param name="errorMessage">The description of the error</param>
/// <param name="isBroken">True if the validation rule is broken.</param>
protected virtual void AddRule(string propertyName, string errorMessage, bool isBroken)
{
if (isBroken)
{
        _BrokenRules[propertyName] = errorMessage;
    }
else
{
if (_BrokenRules.ContainsKey(propertyName))
{
            _BrokenRules.Remove(propertyName);
        }
    }
}

/// <summary>
/// Reinforces the business rules by adding additional rules to the
/// broken rules collection.
/// </summary>
protected abstract void ValidationRules();

/// <summary>
/// Gets whether the object is valid or not.
/// </summary>
public bool IsValid
{
get
{
        ValidationRules();
return this._BrokenRules.Count == 0;
    }
}

/// /// <summary>
/// If the object has broken business rules, use this property to get access
/// to the different validation messages.
/// </summary>
public virtual string ValidationMessage
{
get
{
if (!IsValid)
{
            StringBuilder sb = new StringBuilder();
foreach (string messages in this._BrokenRules.Values)
{
                sb.AppendLine(messages);
            }

return sb.ToString();
        }

return string.Empty;
    }
}

#endregion

咱們在Post類中重寫這個方法來添加驗證規則：

而後咱們能夠在Controller的Action中很優雅的書寫咱們的代碼來進行業務規則的驗證：

[AcceptVerbs("POST"), ActionName("NewPost")]
public ActionResult SaveNewPost(FormCollection form)
{
    Post post = new Post();
try
    {
        UpdateModel(post, new[] { "Title", "Content", "Slug" });
    }
catch
    {
return View(post);
    }
if (!post.IsValid)
    {
foreach (string key in post.BrokenRules.Keys)
        {
            ViewData.ModelState.AddModelError(key, form[key], post.BrokenRules[key]);
        }
return View(post);
    }
    post.Save();
return ShowMsg(new List<string>() { "發表新隨筆成功" });
}

咱們注意到上面的Action中用到了一個FormCollection 的參數，這個參數系統會自動將Form提交過來的所有表單值(Request.Form)賦給它的。客戶端驗證能夠用jQuery的驗證插件來，這裏就不羅嗦了。

暫時就寫這麼多吧，想到什麼再補充。Enjoy！Post by Q.Lee.lulu。

本文的Blog程序示例代碼： 4mvcBlog_8.rar

物流,配貨,貨運,網站,論壇,交流,信息發佈
網站建設QQ:471226865