ASP.NET Core - Razor ViewImports 文件

在本章中,我们将讨论 Razor 视图导入。 除了 ViewStart 文件之外,还有一个 ViewImports 文件,MVC 框架在呈现任何视图时都会查找该文件。

和 ViewStart 文件一样,我们可以将 ViewImports.cshtml 放到一个文件夹中,ViewImports 文件可以影响文件夹层级中的所有视图

View Imports
  • 此视图是此版本 MVC 的新视图,在以前版本的 MVC 中,我们可以使用 XML 配置文件来配置 Razor 视图引擎的某些方面。

  • 那些 XML 文件现在已经不存在了,我们使用代码代替。

  • ViewImports 文件是我们可以编写代码和放置通用指令以引入我们的视图所需的命名空间的地方。

  • 如果我们在视图中经常使用命名空间,我们可以让 using directives 在我们的 ViewImports 文件中出现一次,而不是在每个视图中都使用 using directives 或键入一个类的完整命名空间。


示例

让我们举一个简单的例子来看看如何将我们的 using directives 移动到 ViewImports 中。在 Index 视图中,我们有一个 using directive 来引入命名空间 FirstAppDemo.Controllers,如以下程序所示。

@using FirstAppDemo.Controllers 
@model HomePageViewModel  
@{  
   ViewBag.Title = "Home"; 
} 
<h1>Welcome!</h1> 

<table> 
   @foreach (var employee in Model.Employees) { 
      <tr> 
         <td> 
            @Html.ActionLink(employee.Id.ToString(), "Details", new { id = employee.Id })
         </td> 
         <td>@employee.Name</td> 
      </tr> 
   } 
</table>

Using directives 将允许从 Razor 视图生成的代码正确编译。 如果没有 using directives,C# 编译器将无法找到此 Employee 类型。要查看员工类型,让我们从 Index.cshtml 文件中删除 using 指令。

@model HomePageViewModel 
@{  
    ViewBag.Title = "Home"; 
} 
<h1>Welcome!</h1> 

<table> 
   @foreach (var employee in Model.Employees) { 
      <tr>
         <td>
            @Html.ActionLink(employee.Id.ToString(), "Details", new { id = employee.Id })
         </td> 
         <td>@employee.Name</td> 
      </tr> 
   } 
</table> 

Now, run the application.

Index CSHtml

您将看到一个错误,指出找不到类型或命名空间 HomePageViewModel。这可能是因为您的多个视图需要相同的using directive。因此,我们不要将它放在每个视图中,而是在 Views 文件夹中创建一个视图导入。这将向每个视图添加 using 语句,只需右键单击 Views 文件夹并选择 Add → New Item。

主页模型视图

在中间窗格中,选择 MVC 视图导入页面。 默认情况下,名称为 _ViewImports.cshtml。 就像 ViewStart 一样,我们不能使用此文件来呈现 HTML,因此让我们单击"添加"按钮。

查看导入 Cshtml

现在将 using directive 添加到 _ViewImports.cshtml 文件中,如下所示。

@using FirstAppDemo.Controllers

现在,此文件夹或任何子文件夹中出现的所有视图都可以使用 FirstAppDemo.Controllers 中的类型,而无需指定确切的 using 语句。 让我们再次运行您的应用程序,您可以看到该视图现在正在运行。

FirstAppDemo 控制器