ASP.NET MVC 3 自定义 HTML 帮助程序 - 最佳实践/使用

Question

MVC 新手，并且已经完成了 ASP.NET 网站上的教程。

它们包括一个自定义 html 帮助程序的示例，用于截断表中显示的长文本。

只是想知道人们使用 HTML 帮助器提出了哪些其他解决方案，以及在创建/使用它们时是否有任何最佳实践或需要避免的事情。

举个例子，我正在考虑编写一个自定义助手来格式化我需要在不同地方显示的日期，但现在担心可能有一个更优雅的解决方案（IE DataAnnotations in my models）

有什么想法吗？

编辑：

我刚刚想到的另一个潜在用途......字符串连接。 自定义助手可以将用户 ID 作为输入并返回用户全名... 结果可能是某种形式的（标题）（第一个）（中间）（最后一个），具体取决于哪些字段可用。只是一个想法，我还没有尝试过这样的事情。

Answer 1

我一直使用 HtmlHelpers，最常见的是封装样板 HTML 的生成，以防我改变主意。我有这样的帮助器：

• Html.BodyId()：生成一个传统的 body id 标记，以便在为视图添加自定义 css 时进行引用。
• Html.SubmitButton(string)：生成 input[type=submit] 或 button[type=submit] 元素，具体取决于我想要如何设置按钮的样式。
• Html.Pager(IPgedList)：用于从分页列表模型生成分页控件。
• 等等......

我最喜欢的 HtmlHelpers 用途之一是干燥常见的表单标记。通常，我有一个用于表单行的容器 div，一个用于标签的 div，以及一个用于输入、验证消息、提示文本等的标签。最终，这可能会成为大量样板 html 标签。我如何处理此问题的一个示例如下：

public static MvcHtmlString FormLineDropDownListFor<TModel, TProperty>(this HtmlHelper<TModel> helper, Expression<Func<TModel, TProperty>> expression, IEnumerable<SelectListItem> selectList, string labelText = null, string customHelpText = null, object htmlAttributes = null)
{
    return FormLine(
        helper.LabelFor(expression, labelText).ToString() +
        helper.HelpTextFor(expression, customHelpText),
        helper.DropDownListFor(expression, selectList, htmlAttributes).ToString() +
        helper.ValidationMessageFor(expression));
}

public static MvcHtmlString FormLineEditorFor<TModel, TProperty>(this HtmlHelper<TModel> helper, Expression<Func<TModel, TProperty>> expression, string templateName = null, string labelText = null, string customHelpText = null, object htmlAttributes = null)
{
    return FormLine(
        helper.LabelFor(expression, labelText).ToString() +
        helper.HelpTextFor(expression, customHelpText),
        helper.EditorFor(expression, templateName, htmlAttributes).ToString() +
        helper.ValidationMessageFor(expression));
}

private static MvcHtmlString FormLine(string labelContent, string fieldContent, object htmlAttributes = null)
{
    var editorLabel = new TagBuilder("div");
    editorLabel.AddCssClass("editor-label");
    editorLabel.InnerHtml += labelContent;

    var editorField = new TagBuilder("div");
    editorField.AddCssClass("editor-field");
    editorField.InnerHtml += fieldContent;

    var container = new TagBuilder("div");
    if (htmlAttributes != null)
        container.MergeAttributes(new RouteValueDictionary(htmlAttributes));
    container.AddCssClass("form-line");
    container.InnerHtml += editorLabel;
    container.InnerHtml += editorField;

    return MvcHtmlString.Create(container.ToString());
}

public static MvcHtmlString HelpTextFor<TModel, TProperty>(this HtmlHelper<TModel> helper, Expression<Func<TModel, TProperty>> expression, string customText = null)
{
    // Can do all sorts of things here -- eg: reflect over attributes and add hints, etc...
}    

不过，一旦完成此操作，您就可以输出如下所示的表单行：

<%: Html.FormLineEditorFor(model => model.Property1) %>
<%: Html.FormLineEditorFor(model => model.Property2) %>
<%: Html.FormLineEditorFor(model => model.Property3) %>

... 和 BAM，所有标签、输入、提示和验证消息都在您的页面上。同样，您可以在模型上使用属性并对其进行反思，以获得真正的智能和 DRY。当然，如果您无法标准化表单设计，这将是浪费时间。然而，对于简单的情况，CSS 可以提供您需要的所有自定义，它可以工作 grrrrrrrrrreat！

这个故事的寓意是——HtmlHelpers 可以使您免受全局设计更改的影响，这些更改会在视图中破坏手工制作的标记。我喜欢他们。但你可能会太过分，有时部分视图比编码助手更好。 我用来决定助手与部分视图之间的一般经验法则：如果 HTML 块需要大量条件逻辑或编码技巧，我会使用助手（将代码放在应该放置的位置）；如果没有，如果我只是输出没有太多逻辑的常见标记，我会使用部分视图（将标记放在应该标记的位置）。

希望这能给您一些想法！

Answer 2

那么在格式化 DisplayFormat 属性的情况下可能是一个不错的解决方案:

[DisplayFormat(DataFormatString = "{0:yyyy-MM-dd}")]
public DateTime Date { get; set; }

然后简单地说：

@Html.DisplayFor(x => x.Date)

就截断字符串而言，自定义 HTML 帮助器是一个很好的解决方案。

---

更新：

关于您的编辑，自定义 HTML 帮助器可能在这种情况下工作，但还有一种我非常喜欢的替代方法：视图模型。因此，如果在这个特定的视图中，您总是要显示名称的串联，那么您可以定义一个视图模型：

public class PersonViewModel
{
    public string FullName { get; set; }
}

现在控制器将查询存储库以获取模型，然后将此模型映射到视图模型，该视图模型将是传递给视图，以便视图可以简单地@Html.DisplayFor(x => x.FullName)。模型和视图模型之间的映射可以通过像 AutoMapper 这样的框架来简化。

Answer 3

public static HtmlString OwnControlName<T, U>(this HtmlHelper<T> helper, Expression<Func<T, U>> expression, string label_Name = "", string label_Title = "", Attr attr = null)
        {
            TemplateBuilder tb = null;
            string template = null;
          if (expression == null) throw new ArgumentException("expression");
 obj = helper.ViewData.Model;
                tb.Build(obj, expression.Body as MemberExpression, typeof(T), new SimpleTemplate(new TextArea()), label_Name, label_Title, attr);
                template = tb.Get();
 return new MvcHtmlString(template);
}