.net - 用于呈现 HTML 的流畅界面

Question

在我看来，使用 HtmlTextWriter 呈现 HTML 并不是非常直观，但是如果您在 Web 表单中实现 Web 控件，那么您必须使用它。我认为可以为此创建一个流畅的界面，使其读起来更像它输出的 HTML。我想知道人们对我到目前为止提出的语法有何看法。

    public void Render(HtmlTextWriter writer)
    {
        writer
            .Tag(HtmlTextWriterTag.Div, e => e[HtmlTextWriterAttribute.Id, "id"][HtmlTextWriterAttribute.Name,"name"][HtmlTextWriterAttribute.Class,"class"])
                .Tag(HtmlTextWriterTag.Span)
                    .Text("Lorem")
                .EndTag()
                .Tag(HtmlTextWriterTag.Span)
                    .Text("ipsum")
                .EndTag()
            .EndTag();        
    }

“Tag”、“Text”和“EndTag”是 HtmlTextWriter 类的扩展方法，它返回它接收的实例，以便可以链接调用。传递给第一次调用“Tag”的重载中使用的 lambda 的参数是一个“HtmlAttributeManager”，它是一个简单的类，它包装了一个 HtmlTextWriter 以提供一个索引器，该索引器采用一个 HtmlTextWriterAttribute 和一个字符串值并返回实例所以可以链接调用。我在这个类上还有用于最常见属性的方法，例如“Name”、“Class”和“Id”，因此您可以按如下方式编写上面的第一个调用:

.Tag(HtmlTextWriterTag.Div, e => e.Id("id").Name("name").Class("class"))

稍微长一点的例子:

public void Render(HtmlTextWriter writer)
{
    writer
        .Tag(HtmlTextWriterTag.Div, a => a.Class("someClass", "someOtherClass"))
            .Tag(HtmlTextWriterTag.H1).Text("Lorem").EndTag()
            .Tag(HtmlTextWriterTag.Select, t => t.Id("fooSelect").Name("fooSelect").Class("selectClass"))
                .Tag(HtmlTextWriterTag.Option, t => t[HtmlTextWriterAttribute.Value, "1"][HtmlTextWriterAttribute.Title, "Selects the number 1."])
                    .Text("1")
                .EndTag(HtmlTextWriterTag.Option)
                .Tag(HtmlTextWriterTag.Option, t => t[HtmlTextWriterAttribute.Value, "2"][HtmlTextWriterAttribute.Title, "Selects the number 2."])
                    .Text("2")
                .EndTag(HtmlTextWriterTag.Option)
                .Tag(HtmlTextWriterTag.Option, t => t[HtmlTextWriterAttribute.Value, "3"][HtmlTextWriterAttribute.Title, "Selects the number 3."])
                    .Text("3")
                .EndTag(HtmlTextWriterTag.Option)
            .EndTag(HtmlTextWriterTag.Select)
        .EndTag(HtmlTextWriterTag.Div);
}

希望您能够“破译”这段代码输出的 HTML 内容，至少想法是这样。

请给我任何关于如何改进语法的想法，可能是更好的方法名称，也可能是其他一些方法。

编辑:我认为在不使用流畅界面的情况下查看相同代码段的外观可能会很有趣，以进行比较:

public void RenderUsingHtmlTextWriterStandardMethods(HtmlTextWriter writer)
{
    writer.AddAttribute(HtmlTextWriterAttribute.Class, "someClass someOtherClass");
    writer.RenderBeginTag(HtmlTextWriterTag.Div);

    writer.RenderBeginTag(HtmlTextWriterTag.H1);
    writer.Write("Lorem");
    writer.RenderEndTag();

    writer.AddAttribute(HtmlTextWriterAttribute.Id, "fooSelect");
    writer.AddAttribute(HtmlTextWriterAttribute.Name, "fooSelect");
    writer.AddAttribute(HtmlTextWriterAttribute.Class, "selectClass");
    writer.RenderBeginTag(HtmlTextWriterTag.Select);

    writer.AddAttribute(HtmlTextWriterAttribute.Value, "1");
    writer.AddAttribute(HtmlTextWriterAttribute.Title, "Selects the number 1.");
    writer.RenderBeginTag(HtmlTextWriterTag.Option);
    writer.Write("1");
    writer.RenderEndTag();

    writer.AddAttribute(HtmlTextWriterAttribute.Value, "2");
    writer.AddAttribute(HtmlTextWriterAttribute.Title, "Selects the number 2.");
    writer.RenderBeginTag(HtmlTextWriterTag.Option);
    writer.Write("2");
    writer.RenderEndTag();

    writer.AddAttribute(HtmlTextWriterAttribute.Value, "3");
    writer.AddAttribute(HtmlTextWriterAttribute.Title, "Selects the number 3.");
    writer.RenderBeginTag(HtmlTextWriterTag.Option);
    writer.Write("3");
    writer.RenderEndTag();

    writer.RenderEndTag();

    writer.RenderEndTag();
}

编辑:我可能应该更明确一点，这样做的目标之一是它应该产生尽可能少的开销，这就是我限制使用 lambda 的原因。同样，一开始我使用了一个代表标签的类，以便在渲染之前通过语法构建类似于 DOM 树的东西，尽管语法非常相似。我放弃了这个解决方案，因为它会产生轻微的内存开销。在 HtmlAttributeManager 类的使用中仍然存在一些问题，我一直在考虑使用扩展方法来附加属性，但是我不能使用索引器语法，它也会使 HtmlTextWriter 的接口(interface)膨胀甚至更多。

Answer 1

我看到两个问题:

• 重复使用 Tag(Tagname, …)。为什么不为每个标签名称提供扩展方法？诚然，这会使界面膨胀并且需要编写大量内容(=> 代码生成!)。
• 编译器/IDE 不会帮助你。特别是，它不会检查缩进(当您自动缩进时，它甚至会破坏它)。

这两个问题也许可以通过使用 Lambda 方法来解决:

writer.Write(body => new Tag[] {
    new Tag(h1 => "Hello, world!"),
    new Tag(p => "Indeed. What a lovely day.", new Attr[] {
        new Attr("style", "color: red")
    })
});

这只是一种基本方法。 API 肯定需要做更多的工作。特别是，由于参数名称冲突，嵌套相同的标记名称将不起作用。此外，此接口(interface)在 VB 中无法正常工作(或根本无法正常工作)。但是，不幸的是，对于其他现代 .NET API，甚至是 Microsoft 的 PLINQ 接口(interface)也是如此。

我前段时间想到的另一种方法实际上是在尝试模仿Markaby，就像sambo 的代码一样。主要区别是我使用 using block 而不是 foreach，因此使用了 RAII:

using (var body = writer.body("xml:lang", "en")) {
    using (var h1 = body.h1())
        h1.AddText("Hello, World!");
    using (var p = body.p("style", "color: red"))
        p.AddText("Indeed. What a lovely day.");
}

此代码没有其他方法的问题。另一方面，它为属性提供的类型安全性较低，接口(interface)也不太优雅(对于给定的“优雅”定义)。

我编译了这两个代码，甚至生成了一些或多或少有意义的输出(即:HTML!)。