天天看點

asp.net core進階應用:TagHelper+Form

  上一篇部落格我講解了TagHelper的基本用法和自定義标簽的生成,那麼我就趁熱打鐵,和大家分享一下TagHelper的進階用法~~,大家也可以在我的部落格下随意留言。

  對于初步接觸asp.net core的騷年可以看看我對TagHelper的了解和看法:

  《asp.net core新特性(1):TagHelper》

  之後,我也會繼續撰寫博文,繼續分享asp.net core的一些新特性,比如DI,ViewComponent以及bower等asp.net mvc中沒有的新東西。

  ok,咱們就開始吧~~

  在之前我對TagHelper的分享當中提及了,TagHelper能夠去替代原來在@Html幫助類中的一些功能,比如form,a等标簽,而且寫在html代碼中更加的舒服,符合html的文法。

<!--标簽助手版form-->
<form asp-controller="Home" asp-action="Index" class="form-horizontal" method="post">

</form>
<!--Html幫助類版form-->
@using (Html.BeginForm("Index", "Home", FormMethod.Post,, new { Class = "form-horizontal" }))
{

}      

  那麼,在Html幫助類中最有用的Model與Tag的轉換,自動表單的生成,微軟是否也給出了解決方案呢?答案是肯定的。Microsoft還專門分出了單獨的說明頁面來講述TagHelper的自動表單生成,英文功底好的同學可以直接檢視MS的官方文檔《Introduction to using tag helpers in forms in ASP.NET Core》。

  文檔中提及了對于表單控件,我們可以直接在asp-for屬性中直接填寫Model中的屬性名,即可自動生成對應的控件類型和填入預設值。

  ok,我們來嘗試一下。

  (1)建立ViewModel類

public class SignUpViewModel
    {
        [Required]
        [Display(Name ="使用者名")]
        [MaxLength(30,ErrorMessage = "使用者名不能超過30")]
        public string UserName { get; set; }

        [Required]
        [DataType(DataType.Password)]
        [RegularExpression(@"((?=.*\d)(?=.*\D)|(?=.*[a-zA-Z])(?=.*[^a-zA-Z]))^$",ErrorMessage ="密碼至少包含兩種以上字元")]
        [Display(Name ="密碼")]
        public string Password { get; set; }

        [DataType(DataType.MultilineText)]
        public string Description { get; set; }
    }      

  對于寫過asp.net mvc的開發者肯定不會陌生這種驗證方式~~

  (2)編寫TagHelper标簽

  為了與Html區分,我寫了兩者的比較版本

<form asp-controller="Home" asp-action="SignUp" method="post" class="form-horizontal">
    <div class="form-group">
        <label asp-for="UserName"></label>
        <input asp-for="UserName" />
        <span asp-validation-for="UserName"></span>
    </div>
    <div class="form-group">
        @Html.LabelFor(m=>m.Password)
        @Html.PasswordFor(m=>m.Password)
        @Html.ValidationMessageFor(m=>m.Password)
    </div>
    <div class="form-group">
        <label asp-for="Description"></label>
        <textarea asp-for="Description"></textarea>
        <span asp-validation-for="Description"></span>
    </div>
    <div class="form-group">
        <input type="submit" value="送出" />
        <input type="reset" value="重置" />
    </div>
</form>      

  (3)驗證表單

public IActionResult SignUp(SignUpViewModel model)
        {
            if (ModelState.IsValid)
            {
                return RedirectToAction("Index");
            }
            else
            {
                return RedirectToAction("Index",model);
            }
        }      

  (4)結果

  

asp.net core進階應用:TagHelper+Form

  ok,如果覺得這樣就結束了,那麼就不算TagHelper進階應用,那隻能充其量在翻譯MS的文檔罷了。

  那麼,重點來了,既然MS能讓我們建立自定義TagHelper,那我為什麼不能在TagHelper當中使用Model的值呢?于是我開始在asp.net core開源github項目中尋找,終于是找到了ImputTagHelper的源碼。

  在源碼中,由三個對象一起來完成标簽的生成

protected IHtmlGenerator Generator { get; }

        [HtmlAttributeNotBound]
        [ViewContext]
        public ViewContext ViewContext { get; set; }

        /// <summary>
        /// An expression to be evaluated against the current model.
        /// </summary>
        [HtmlAttributeName(ForAttributeName)]
        public ModelExpression For { get; set; }      

  三個對象均是通過依賴注入的方式來實作對象的生成。

  (1)其中Generator為發生器,負責生成各種類型的标簽

  (2)ViewContext為視圖上下文,擷取視圖上下文相關資訊

  (3)For擷取到目前Model的相關資訊,包括Required等關鍵資訊

  有了這三個标簽,我們也可以在自定義的标簽助手中擷取你想要的Model資訊,比如我可以向form中填入Model資訊,讓标簽助手自動生成form表單中的所有内容;也可以向ul标簽中填入樹資訊,讓其自動生成樹清單等等

  如下就是我編寫的自動生成表單

//自定義标簽助手名為bg-form
    [HtmlTargetElement("bg-form")]
    public class FormTagHelper : TagHelper
    {
        [ViewContext]
        [HtmlAttributeNotBound]
        public ViewContext ViewContext { get; set; }

        [HtmlAttributeName("asp-for")]
        public ModelExpression For { get; set; }

        protected IHtmlGenerator Generator { get; }

        public FormTagHelper(IHtmlGenerator generator)
        {
            Generator = generator;
        }

        [HtmlAttributeName("asp-controller")]
        public string Controller { get; set; }

        [HtmlAttributeName("asp-action")]
        public string Action { get; set; }

        //異步方法
        public override async Task ProcessAsync(TagHelperContext context, TagHelperOutput output)
        {
            output.TagName = "form";
            if (!string.IsNullOrWhiteSpace(Controller))
            {
                output.Attributes.Add("action", "/" + Controller + "/" + Action);
            }

            output.Attributes.Add("class", "form-horizontal");

            //擷取子屬性
            var props = For.ModelExplorer.Properties;
            foreach (var prop in props)
            {
                //生成表單
                var div = new TagBuilder("div");
                div.AddCssClass("form-group");
                var label = Generator.GenerateLabel(ViewContext, prop, null, prop.Metadata.DisplayName, null);
                var input = Generator.GenerateTextBox(ViewContext, prop, prop.Metadata.PropertyName, null, null, null);
                var span = Generator.GenerateValidationMessage(ViewContext, prop, prop.Metadata.PropertyName, null, ViewContext.ValidationMessageElement, null);
                div.InnerHtml.AppendHtml(label);
                div.InnerHtml.AppendHtml(input);
                div.InnerHtml.AppendHtml(span);
                output.Content.AppendHtml(div);
            }
            //添加按鈕
            var btn = new TagBuilder("div");
            btn.AddCssClass("form-group");
            var submit = new TagBuilder("input");
            submit.Attributes.Add("type", "submit");
            submit.Attributes.Add("value", "送出");
            var reset = new TagBuilder("input");
            reset.Attributes.Add("type", "reset");
            reset.Attributes.Add("value", "重置");
            btn.InnerHtml.AppendHtml(submit);
            btn.InnerHtml.AppendHtml(reset);
            output.Content.AppendHtml(btn);
            //将原有的内容添加到标簽内部
            output.Content.AppendHtml(await output.GetChildContentAsync());

        }
    }      

  隻要在html加入

<bg-form asp-controller="Home" asp-action="SignUp" asp-for="@Model">

</bg-form>      

即可自動生成表單

asp.net core進階應用:TagHelper+Form

  Over,今天關于TagHelper就分享到這~~

繼續閱讀