解读ASP.NET 5 & MVC6系列(13):TagHelper

移动开发 Android
这种方式,抛去了服务器端代码,利用自定义html属性显得更加有语义,前端人员开起来也很舒服,极大地提高了前端开发人员的效率。

 在新版的MVC6中,微软提供了强大的TagHelper功能,以便让我们摆脱如下的臃肿代码:

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

引入新功能TagHelper以后,我们只需要这样定义就可以了,代码如下:

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

这种方式,抛去了服务器端代码,利用自定义html属性显得更加有语义,前端人员开起来也很舒服,极大地提高了前端开发人员的效率。

在默认的TagHelper实现里,不同的元素支持不同的自定义属性,以实现不同的用途,例如大部分元素都支持asp-for,而a元素则支持asp-controller和asp-action等,input元素***大的,支持各种类型的type以及相关的格式。详细实现,请参考如下章节中的表格内容。

A元素

解读ASP.NET 5 & MVC6系列(13):TagHelper

Form元素

解读ASP.NET 5 & MVC6系列(13):TagHelper

 

Input元素

解读ASP.NET 5 & MVC6系列(13):TagHelper

解读ASP.NET 5 & MVC6系列(13):TagHelper

 

其中关于时间的具体格式如下:

解读ASP.NET 5 & MVC6系列(13):TagHelper

Label元素

解读ASP.NET 5 & MVC6系列(13):TagHelper

textarea元素

解读ASP.NET 5 & MVC6系列(13):TagHelper

span元素

解读ASP.NET 5 & MVC6系列(13):TagHelper

div元素

解读ASP.NET 5 & MVC6系列(13):TagHelper

验证描述类型,只有选择了ValidationSummary.All和ValidationSummary.ModelOnly才能渲染该div元素。

select元素

解读ASP.NET 5 & MVC6系列(13):TagHelper

link元素

解读ASP.NET 5 & MVC6系列(13):TagHelper

link的使用示例如下,比如我们定义如下代码:

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

 

则该段代码表示,默认先加载aspnetcdn.com上的css文件,如果加载失败了,再加载本地网站里的css文件,加载失败的判断条件是:检测carousel-caption样式十分应用上了,即该应用了该样式的元素的display属性是否等于none。运行网站后,这段代码的生成html如下:

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

 

 

 

从中,我们看到,生成的HTML代码在link元素之后多了两个元素,一个是带有class="carousel-caption"属性的meta元素,一个是script脚本标签。其主要原理是如下:

在meta元素上应用定义的carousel-caption样式。

通过JS代码检测该meta元素的display属性是否等于none。

如果不等于none,重新加载本地的备用css文件。

注意,这里的js脚本是利用document.getElementsByTagName("SCRIPT"),获取***一个SCRIPT标签的上一个兄弟元素的形式,来获取meta元素的。

script元素

解读ASP.NET 5 & MVC6系列(13):TagHelper

script标签元素的fallback功能,和link元素记载css文件类型,只不过这里判断的不是class样式,而是检测某个对象是否存在,来判断默认的js文件是否加载成功,示例如下:

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

 

生成后的HTML代码,相对比较简单,示例如下:

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

 

 

多生成了一个script标签元素,然后判断jQuery对象是否存在,如果不存在则表示加载失败,那就再加载本地的备用js文件。

Cache

解读ASP.NET 5 & MVC6系列(13):TagHelper

利用EnvironmentTagHelper来控制不同运行环境的输出结果

在很多情况下,我们想再开发环境使用一套配置信息,在生产环境又是另外一套,这时候就需要使用条件判断语句了,不过在新版的MVC中,使用EnvironmentTagHelper提供的Environment元素标签就可以了,示例如下:

  1. <environment names="Development"> 
  2.     <script src="~/lib/jquery/jquery.js"></script> 
  3.     <script src="~/lib/bootstrap/js/bootstrap.js"></script> 
  4.     <script src="~/lib/hammer.js/hammer.js"></script> 
  5.     <script src="~/lib/bootstrap-touch-carousel/js/bootstrap-touch-carousel.js"></script> 
  6. </environment> 
  7. <environment names="Staging,Production"> 
  8.     <script src="//ajax.aspnetcdn.com/ajax/jquery/jquery-1.10.2.min.js" 
  9.             asp-fallback-src="~/lib/jquery/jquery.min.js" 
  10.             asp-fallback-test="window.jQuery"> 
  11.     </script> 
  12.     <script src="//ajax.aspnetcdn.com/ajax/bootstrap/3.0.0/bootstrap.min.js" 
  13.             asp-fallback-src="~/lib/bootstrap/js/bootstrap.min.js" 
  14.             asp-fallback-test="window.jQuery"> 
  15.     </script> 
  16.     <script src="//ajax.aspnetcdn.com/ajax/hammer.js/2.0.4/hammer.min.js" 
  17.             asp-fallback-src="~/lib/hammer.js/hammer.js" 
  18.             asp-fallback-test="window.Hammer"> 
  19.     </script> 
  20.     <script src="//ajax.aspnetcdn.com/ajax/bootstrap-touch-carousel/0.8.0/js/bootstrap-touch-carousel.js" 
  21.             asp-fallback-src="~/lib/bootstrap-touch-carousel/js/bootstrap-touch-carousel.js" 
  22.             asp-fallback-test="window.Zepto"> 
  23.     </script> 
  24. </environment> 

