Що таке MvcHtmlString і коли я повинен його використовувати?

Документація для MvcHtmlStringне надто просвіщаючи:

Представляє HTML-кодований рядок, який не слід кодувати знову.

Мені не ясно, які саме наслідки це. Здається, що деякі допоміжні методи HTML повертають MvcHtmlString, але декілька прикладів, які я бачив в Інтернеті, користувацьких помічників просто повертають звичайну рядок.

Запитання:

Що таке MvcHtmlString?

Коли я повинен вибрати MvcHtmlStringбільше stringі навпаки? Чому?

ASP.NET 4 представляє новий синтаксис саморізу коду <%: %>. По суті, <%: foo %>перекладається на <%= HttpUtility.HtmlEncode(foo) %>. Команда намагається змусити розробників використовувати <%: %>замість того, <%= %>де це можливо, для запобігання XSS.

Однак це вводить проблему, що якщо кодовий саморіз вже кодує його результат, <%: %>синтаксис повторно кодує його. Це вирішується впровадженням інтерфейсу IHtmlString (новий у .NET 4). Якщо Foo () в <%: foo() %>повертає IHtmlString, то <%: %>синтаксис НЕ буде перекодувати його.

Помічники MVC 2 повертають MvcHtmlString, який на ASP.NET 4 реалізує інтерфейс IHtmlString. Тому, коли розробники використовують <%: Html.*() %>в ASP.NET 4, результат не буде подвійним кодуванням.

Редагувати:

Безпосередньою перевагою цього нового синтаксису є те, що ваші погляди трохи чистіші. Наприклад, ви можете писати <%: ViewData["anything"] %>замість <%= Html.Encode(ViewData["anything"]) %>.

Це пізня відповідь, але якщо хтось, хто читає це питання, використовує бритву, то вам слід пам’ятати, що бритва кодує все за замовчуванням, але, використовуючи MvcHtmlStringу своїх html-помічниках, ви можете сказати бритві, що не потрібно її кодувати .

Якщо ви хочете, щоб бритва не кодувала рядок

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

Декомпілюючи Raw (), показує нам, що він загортає рядок у HtmlString

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

" HtmlString існує лише в ASP.NET 4.

MvcHtmlString - це суміс сумісності, доданий до MVC 2 для підтримки .NET 3.5 та .NET 4. Тепер, коли MVC 3 є тільки .NET 4, це досить тривіальний підклас HtmlString, імовірно, для MVC 2-> 3 для сумісності з джерелами. " джерело

Приємне практичне використання цього, якщо ви хочете зробити власні HtmlHelperрозширення. Наприклад, я ненавиджу намагатися запам'ятати <link>синтаксис тегів, тому я створив власний метод розширення, щоб зробити <link>тег:

<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

Я міг би повернутися Stringз цього методу, але якби у мене було таке, я б порушив:

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

З MvcHtmlString, використовуючи або обидва, <%: ... %>або <%= ... %>обидва будуть працювати правильно.

Ви б використовували, MvcHtmlStringякщо хочете передати необроблений HTML до допоміжного методу MVC, і ви не хочете, щоб метод помічника кодував HTML.