将 C# 对象渲染为 Html

Question

我们有一堆域实体，应该呈现为 html 格式，在弹出窗口中显示它们的详细信息。

我很乐意做这样的事情：

Product product = new Product(...);
product.ToHtml();  // or: HtmlRenderer.Render(Product);

但我的主要问题是如何从后面做这些事情。 我有 3 个不同的答案：

1。 通过代码渲染：

我可以简单地在 ToHtml 方法 (C#) 中编写用于渲染 Html 的代码 - 问题是它太静态。 如果您想将标题稍微移到中间，您应该更改代码。 而且，在 C# 中读取 Html 缩进非常困难。

2. 使用XSL：

XSL 文件可以轻松管理Html 模板，使用XSLT 我可以将XML 文件转换到文档的正确位置。 其他人已经编写的解析器（只需要学习语法） ** 为此，我们需要每个对象都可以序列化为 Xml。 如果对象发生变化 -> Xml 将被更改 --> xslt也需要改变 ** 这也让我可以选择轻松缩进 html，例如：添加 css 功能和\或更改 html 设计

3. 使用其他模板引擎：

编写我自己的C# -> Html 模板引擎因此将从文件 (*.template) 中读取模板，并使用反射将正确的属性插入到模板的正确位置。 ** 对于这个解决方案我们有很多可以想到的问题，例如：语法应该如何？ 这件事还好吗？ %名称%

%描述%

And how we can handle arrays? ** Maybe we can use an existing engine (Brail or T4-Templating)?

你喜欢哪个？ 你知道什么是好的发动机吗？ 目前我更喜欢第二种解决方案，但它会非常慢。

Answer 1

我曾经需要将任何类型的集合渲染到 Html 表中。 我在 IEnumerable上创建了一个扩展方法； 它有 css 等的重载。 您可以在这里查看我的博客文章：

http:// crazorsharp.blogspot.com/2009/03/cool-ienumberable-extension-method_25.html

它使用反射来获取对象的所有属性，并呈现一个漂亮的小表格。 看看这是否适合你。

[System.Runtime.CompilerServices.Extension()]
public string ToHtmlTable<T>(IEnumerable<T> list, string propertiesToIncludeAsColumns = "")
{
    return ToHtmlTable(list, string.Empty, string.Empty, string.Empty, string.Empty, propertiesToIncludeAsColumns);
}

[System.Runtime.CompilerServices.Extension()]
public string ToHtmlTable<T>(IEnumerable<T> list, string tableSyle, string headerStyle, string rowStyle, string alternateRowStyle, string propertiesToIncludeAsColumns = "")
{
    dynamic result = new StringBuilder();
    if (String.IsNullOrEmpty(tableSyle)) {
        result.Append("<table id=\"" + typeof(T).Name + "Table\">");
    } else {
        result.Append((Convert.ToString("<table id=\"" + typeof(T).Name + "Table\" class=\"") + tableSyle) + "\">");
    }

    dynamic propertyArray = typeof(T).GetProperties();

    foreach (object prop in propertyArray) {
       if (string.IsNullOrEmpty(propertiesToIncludeAsColumns) || propertiesToIncludeAsColumns.Contains(prop.Name + ",")) {
        if (String.IsNullOrEmpty(headerStyle)) {
            result.AppendFormat("<th>{0}</th>", prop.Name);
        } else {
            result.AppendFormat("<th class=\"{0}\">{1}</th>", headerStyle, prop.Name);
        }
      }
    }

    for (int i = 0; i <= list.Count() - 1; i++) {
        if (!String.IsNullOrEmpty(rowStyle) && !String.IsNullOrEmpty(alternateRowStyle)) {
            result.AppendFormat("<tr class=\"{0}\">", i % 2 == 0 ? rowStyle : alternateRowStyle);

        } else {
            result.AppendFormat("<tr>");
        }
        foreach (object prop in propertyArray) {
            if (string.IsNullOrEmpty(propertiesToIncludeAsColumns) || propertiesToIncludeAsColumns.Contains(prop.Name + ",")) {
                object value = prop.GetValue(list.ElementAt(i), null);
                result.AppendFormat("<td>{0}</td>", value ?? String.Empty);
            }
        }
        result.AppendLine("</tr>");
    }

    result.Append("</table>");

    return result.ToString();
}

Answer 2

我非常同意约翰·费米内拉的观点。 将 Html 渲染直接集成到您的域实体中是对域的可怕污染，完全是任意的和外部的关注。 就像约翰所说，这样做会让你的实体变得非常脆弱，并打破这两个关键规则：关注点分离和单一责任。

从您给出的选择来看，#3 是最接近合适的方法。 您无需编写自己的模板引擎。 网上有很多免费的现成模板引擎，它们可以胜任这项工作（NVelocity、StringTemplate、Brail 等）。

在您的演示文稿/视图中继续渲染它所属的位置...不要因更高级别的问题而污染您的域。

Answer 3

这是您的视图的工作，而不是您的控制器或模型的工作。 正如您所怀疑的，使用方法（1）将使您的更改变得非常脆弱。 相反，为您想要呈现特定域实体的每种方式编写一个视图片段。 然后只需拉入适当的视图即可构建最终页面。

Answer 4

我真诚地更喜欢方法 A。HTML 已经是一种标准，因此您不应该过度使用中间格式，例如 XML（通过 XSL - 方法 2）或自定义格式（方法 3）。

如果使用 ASP.NET MVC 进行编写，您可以构建一个 .ASCX（用户控件），它将接受您类型的对象并呈现适当的 HTML。 而且您不会遇到令人讨厌的 C# 缩进，也不会突出显示，也不会自动完成。

您还可以编写多个用户视图来适应一种对象类型的不同场景。

Answer 5

您是否有理由不想创建一个将域实体对象作为参数的自定义控件 .ascx 文件，然后您可以按照您想要的方式制作 gui。 通过这种方式，您可以动态地将控件添加到页面，并且只需设置一个属性来填充它们。

编辑1：
只需将控件呈现给 HTMLTextWriter，而不是将其放置在页面上。

        StringBuilder outString = new StringBuilder();
        StringWriter outWriter = new StringWriter(outString);
        HtmlTextWriter htmlText = new HtmlTextWriter(outWriter);
        System.Web.UI.WebControls.Label lbl1 = new System.Web.UI.WebControls.Label();
        lbl1.Text = "This is just a test!";
        lbl1.ToolTip = "Really";
        lbl1.RenderControl(htmlText);
        ViewData["Output"] = outString.ToString();

输出

<span title="Really">This is just a test!</span>

当然，使用您的自定义控件而不是内置控件，但这是一个快速而简单的演示。

Answer 6

经过一番研究后，我制作了自己的函数，将任何对象转换为 HtmlString。

VB .Net 代码：

 Public Function ToHtmlString(ByVal fObj As Object) As String
    Dim pType = fObj.GetType()
    Dim props As IList(Of PropertyInfo) = pType.GetProperties()
    Dim value As Object = Nothing
    Dim htmlString As String = "<html><body><form>"

    For Each p In props
        value = p.GetValue(fObj, Nothing)
        If value <> Nothing Then
            htmlString += String.Format("<input type=""hidden"" name=""{0}"" id=""{0}"" value=""{1}""/>", p.Name, value)
        End If
    Next

    htmlString += "</form></body></html>"
    Return htmlString.ToString()

它将从特定对象获取属性名称和值。 你可以根据你的情况来操作html

Answer 7

就个人而言，我会结合方法二和方法三：只需使用反射创建一个通用 XML 文档，例如：

<object type="xxxx">
    <property name="ttt" value="vvv"/>
    ...
</object>

并使用 XSTL 样式表从中创建实际的 HTML。