ASP.NET中TagHelper如何使用

這篇文章給大家介紹ASP.NET中TagHelper如何使用，內容非常詳細，感興趣的小伙伴們可以參考借鑒，希望對大家能有所幫助。

在新版的MVC6中，微軟提供了強大的TagHelper功能，以便讓我們擺脫如下的臃腫代碼：

@Html.LabelFor(model => model.FullName)
@Html.EditFor(model => model.FullName)
@Html.ValidationMessageFor(model => model.FullName)

引入新功能TagHelper以后，我們只需要這樣定義就可以了，代碼如下：

@addTagHelper "*, Microsoft.AspNet.Mvc.TagHelpers"  /* 這里需要首先引用TagHelper所在的命名空間 */  <label asp-for="FullName" class="control-label col-md-2"></label> <div class="col-md-10">     <input asp-for="FullName" class="form-control" />     <span asp-validation-for="FullName"></span> </div>

這種方式，拋去了服務器端代碼，利用自定義html屬性顯得更加有語義，前端人員開起來也很舒服，極大地提高了前端開發人員的效率。

在默認的TagHelper實現里，不同的元素支持不同的自定義屬性，以實現不同的用途，例如大部分元素都支持asp-for，而a元素則支持asp-controller和asp-action等，input元素***大的，支持各種類型的type以及相關的格式。詳細實現，請參考如下章節中的表格內容。

A元素

Form元素

Input元素

其中關于時間的具體格式如下：

Label元素

textarea元素

span元素

div元素

驗證描述類型，只有選擇了ValidationSummary.All和ValidationSummary.ModelOnly才能渲染該div元素。

select元素

link元素

link的使用示例如下，比如我們定義如下代碼：

<link rel="stylesheet"  href="//ajax.aspnetcdn.com/ajax/bootstrap-touch-carousel/0.8.0/css/bootstrap-touch-carousel.css" asp-fallback-href="~/lib/bootstrap-touch-carousel/css/bootstrap-touch-carousel.css" asp-fallback-test-class="carousel-caption"  asp-fallback-test-property="display"  asp-fallback-test-value="none" />

則該段代碼表示，默認先加載aspnetcdn.com上的css文件，如果加載失敗了，再加載本地網站里的css文件，加載失敗的判斷條件是：檢測carousel-caption樣式十分應用上了，即該應用了該樣式的元素的display屬性是否等于none。運行網站后，這段代碼的生成html如下：

<link rel="stylesheet" href="//ajax.aspnetcdn.com/ajax/bootstrap-touch-carousel/0.8.0/css/bootstrap-touch-carousel.css" /> <meta name="x-stylesheet-fallback-test" class="carousel-caption" /> <script>     !function (a, b, c) {         var d, e = document,             f = e.getElementsByTagName("SCRIPT"),             g = f[f.length - 1].previousElementSibling,             h = e.defaultView && e.defaultView.getComputedStyle ? e.defaultView.getComputedStyle(g) : g.currentStyle;          if (h && h[a] !== b) {             for (d = 0; d < c.length; d++) {                 e.write('<link rel="stylesheet" href="' + c[d] + '"/>')             }         }     }("display", "none", ["\/lib\/bootstrap-touch-carousel\/css\/bootstrap-touch-carousel.css"]); </script>

從中，我們看到，生成的HTML代碼在link元素之后多了兩個元素，一個是帶有class="carousel-caption"屬性的meta元素，一個是script腳本標簽。其主要原理是如下：

在meta元素上應用定義的carousel-caption樣式。

通過JS代碼檢測該meta元素的display屬性是否等于none。

如果不等于none，重新加載本地的備用css文件。

注意，這里的js腳本是利用document.getElementsByTagName("SCRIPT")，獲取***一個SCRIPT標簽的上一個兄弟元素的形式，來獲取meta元素的。

script元素

script標簽元素的fallback功能，和link元素記載css文件類型，只不過這里判斷的不是class樣式，而是檢測某個對象是否存在，來判斷默認的js文件是否加載成功，示例如下：

<script src="//ajax.aspnetcdn.com/ajax/jquery/jquery-1.10.2.min.js"     asp-fallback-src="~/lib/jquery/jquery.min.js"     asp-fallback-test="window.jQuery"> </script>

生成后的HTML代碼，相對比較簡單，示例如下：

<script src="//ajax.aspnetcdn.com/ajax/jquery/jquery-1.10.2.min.js"> </script> <script>(window.jQuery||document.write("<script src=\"\/lib\/jquery\/jquery.min.js\"><\/script>"));</script>

多生成了一個script標簽元素，然后判斷jQuery對象是否存在，如果不存在則表示加載失敗，那就再加載本地的備用js文件。

Cache

利用EnvironmentTagHelper來控制不同運行環境的輸出結果

在很多情況下，我們想再開發環境使用一套配置信息，在生產環境又是另外一套，這時候就需要使用條件判斷語句了，不過在新版的MVC中，使用EnvironmentTagHelper提供的Environment元素標簽就可以了，示例如下：

