Co to jest MvcHtmlString i kiedy powinienem go używać?

Dokumentacja dla MvcHtmlStringnie jest strasznie oświecania:

Reprezentuje ciąg zakodowany w formacie HTML, którego nie należy ponownie kodować.

Nie jest dla mnie jasne, jakie są tego konsekwencje. Wygląda na to, że niektóre metody pomocnicze HTML zwracają an MvcHtmlString, ale kilka przykładów, które widziałem online z niestandardowymi pomocnikami, zwraca zwykły ciąg.

Pytania:

Co to jest MvcHtmlString?

Kiedy należy wybrać MvcHtmlStringnad stringi vice versa? Czemu?

ASP.NET 4 wprowadza nową składnię samorodków kodu <%: %>. Zasadniczo <%: foo %>przekłada się na <%= HttpUtility.HtmlEncode(foo) %>. Zespół stara się zachęcić programistów do używania <%: %>zamiast <%= %>tam, gdzie to możliwe, aby zapobiec XSS.

Jednak wprowadza to problem polegający na tym, że jeśli model użytkowy już koduje wynik, <%: %>składnia go ponownie zakoduje . Zostało to rozwiązane poprzez wprowadzenie interfejsu IHtmlString (nowego w .NET 4). Jeśli foo () w <%: foo() %>zwróci IHtmlString, <%: %>składnia go nie zakoduje ponownie.

Pomocnicy MVC 2 zwracają MvcHtmlString, który w ASP.NET 4 implementuje interfejs IHtmlString. Dlatego, gdy programiści używają <%: Html.*() %>w ASP.NET 4, wynik nie będzie podwójnie kodowany.

Edytować:

Bezpośrednią zaletą tej nowej składni jest to, że Twoje widoki są nieco bardziej przejrzyste. Na przykład możesz pisać <%: ViewData["anything"] %>zamiast <%= Html.Encode(ViewData["anything"]) %>.

To jest późna odpowiedź, ale jeśli ktoś czytający to pytanie używa brzytwy, powinieneś pamiętać, że brzytwa koduje wszystko domyślnie, ale używając MvcHtmlStringpomocników HTML możesz powiedzieć brzytwie, że nie musi go kodować .

Jeśli chcesz, aby brzytwy nie kodowały ciągu, użyj

@Html.Raw("<span>hi</span>")

Dekompilacja Raw () pokazuje, że owija ciąg znaków w HtmlString

public IHtmlString Raw(string value) {
    return new HtmlString(value); 
}

„ HtmlString istnieje tylko w ASP.NET 4.

MvcHtmlString był podkładką kompatybilności dodaną do MVC 2, aby obsługiwać zarówno .NET 3.5, jak i .NET 4. Teraz, gdy MVC 3 to tylko .NET 4, jest to dość trywialna podklasa HtmlString przypuszczalnie dla MVC 2-> 3 dla kompatybilności źródła. „ źródło

Dobrym praktycznym zastosowaniem tego jest, jeśli chcesz tworzyć własne HtmlHelperrozszerzenia. Na przykład nienawidzę próbować zapamiętać <link>składni znacznika, dlatego stworzyłem własną metodę rozszerzenia, aby utworzyć <link>znacznik:

<Extension()> _
Public Function CssBlock(ByVal html As HtmlHelper, ByVal src As String, ByVal Optional ByVal htmlAttributes As Object = Nothing) As MvcHtmlString
    Dim tag = New TagBuilder("link")
    tag.MergeAttribute("type", "text/css")
    tag.MergeAttribute("rel", "stylesheet")
    tag.MergeAttribute("href", src)
    tag.MergeAttributes(New RouteValueDictionary(htmlAttributes))
    Dim result = tag.ToString(TagRenderMode.Normal)
    Return MvcHtmlString.Create(result)
End Function

Mógłbym wrócić Stringz tej metody, ale gdybym miał, to by się zepsuło:

<%: Html.CssBlock(Url.Content("~/sytles/mysite.css")) %>

Za MvcHtmlStringpomocą jednego <%: ... %>lub <%= ... %>obu będzie działać poprawnie.

Przydałbyś się, MvcHtmlStringjeśli chcesz przekazać surowy kod HTML do metody pomocniczej MVC i nie chcesz, aby metoda pomocnicza kodowała HTML.