在新版的MVC6中,微软提供了强大的TagHelper功能,以便让我们摆脱如下的臃肿代码:
引入新功能TagHelper以后,我们只需要这样定义就可以了,代码如下:
这种方式,抛去了服务器端代码,利用自定义html属性显得更加有语义,前端人员开起来也很舒服,极大地提高了前端开发人员的效率。
在默认的TagHelper实现里,不同的元素支持不同的自定义属性,以实现不同的用途,例如大部分元素都支持<code>asp-for</code>,而a元素则支持<code>asp-controller</code>和<code>asp-action</code>等,input元素最强大的,支持各种类型的type以及相关的格式。详细实现,请参考如下章节中的表格内容。
属性
描述
asp-controller
Controller的名称
asp-action
Action的名称
asp-host
网站的Host
asp-fragment
URL的fragment名称
asp-protocol
网站协议(http或https)
asp-route
Route名称
asp-route-
href
默认属性,如果href有值,则其它属性都不能设置任何值。
asp-anti-forgery
action
默认属性,如果action有值,则其它属性都不能设置任何值。
asp-for
模型字段的名称
asp-format
设置Type格式,具体如下:
格式
标准类型
HiddenInput
hidden
Password
password
Text
text
PhoneNumber
tel
Url
url
EmailAddress
Date
date
DateTime
datetime
DateTime-local
datetime-local
Time
time
Byte/SByte/Int16/UInt16/Int32/UInt32/Int64/UInt64/Single/Double
number
Boolean
checkbox
Decimal
String
IFormFile
file
IEnumerable`IFormFile
其中关于时间的具体格式如下:
<code>{0:yyyy-MM-dd}</code>
<code>{0:yyyy-MM-ddTHH:mm:ss.fffK}</code>
<code>{0:yyyy-MM-ddTHH:mm:ss.fff}</code>
<code>{0:HH:mm:ss.fff}</code>
asp-validation-for
asp-validation-aummary
ValidationSummary枚举值:
ValidationSummary.AllValidationSummary.ModelOnly
ValidationSummary.None。
验证描述类型,只有选择了ValidationSummary.All和ValidationSummary.ModelOnly才能渲染该div元素。
模型字段名称
asp-items
asp-href-include
asp-href-exclude
asp-fallback-href
默认href加载失败时的备用地址
asp-fallback-href-include
asp-fallback-href-exclude
asp-fallback-test-class
判断加载失败时用到的class样式
asp-fallback-test-property
判断加载失败时用到的class样式中的属性
asp-fallback-test-value
判断加载失败时用到的class样式中的属性对应的值
asp-file-version
默认加载的css文件地址。
link的使用示例如下,比如我们定义如下代码:
则该段代码表示,默认先加载aspnetcdn.com上的css文件,如果加载失败了,再加载本地网站里的css文件,加载失败的判断条件是:检测<code>carousel-caption</code>样式十分应用上了,即该应用了该样式的元素的<code>display</code>属性是否等于<code>none</code>。运行网站后,这段代码的生成html如下:
从中,我们看到,生成的HTML代码在link元素之后多了两个元素,一个是带有<code>class="carousel-caption"</code>属性的meta元素,一个是<code>script</code>脚本标签。其主要原理是如下:
在meta元素上应用定义的<code>carousel-caption</code>样式。
通过JS代码检测该meta元素的<code>display</code>属性是否等于<code>none</code>。
如果不等于<code>none</code>,重新加载本地的备用css文件。
注意,这里的js脚本是利用<code>document.getElementsByTagName("SCRIPT")</code>,获取最后一个<code>SCRIPT</code>标签的上一个兄弟元素的形式,来获取<code>meta</code>元素的。
asp-src-include
asp-src-exclude
asp-fallback-src
备用js文件地址
asp-fallback-src-include
asp-fallback-src-exclude
asp-fallback-test
判断默认js文件是否加载成功用到的对象
src
默认的js文件地址。
<code>script</code>标签元素的fallback功能,和link元素记载css文件类型,只不过这里判断的不是class样式,而是检测某个对象是否存在,来判断默认的js文件是否加载成功,示例如下:
生成后的HTML代码,相对比较简单,示例如下:
多生成了一个<code>script</code>标签元素,然后判断jQuery对象是否存在,如果不存在则表示加载失败,那就再加载本地的备用js文件。
vary-by
vary-by-header
vary-by-query
vary-by-route
vary-by-cookie
vary-by-user
expires-on
expires-after
expires-sliding
priority
enabled
.
在很多情况下,我们想再开发环境使用一套配置信息,在生产环境又是另外一套,这时候就需要使用条件判断语句了,不过在新版的MVC中,使用EnvironmentTagHelper提供的Environment元素标签就可以了,示例如下:
在上述代码中,我们定于,如果是Development环境就使用本地的js文件,否则(Staging或Production环境)就先加载cdn的文件(只不过还留有备用方案)。
该names里的值判断依据是,查找<code>IHostingEnvironment</code>的<code>EnvironmentName</code>属性,并与其进行比较,然后再进行相应的处理。
MVC所有TagHelper的实现,都继承了<code>Microsoft.AspNet.Razor.Runtime.TagHelpers.ITagHelper</code>接口,所以我们只要实现该接口就可以实现自定义的TagHelper,该接口的定义如下:
不过,我们一般自定义的时候,只需要继承该接口的默认实现<code>TagHelper</code>类,并重载其虚方法<code>Process</code>方法即可,如下是几个示例,我们来详细研究一下。
定义一个condiction,符合条件才显示该元素,示例如下(只有Model.Approved为true时才显示该元素):
实现代码如下:
如果我们要为自定义元素定义TagHelper,则我们要符合约定规范,示例代码如下:
则使用的时候,我们需要使用<code>website-information</code>标签,并将<code>info</code>属性赋值一个强类型的值,示例如下:
其渲染结果,则是渲染成一个包含4个<code>p</code>元素的<code>section</code>元素。