为什么 Razor _layout.cshtml 在文件名中有一个前导下划线？

Question

在默认的 ASP.NET MVC 3 项目中，布局和部分 cshtml 文件以下划线开头

• _viewstart
• _Layout
• _LogOnPartial

为什么要使用这个约定，它的用途是什么？ 我需要遵守这个约定吗？

框架是否赋予以下划线开头的.cshtml文件一些特殊含义？

Answer 1

Razor 是为 ASP.NET 网页 (WebMatrix) 开发的，它没有与您在 MVC 中获得的关于视图文件夹和路由的相同类型的内置保护。 由于网页中的布局页面不打算直接提供服务，因此它们以下划线为前缀。 并且网页框架已配置为不允许直接请求名称中带有前导下划线的文件。 网页中的其他 .cshtml 文件通常需要可浏览。 它们相当于 .asp 或 .php 文件。

ASP.NET 团队表示，Web Pages 是 ASP.NET 开发的起点，它应该会导致及时迁移到 MVC（对于那些想要继续前进的人）。 这部分意味着从网页迁移到 MVC 应该尽可能容易。 因此，将 Web Pages 中建立的命名约定转移到 MVC Razor 文件是有意义的。

因此，有一个技术原因，用下划线前缀的文件名-它只是不相关的MVC。

[2018 年 10 月更新]

在新的 ASP.NET Core Razor Pages 框架中（2.1 版除外），在启动时生成路由时，带有前导下划线的文件将被忽略——即使它们有一个@page指令（这通常会使它们成为可路由的 Razor页）。 这就是为什么在 Razor Pages 应用程序中使用前导下划线命名布局和部分文件是有意义的，如果它们不打算被浏览。

Answer 2

这就是 Ruby on Rails 的做法（Partials 以 _ 开头，但 Render Partial 调用不包括 _），并且 ASP.net MVC 从中汲取了大量灵感。

真的没有技术原因，只是一个约定，向其他开发人员（以及 6 个月后的你自己）清楚地表明意图：这是一个片面的观点。

Answer 3

无法通过来自浏览器的直接请求（母版页、部分视图等）显示的页面在其名称的开头带有下划线 (_)。

因此，如果您尝试向 _Layout.cshtml（这是母版页）发出请求，您将收到来自服务器的错误。

它是一种在 Razor 视图引擎中区分不能作为独立页面浏览的文件的方法。

这样想......在MVC 2中......你会用后缀.master，.ascx来区分局部视图和主站点，而普通页面是.aspx，另一方面，在Razor视图中......所有视图都是 .cshtml，因此为了区分部分和母版页，它们将有一个前缀 (_)。 它不是强制性的，只是一个“约定”。

Answer 4

据我所知，这只是用于识别文件意图的约定； 我不相信它实际上会改变文件的行为。 在大多数开发环境中，前置下划线标识用于“私人”使用的内容，无论是类，还是在这种情况下，另一个模板。

Answer 5

我不使用 MVC，但是对于也使用 razor 语法的网页，_ 前缀通常表示该页面不是由用户访问，而是由其他页面或某些代码访问。 如果您尝试导航到包含 _prefix 的页面，asp.net 将阻止对其进行访问。 这就是为什么它与布局页面和其他此类页面一起使用的原因，因为用户不应直接访问它们。

类似于 asp.net 中的 App_Code 文件夹

Answer 6

右键单击 Index.cshtml 文件并选择在浏览器中查看。 由此，我们可以在浏览器中测试 index.html 页面（无需运行应用程序）。

对 _Layout.cshtml 页面执行相同操作，它将显示错误或浏览器将呈现默认页面（Home/Index.cshtml）。

因为以 _ 为前缀的页面不会通过浏览器进行测试。

我们可以通过嵌入另一个 cshtml 页面来测试这些页面（_Layout.cshtml）。