提示/流利的剃刀部分名称?

时间:2013-05-10 20:07:16

标签: c# asp.net-mvc

所以我有一个案例,布局已经发展变得更加复杂。有通常的事情,如@section styleIncludes{ ... },然后其他部分定义了每个页面可以选择(但几乎总是)指定像当前页面痕迹的结构的各种事物。所有这些都是部分的原因是因为它们嵌入在布局的结构中。

我发现自己制作了以前页面的副本,因为有8个左右的不同部分,而不是试着记住它们的确切拼写,或者单独复制/粘贴。

我认为最好为这些创建一个流畅的API,以便我有一些具有8个函数的对象,每个函数都返回对象本身,所以你可以做一些像Sections.Style(一些MVC文本模板)或剃刀delgate?)。面包屑(等)

主要目的是能够以引导的方式对这些部分进行编码,并强烈键入名称,而不是依赖于完美的输入或复制/粘贴。

然而,razor中的扩展/帮助器返回MvcHtmlString,我想@section由完全不同的东西表示。

不要求你为我写一个完整的解决方案,而只是提出一些关于如何先行的想法。

帮助器返回什么对象来表示@section声明? I.e。 MvcHtmlString的类比。

你会建议Fluent方法的参数类型,比如Style或Breadcrumb?我希望传递的razor能够在部分声明的花括号中编写razor。例如,能够访问剃刀页面上声明的局部变量,就像使用常规部分声明一样。我不希望像.SomeSection("<div...>Bunch of html stuffed in a string</div>")

这样的字符串连接之类的东西

换句话说,如果我的许多cshtml页面都开始像

那样
@{
  string title = "Edit Person"
  ViewBag.Title = title;
}
@section styles{
  .someOneOffPageSpecificStyle { width:59px }
}
@section javascript{
  //javascript includes which the layout will place at the bottom...
}
@section breadcrumb{
  <a ...>Parent Page</a> &gt; <a ...>Sub Page</a> &gt; @title
}

我宁愿像这样有一些流畅的API,不是真正的代码风格,而是因为它更容易编写代码而不会出现错别字等问题,因为intellisense会帮助:< / p>

@{
  string title = "Edit Person"
  ViewBag.Title = title;
}
@Sections
.Styles(@<text>
  .someOneOffPageSpecificStyle { width:59px }
</text>)
.Javascript(@<text>
  //javascript includes which the layout will place at the bottom...
</text>)
.Breadcrumb(@<text>
  <a ...>Parent Page</a> &gt; <a ...>Sub Page</a> &gt; @title
</text>)

3 个答案:

答案 0 :(得分:2)

最有可能这是不可能的(使用部分)。

首先,我们必须了解MVC如何在幕后工作。我们编写cshtml文件,但这些文件最终会被编译成实例化的.Net class,然后执行方法(至少Execute()),这些方法(大部分时间)写入响应缓冲区要返回IIS(非常相似,如果与RenderAction的工作方式完全相同 - 调用子操作方法并在父视图中内联呈现结果)。 HtmlHelpers(或任何自定义助手)只是从instaniated类(作为委托)调用,因此它们只能在编译cshtml文件中的代码后执行。

System.Web.Razor.Generator.SectionCodeGenerator需要字符串定义来创建Sections。因此,当您定义一个Section时,在编译文件之前,字符串必须存在于cshtml文件中,因为在编译文件之前不会执行HtmlHelper或/和自定义帮助程序,因此无法编写类或对象可以在编译之前更新cshtml文件。

可以做的是编写自己的HtmlHelper或其他自定义助手,以执行类似于章节提供的内容(不实际使用任何部分)。例如I wrote this because I needed to write Javascript from partial views and/or templates (which you can't do with sections)。如果您需要使用部分,那么这可能没有帮助。

以下代码仅示例不是razor实际上是如何工作的(根本就是看了一些代码之后)。但是为了使这个例子有意义,我将使用razor-ish代码和命名约定。

layout.cshtml

<html>
<body>
@RenderSection("MySectionName")

@RenderBody();
</body>
</html>

Index.cshtml

@{
  _layout = "layout";
}

@section MySection {
  <div>MySection</div>
}

<div>My Body</div>

也许可以编译成类似于的类:

public class app_aspnet_layout : System.Web.Mvc.WebViewPage
{

  public Execute()
  {
    throw new NotImplementedException();
  }

  public void ExecutePageHierarchy(WebPageContext pageContext, 
                                   TextWriter writer)
  {
    writer.Write("<html>")
    writer.Write("<body>")

    var section = pageContext.SectionWriters["MySectionName"];
    section();

    pageContext.View.ExecutePageHierarchy(null, writer)

    writer.Write("</body>")
    writer.Write("</html>")
  }
}

public class app_aspnet_index : System.Web.Mvc.WebViewPage
{ 
  // generated from the _layout Definition
  private WebViewPage startPage = new app_aspnet_layout();

  public Execute()
  {
     WebPageContext pageContext = new WebPageContext();
     pageContext.View = this;

     pageContext.SectionWriters.Add("MySectionName", 
                                    this.Section_MySectionName);

     var writer = HttpContext.Current.Response.Stream.AsTextWriter();

     if (startPage != null)
     {
       startPage.ExecutePageHierarchy(pageContext, writer);
     }
     else
     {
       this.ExecutePageHierarchy(pageContext, writer);
     }
  }

  // html generated from non-section html
  public void ExecutePageHierarchy(WebPageContext pageContext, 
                                   TextWriter writer)
  {
    writer.Write("<div>My Body</div>");
  }

  public void Section_MySectionName(TextWriter writer)
  {
    writer.Write("<div>MySection</div>");
  }
}

答案 1 :(得分:1)

如果您有resharper,那么我建议使用实时代码模板(功能强大的代码段)。

您可以使用单个参数create a template。此参数的宏源可以是逗号分隔的值列表。 当您使用模板/片段时,它会向您显示一个智能感知框,其中您的部分名称可供选择。

假设您使用的部分的名称不会更改那么多,那么您不必经常编辑模板以包含新的部分名称。

答案 2 :(得分:0)

您可以使用t4模板从不同的方向解决问题。

如果您的布局结构现在相当稳定(即您不经常添加和删除部分),并且您想要的只是在创建新视图时不必复制和粘贴内容 - 这可能会很有效。它将根据您的规格为您创建视图 - 您可以使用反射和其他逻辑在其中做一些非常聪明的事情

有一个nuget可以加载代码模板 - 搜索“codetemplates” - 它们非常直接使用。