asp.net 5 Beta5 對TagHelper帶來的變化

最近做的TagHelper項目要從原來的ASP.NET 5 Beta 4升級到Beta 5，特地整理了升級后的變化：

1. 新增ImageTagHelper

   <img asp-file-version="true" src="~/images/my_cool_image.png" />　

2. Tag Helper支持綁定字典屬性現在你可以在TagHelpers中綁定服務器端的attributes到字典屬性。比如，AnchorTagHelper利用名字格式為asp-route-*的attributes來設置路由值。

   <a asp-action="Edit" asp-route-id="@index">Edit</a>

   在該類中定義如下：

   public class AnchorTagHelper : TagHelper{    PRivate const string RouteValuesDictionaryName = "asp-all-route-data";    private const string RouteValuesPrefix = "asp-route-";    /// <summary>    /// Additional parameters for the route.    /// </summary>    [HtmlAttributeName(RouteValuesDictionaryName, DictionaryAttributePrefix = RouteValuesPrefix)]    public IDictionary<string, string> RouteValues { get; set; } =            new Dictionary<string, string>(StringComparer.OrdinalIgnoreCase);    ...        }

   這里只列出與該Dictionary屬性相關的定義，主要是在該屬性頭上添加HtmlAttributeName并設置其DictionaryAttributePrefix?！　?/p>

3. Tag Helper支持基于服務端Attributes設置的條件綁定，并支持通配符*。你可以利用TargetElementAttribute中Attributes屬性來指定當前TagHelper應用到擁有某些attributes的tag上。比如AnchorTagHelper類的定義如下：

   [TargetElement("a", Attributes = ActionAttributeName)][TargetElement("a", Attributes = ControllerAttributeName)][TargetElement("a", Attributes = FragmentAttributeName)][TargetElement("a", Attributes = HostAttributeName)][TargetElement("a", Attributes = ProtocolAttributeName)][TargetElement("a", Attributes = RouteAttributeName)][TargetElement("a", Attributes = RouteValuesDictionaryName)][TargetElement("a", Attributes = RouteValuesPrefix + "*")]public class AnchorTagHelper : TagHelper{    private const string ActionAttributeName = "asp-action";    private const string ControllerAttributeName = "asp-controller";    private const string FragmentAttributeName = "asp-fragment";    private const string HostAttributeName = "asp-host";    private const string ProtocolAttributeName = "asp-protocol";    private const string RouteAttributeName = "asp-route";    private const string RouteValuesDictionaryName = "asp-all-route-data";    private const string RouteValuesPrefix = "asp-route-";    private const string Href = "href";     ...}

   從上面可以看出，該TagHelper會應用到A tag上，并且這個tag上需要有asp-action, asp-controller, asp-fragment, asp-host, asp-protocol, asp-route, asp-all-route-data和asp-route-*這些attributes中一個或一個以上，否則該tag就會綁定到該TagHelper。在最后一個條件綁定中，使用了通配符*，這也是Beta5上支持的。比如　　

   <a href="http://www.49028c.com/liontone/">上善若水</a>

   就不會被應用上AnchorTagHelper。

4. 移除Activate attribute。以前：

   public class MyTagHelper : TagHelper{    [HtmlAttributeNotBound]    [Activate]    public IHtmlEncoder Encoder { get; set; }    [HtmlAttributeNotBound]    [Activate]    public ViewContext ViewContext { get; set; }}

   現在：

   public class MyTagHelper : TagHelper{    public MyTagHelper(IHtmlEncoder encoder)    {        Encoder = encoder;    }    public IHtmlEncoder Encoder { get; }    [HtmlAttributeNotBound]    [ViewContext]    public ViewContext ViewContext { get; set; }}

5. 不允許attribute名為"data-*"。在beta5中attribute名不能以"data-"開頭，不然在解析taghelper時就會有錯誤拋出。
6. 新增HtmlAttributeNotBoundAttribute，可以類中公開的屬性不轉化為TagHelper的Attribute。詳細介紹見這里。比如

   public class MyTagHelper : TagHelper{    public MyTagHelper(IHtmlEncoder encoder)    {        Encoder = encoder;    }    public IHtmlEncoder Encoder { get; }    [HtmlAttributeNotBound]    [ViewContext]    public ViewContext ViewContext { get; set; }}

   按照以前文章介紹，ViewContext對應TagHelper的Attribute是view-context，但其實我們不希望它成為Attribute，這時只需要加上HtmlAttributeNotBoundAttribute即可，在Visual Studio 2015中也不會有該Attribute的智能提示了。　　

7. 程序集中內嵌資源key已經回歸到asp.net 5之前的樣子即namespace + "." + 文件名在beta4中key是與文件相對路徑基本一致，這一點比較另類，也許微軟自己也發現了這個問題，到了beta5又回歸到以前那樣，key的生成是文件的namespace + "." + 文件名。
8. TagHelperOutput新增了2個新的屬性：PreElement和PostElement。不同于PreContent和PostContent，利用這兩個屬性可以輸出內容到當前Tag的前面或后面，大家可以查看Github上的相應的issue來了解更多信息。比如在類中重寫方法：

   public void Process(TagHelperContext context, TagHelperOutput output){    var nl = Environment.NewLine;    var br = "<br />" + nl;    output.PreElement.Append("This will appear before source element" + br);    output.PreContent.Append(nl + "This will appear before source content" + br);    output.PostContent.Append(br + "This will appear after source content" + nl);    output.PostElement.Append(br + "This will appear after source element");}

   在View上TagHelper：

   <my-tag-helper>    Content in source</my-tag-helper>

   最后進過解析后生成到頁面的內容是：

   This will appear before source element<br /><my-tag-helper>This will appear before source content<br />    Content in source<br />This will appear after source content</my-tag-helper><br />This will appear after source element　

9. project.json中preprocess默認路徑是compiler/preprocess/**/*.cs，這里文件夾的名稱是小寫，如果程序中是其中文件夾名大寫的話，里面的代碼不會被執行。原來我項目中對應的文件夾都是大寫Compiler/Preprocess，在做beta4升級到beta5支持時，發現里面的代碼沒有被執行，后來試著在project.json中直接設置preprocess為Compiler/Preprocess/**/*.cs，這樣是可以的。但是想著既然文檔中說默認路徑就是這個地址，為什么還要設置呢？就在百思不得其解的時候，突然發現它上面寫的都是小寫，于是試著把文件夾改成小寫，果然可以。真是大坑啊，如果文件夾大小寫敏感，那一開始就要嚴格要求。還不知道正式版發布后會是什么情況，拭目以待吧。
10. Beta5版的Core的庫越來越完善，新增了Hashtable, Arraylist類之前beta4版本Core庫中是沒有這兩個類的定義，項目恰好又用到了，那只好自己添加了類，現在升級到beta5后，又有了，于是就將原來的刪除掉了。隨著正式版的臨近，core庫也會變得越來越完善。
11. 有些庫名稱，類的namespace發生變化，比如：
    • 命名空間從Microsoft.Framework.ConfigurationModel 變成Microsoft.Framework.Configuration
    • Microsoft.Framework.ConfigurationModel.Json庫更名為Microsoft.Framework.Configuration.Json
    • 移除命名空間Microsoft.AspNet.Http.Core
    • 移除EntityFramewor庫，使用EntityFramework.SqlServer庫來代替。
    • 接口ICompileModule中定義的方法參數類型發生變化：類BeforeCompileContext代替接口IBeforeCompileContext，類AfterCompileContext代替接口IAfterCompileContext。還有其他的一些變化，這里也就沒有一一列出來，大家在實際升級過程中根據自己項目情況做相應的修改。
12. 發現了Beta5的一些已知問題，比如：在render section中如果使用AnchorTagHelper，在運行的時候就會出錯，對應的issue報在這里，這時候我不得不使用AnchorTagHelper，用html element代替它，據說在beta6中已經修正了。

　　上面是我在項目升級過程中遇到的問題，其實還有很多變化，需要大家根據自己項目情況來發現，具體beta5詳細變化見這里。