在上述代码中,我们定于,如果是Development环境就使用本地的js文件,否则(Staging或Production环境)就先加载cdn的文件(只不过还留有备用方案)。

该names里的值判断依据是,查找IHostingEnvironment的EnvironmentName属性,并与其进行比较,然后再进行相应的处理。

自定义TagHelper

MVC所有TagHelper的实现,都继承了Microsoft.AspNet.Razor.Runtime.TagHelpers.ITagHelper接口,所以我们只要实现该接口就可以实现自定义的TagHelper,该接口的定义如下

  1. public interface ITagHelper 
  2.     int Order { get; } 
  3.     Task ProcessAsync(TagHelperContext context, TagHelperOutput output); 
  4. }

不过,我们一般自定义的时候,只需要继承该接口的默认实现TagHelper类,并重载其虚方法Process方法即可,如下是几个示例,我们来详细研究一下。

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

  1. public class ATagHelper : TagHelper 
  2.     [Activate] 
  3.     public IUrlHelper UrlHelper { get; set; } 
  4.  
  5.     public string Controller { get; set; } 
  6.  
  7.     public string Action { get; set; } 
  8.  
  9.     public override void Process(TagHelperContext context, TagHelperOutput output) 
  10.     { 
  11.         if (Controller != null && Action != null
  12.         { 
  13.             var methodParameters = output.Attributes.ToDictionary(attribute => attribute.Key, 
  14.                                                                     attribute => (object)attribute.Value); 
  15.  
  16.             // 删除所有的attributes,因为路由里已经可以自动生成了 
  17.             output.Attributes.Clear(); 
  18.  
  19.             output.Attributes["href"] = UrlHelper.Action(Action, Controller, methodParameters); 
  20.  
  21.             output.PreContent.SetContent("My "); 
  22.         } 
  23.     } 
  24. }

2. 自动识别Text文本中的链接,并提取出来

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

3. 条件判断

定义一个condiction,符合条件才显示该元素,示例如下(只有Model.Approved为true时才显示该元素):

  1. © @Model.CopyrightYear - My ASP.NET Application

实现代码如下:

  1. [TargetElement("div")] 
  2. [TargetElement("style")] 
  3. [TargetElement("p")] 
  4. public class ConditionTagHelper : TagHelper 
  5.     public bool? Condition { get; set; } 
  6.  
  7.     public override void Process(TagHelperContext context, TagHelperOutput output) 
  8.     { 
  9.         // 如果设置了condition,并且该值为false,则不渲染该元素 
  10.         if (Condition.HasValue && !Condition.Value) 
  11.         { 
  12.             output.SuppressOutput(); 
  13.         } 
  14.     } 

4. 自定义元素的TagHelper

如果我们要为自定义元素定义TagHelper,则我们要符合约定规范,示例代码如下:

  1. public class WebsiteInformationTagHelper : TagHelper 
  2.     public WebsiteContext Info { get; set; } 
  3.  
  4.     public override void Process(TagHelperContext context, TagHelperOutput output) 
  5.     { 
  6.         output.TagName = "section"
  7.         output.PostContent.SetContent(string.Format( 
  8.             " 
  9.  
  10. Version: {0
  11. " + Environment.NewLine + 
  12.             " 
  13.  
  14. Copyright Year: {1
  15. " + Environment.NewLine + 
  16.             " 
  17.  
  18. Approved: {2
  19. " + Environment.NewLine + 
  20.             " 
  21.  
  22. Number of tags to show: {3
  23. " + Environment.NewLine, 
  24.             Info.Version.ToString(), 
  25.             Info.CopyrightYear.ToString(), 
  26.             Info.Approved.ToString(), 
  27.             Info.TagsToShow.ToString())); 
  28.         output.SelfClosing = false
  29.     } 
  30. }

则使用的时候,我们需要使用website-information标签,并将info属性赋值一个强类型的值,示例如下:

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

其渲染结果,则是渲染成一个包含4个p元素的section元素。

责任编辑:chenqingxiang 来源: 汤姆大叔的博客
相关推荐

2015-06-17 14:42:04

ASP.NET

2015-06-29 10:00:02

ASP.NETMVC6

2015-06-16 15:01:59

ASP.NET 5

2015-06-17 16:45:28

ASP.NET

2015-06-17 16:01:30

ASP.NET

2015-06-18 14:13:36

ASP.NET

2015-06-18 16:39:17

ASP.NET

2015-06-18 17:04:22

ASP.NET

2015-06-17 16:04:36

ASP.NET

2015-06-17 17:01:48

ASP.NET

2015-06-17 10:16:30

ASP.NET

2015-06-18 17:37:19

ASP.NET

2015-06-17 14:16:50

ASP.NET

2015-06-17 14:09:36

ASP.NET

2015-06-17 14:18:50

ASP.NET

2015-06-18 17:34:25

ASP.NET

2015-06-18 14:25:56

ASP.NET

2014-08-26 09:22:40

ASP.NET MVCRouting

2015-06-30 14:58:20

技术周刊

2009-07-24 13:20:44

MVC框架ASP.NET
点赞
收藏

51CTO技术栈公众号