提示/流畅的剃刀部分名称

本文关键字：剃刀部 提示 | 更新日期: 2023-09-27 18:12:59

所以我有一个布局已经变得更加复杂的情况。有一些常见的东西，比如@section styleIncludes{ ... }，然后其他部分定义了每个页面可以选择(但几乎总是)指定的各种东西，比如当前页面面包屑的结构。所有这些东西都是section的原因是因为它们嵌入在布局的结构中。

我发现自己在复制前几页，因为有8个左右不同的部分，而不是试图记住它们的确切拼写，或者一份一份地复制/粘贴。

我认为最好为这些创建一个流畅的API，这样我就有一些有8个函数的对象，每个函数返回对象本身，所以你可以做一些像Sections的事情。样式(一些MVC文本模板或razor委托?)。breadcrumb(等)

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

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

不要求你为我写一个完整的解决方案，只是一些关于如何开始的想法。

helper应该返回什么对象来表示@section声明?即MvcHtmlString的类比。

你认为流畅方法的参数类型是什么，比如Style还是Breadcrumb?我希望传递的razor在功能上类似于在section声明的花括号中编写razor。例如，访问在razor页面上声明的局部变量的能力，就像您可以使用常规的section声明一样。我不想要像.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，不是真正的结果风格的代码，而是因为它将更容易编写代码，没有拼写错误等问题，因为智能感知将协助:

@{
  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>)

提示/流畅的剃刀部分名称

很可能这是不可能的(使用节)。

首先，我们必须了解MVC是如何工作的。我们编写cshtml文件，但这些文件最终将被编译成一个实例化的。net类，然后执行方法(在最小的Execute())，(大多数情况下)将其写入IIS的响应缓冲区以返回(非常类似于RenderAction的工作方式- 调用子操作方法并在父视图中内联呈现结果)。HtmlHelpers(或任何自定义的helper)只是简单地从实例化的类中调用(作为委托)，所以它们只能在cshtml文件中的代码编译后执行。

System.Web.Razor.Generator.SectionCodeGenerator需要一个字符串定义来创建Sections。所以当你定义一个Section时，字符串必须在文件编译之前存在于cshtml文件中，因为HtmlHelper或/和Custom helper在文件编译之前不会执行，所以没有办法在编译之前编写一个类或对象来更新cshtml文件。

你可以做的是编写自己的HtmlHelper或其他自定义helper来做类似于Sections提供的东西(而不实际使用任何section)。例如，我写这个是因为我需要从部分视图和/或模板(你不能用节)编写Javascript。如果您需要使用节，那么这可能没有帮助。

下面的代码是示例，只有，这不是剃刀实际工作的方式(在看了一些代码之后，根本不是)。但是为了使这个例子更有意义，我将使用类似剃刀的代码和命名约定。

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>");
  }
}

如果你有resharper，那么我建议你使用live code模板(一个强大的代码片段)

可以用单个参数创建模板。此参数的宏源可以是一个逗号分隔的值列表。当你使用模板/代码片段时，它会给你一个智能感知框，里面有你的节名可供选择。

假设你使用的节名不会改变那么你不应该经常编辑模板来包含新的节名

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

如果你的布局结构现在是相当稳定的(即。你不会频繁地添加和删除部分)，你想要的只是在创建新视图时停止复制和粘贴东西——这可能会工作得很好。它会根据你的规范为你创建视图——你可以用反射和其他逻辑在其中做一些相当聪明的事情

有一个插件来加载代码模板——搜索"codetemplates"——它们使用起来非常简单。

相关文章：