Was ist ein MvcHtmlString und wann sollte ich ihn verwenden?

Die Dokumentation für MvcHtmlStringist nicht besonders aufschlussreich:

Stellt eine HTML-codierte Zeichenfolge dar, die nicht erneut codiert werden sollte.

Mir ist nicht klar, was genau die Auswirkungen davon sind. Es scheint, dass einige HTML-Hilfsmethoden eine zurückgebenMvcHtmlString , aber einige Beispiele, die ich online von benutzerdefinierten Helfern gesehen habe, geben nur eine reguläre Zeichenfolge zurück.

Fragen:

Was ist ein MvcHtmlString ?

Wann soll ich wählen MvcHtmlStringüber , stringund umgekehrt? Warum?

ASP.NET 4 führt eine neue Code-Nugget-Syntax ein <%: %>. Im Wesentlichen <%: foo %>übersetzt zu <%= HttpUtility.HtmlEncode(foo) %>. Das Team versucht, Entwickler dazu zu bringen, XSS zu verwenden, <%: %>anstatt es <%= %>wo immer möglich zu verhindern.

Dies führt jedoch zu dem Problem, dass wenn ein Code-Nugget sein Ergebnis bereits codiert, die <%: %>Syntax es neu codiert . Dies wird durch die Einführung der IHtmlString-Schnittstelle (neu in .NET 4) gelöst. Wenn foo () in <%: foo() %>einen IHtmlString zurückgibt, wird er von der <%: %>Syntax nicht neu codiert.

Die Helfer von MVC 2 geben MvcHtmlString zurück, das unter ASP.NET 4 die Schnittstelle IHtmlString implementiert. Wenn Entwickler <%: Html.*() %>in ASP.NET 4 verwenden, wird das Ergebnis daher nicht doppelt codiert.

Bearbeiten:

Ein unmittelbarer Vorteil dieser neuen Syntax besteht darin, dass Ihre Ansichten etwas sauberer sind. Zum Beispiel können Sie <%: ViewData["anything"] %>statt schreiben <%= Html.Encode(ViewData["anything"]) %>.

Dies ist eine späte Antwort, aber wenn jemand, der diese Frage liest, Rasiermesser verwendet, sollten Sie sich daran erinnern, dass Rasiermesser standardmäßig alles codiert. Wenn Sie jedoch MvcHtmlStringin Ihren HTML-Helfern verwenden, können Sie Rasiermesser mitteilen, dass es nicht codiert werden muss .

Wenn Sie möchten, dass der Rasierer keine Zeichenfolge codiert, verwenden Sie

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

Das Dekompilieren von Raw () zeigt uns, dass die Zeichenfolge in einen HtmlString eingeschlossen wird

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

" HtmlString ist nur in ASP.NET 4 vorhanden.

MvcHtmlString war ein Kompatibilitäts-Shim, der MVC 2 hinzugefügt wurde, um sowohl .NET 3.5 als auch .NET 4 zu unterstützen. Da MVC 3 nur .NET 4 ist, ist es aus Gründen der Quellkompatibilität eine ziemlich triviale Unterklasse von HtmlString, vermutlich für MVC 2-> 3. " Quelle

Eine gute praktische Anwendung ist, wenn Sie Ihre eigenen HtmlHelperErweiterungen erstellen möchten . Ich hasse es beispielsweise, mich an die <link>Tag-Syntax zu erinnern , deshalb habe ich meine eigene Erweiterungsmethode erstellt, um ein <link>Tag zu erstellen:

<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

Ich hätte Stringvon dieser Methode zurückkehren können, aber wenn ich Folgendes hätte, würde es kaputt gehen:

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

Mit MvcHtmlStringeinem <%: ... %>oder <%= ... %>beiden funktionieren beide korrekt.

Sie würden ein verwenden, MvcHtmlStringwenn Sie Roh-HTML an eine MVC-Hilfsmethode übergeben möchten und Sie nicht möchten, dass die Hilfsmethode den HTML-Code codiert.