<environment names="Development">     <script src="~/lib/jquery/jquery.js"></script>     <script src="~/lib/bootstrap/js/bootstrap.js"></script>     <script src="~/lib/hammer.js/hammer.js"></script>     <script src="~/lib/bootstrap-touch-carousel/js/bootstrap-touch-carousel.js"></script> </environment> <environment names="Staging,Production">     <script src="//ajax.aspnetcdn.com/ajax/jquery/jquery-1.10.2.min.js"             asp-fallback-src="~/lib/jquery/jquery.min.js"             asp-fallback-test="window.jQuery">     </script>     <script src="//ajax.aspnetcdn.com/ajax/bootstrap/3.0.0/bootstrap.min.js"             asp-fallback-src="~/lib/bootstrap/js/bootstrap.min.js"             asp-fallback-test="window.jQuery">     </script>     <script src="//ajax.aspnetcdn.com/ajax/hammer.js/2.0.4/hammer.min.js"             asp-fallback-src="~/lib/hammer.js/hammer.js"             asp-fallback-test="window.Hammer">     </script>     <script src="//ajax.aspnetcdn.com/ajax/bootstrap-touch-carousel/0.8.0/js/bootstrap-touch-carousel.js"             asp-fallback-src="~/lib/bootstrap-touch-carousel/js/bootstrap-touch-carousel.js"             asp-fallback-test="window.Zepto">     </script> </environment>

在上述代碼中，我們定于，如果是Development環境就使用本地的js文件，否則(Staging或Production環境)就先加載cdn的文件(只不過還留有備用方案)。

該names里的值判斷依據是，查找IHostingEnvironment的EnvironmentName屬性，并與其進行比較，然后再進行相應的處理。

自定義TagHelper

MVC所有TagHelper的實現，都繼承了Microsoft.AspNet.Razor.Runtime.TagHelpers.ITagHelper接口，所以我們只要實現該接口就可以實現自定義的TagHelper，該接口的定義如下

public interface ITagHelper 
{ 
    int Order { get; } 
    Task ProcessAsync(TagHelperContext context, TagHelperOutput output); 
} 

不過，我們一般自定義的時候，只需要繼承該接口的默認實現TagHelper類，并重載其虛方法Process方法即可，如下是幾個示例，我們來詳細研究一下。

1. 在a元素上直接支持controller和action屬性

public class ATagHelper : TagHelper 
{ 
    [Activate] 
    public IUrlHelper UrlHelper { get; set; } 
 
    public string Controller { get; set; } 
 
    public string Action { get; set; } 
 
    public override void Process(TagHelperContext context, TagHelperOutput output) 
    { 
        if (Controller != null && Action != null) 
        { 
            var methodParameters = output.Attributes.ToDictionary(attribute => attribute.Key, 
                                                                    attribute => (object)attribute.Value); 
 
            // 刪除所有的attributes，因為路由里已經可以自動生成了 
            output.Attributes.Clear(); 
 
            output.Attributes["href"] = UrlHelper.Action(Action, Controller, methodParameters); 
 
            output.PreContent.SetContent("My "); 
        } 
    } 
} 

2. 自動識別Text文本中的鏈接，并提取出來

[TargetElement("p")] 
public class AutoLinkerTagHelper : TagHelper 
{ 
    public override async Task ProcessAsync(TagHelperContext context, TagHelperOutput output) 
    { 
        var childContent = await context.GetChildContentAsync(); 
 
        // Find Urls in the content and replace them with their anchor tag equivalent. 
        output.Content.SetContent(Regex.Replace( 
            childContent.GetContent(), 
            @"\b(?:https?://|www\.)(\S+)\b", 
            "$0")); 
    } 
} 

3. 條件判斷

定義一個condiction，符合條件才顯示該元素，示例如下(只有Model.Approved為true時才顯示該元素)：

© @Model.CopyrightYear - My ASP.NET Application 

實現代碼如下：

[TargetElement("div")] [TargetElement("style")] [TargetElement("p")] public class ConditionTagHelper : TagHelper {     public bool? Condition { get; set; }      public override void Process(TagHelperContext context, TagHelperOutput output)     {         // 如果設置了condition，并且該值為false，則不渲染該元素         if (Condition.HasValue && !Condition.Value)         {             output.SuppressOutput();         }     } }

4. 自定義元素的TagHelper

如果我們要為自定義元素定義TagHelper，則我們要符合約定規范，示例代碼如下：

public class WebsiteInformationTagHelper : TagHelper 
{ 
    public WebsiteContext Info { get; set; } 
 
    public override void Process(TagHelperContext context, TagHelperOutput output) 
    { 
        output.TagName = "section"; 
        output.PostContent.SetContent(string.Format( 
            " 
 
Version: {0} 
" + Environment.NewLine + 
            " 
 
Copyright Year: {1} 
" + Environment.NewLine + 
            " 
 
Approved: {2} 
" + Environment.NewLine + 
            " 
 
Number of tags to show: {3} 
" + Environment.NewLine, 
            Info.Version.ToString(), 
            Info.CopyrightYear.ToString(), 
            Info.Approved.ToString(), 
            Info.TagsToShow.ToString())); 
        output.SelfClosing = false; 
    } 
} 

則使用的時候，我們需要使用website-information標簽，并將info屬性賦值一個強類型的值，示例如下：

<website-information info="new WebsiteContext {                                 Version = new Version(1, 1),                                 CopyrightYear = 1990,                                 Approved = true,                                 TagsToShow = 30 }"/>

其渲染結果，則是渲染成一個包含4個p元素的section元素。

關于ASP.NET中TagHelper如何使用就分享到這里了，希望以上內容可以對大家有一定的幫助，可以學到更多知識。如果覺得文章不錯，可以把它分享出去讓更多的人看到。