[譯]ASP.NET Core 2.0 檢視引擎

三生石上(FineUI控制元件)發表於2017-11-03
ASP.NET

問題

如何在ASP.NET Core 2.0中使用Razor引擎來建立檢視？

答案

新建一個空專案，修改Startup.cs，新增MVC服務和請求中介軟體：

public void ConfigureServices(IServiceCollection services)
{
	services.AddMvc();
}

public void Configure(IApplicationBuilder app, IHostingEnvironment env)
{
	if (env.IsDevelopment())
	{
		app.UseDeveloperExceptionPage();
	}

	app.UseMvc(routes =>
	{
		routes.MapRoute(
			name: "default",
			template: "{controller=Home}/{action=Index}/{id?}");
	});
}　　

新增Controllers目錄，並新增HomeController控制器：

public class HomeController : Controller
{
	public IActionResult Index()
	{
		return View();
	}
}

新增Views/Home目錄，並新增Razor檢視Index.cshtml：

@{
    var birthDate = new DateTime(1930, 8, 26);
}

<strong>Hello MVC Razor</strong>

<p>James Bond, you were born @birthDate.ToString("yyyy-MM-dd")</p>

<p>James Bond is about @((DateTime.Now - birthDate).Days / 365) years old</p>

<p>@("<strong>Hello World</strong>")</p>

<p>@Html.Raw("<strong>james@bond.com</strong>")</p>

@{
    var isHungry = true;
    var gender = 0;
    IEnumerable<string> friends = new[] { "Thor", "Hulk", "Iron Man" };
    var technology = "asp.net mvc";
    var count = technology.Count();
}

<p>
    @if (isHungry)
    {
        <text>I'm hungry</text>
    }
    else
    {
        <text>I'm full</text>
    }
</p>


@switch (gender)
{
    case 0:
        <p>Male</p>
        break;
    case 1:
        <p>Female</p>
        break;
    default:
        break;
}

@for (int i = 0; i < technology.Length; i++)
{
    @technology[i].ToString().ToUpper()
}

<ul>
    @foreach (var item in friends)
    {
        <li>@item</li>
    }
</ul>

@try
{
    var a = 1; var b = 0;
    var result = a / b; // divide by zero
}
catch (Exception ex)
{
    <p>@ex.Message</p>
}

此時的目錄結構如下所示：

執行，此時頁面顯示：

討論

當控制器返回ViewResult時，ASP.NET Core中介軟體會查詢並執行Razor模板（.cshtml檔案）。Razor模板使用C#和HTML的混合語法來生成最終的HTML頁面。

查詢檢視

當ViewResult執行時，它會按照如下順序查詢檢視所在路徑：

1. Views/[Controller]/[Action].cshtml

2. Views/Shared/[Action].cshtml

如果模板檔名和控制器方法的名稱不一致，可以在ViewResult中透過引數來指定檢視模板的名稱：

public IActionResult AboutMe()
{
	return View("Bio");
}　

Razor語法

HTML標籤會原封不動的渲染到最終的HTML頁面中：

<strong>Hello MVC Razor</strong>　　

透過@符號從HTML過渡到C#程式碼。C#程式碼塊可以用如下結構包含起來：

@{
    var birthDate = new DateTime(1930, 8, 26);
}　　

C#表示式可以直接透過@符號來輸出到最終HTML頁面：

<p>James Bond, you were born @birthDate.ToString("yyyy-MM-dd")</p>

或者用@( //C#表示式 )來包含起來：

<p>James Bond is about @((DateTime.Now - birthDate).Days / 365) years old</p>

Razor預設會對C#表示式進行HTML編碼，觀察下面的Razor程式碼以及生成到頁面上的HTML結構：

<p>@("<strong>Hello World</strong>")</p>
<p>&lt;strong&gt;Hello World&lt;/strong&gt;</p>

@Html.Raw可以避免C#表示式被HTML編碼，如下所示：

<p>@Html.Raw("<strong>james@bond.com</strong>")</p>

<p><strong>james@bond.com</strong></p>

　　　　

控制結構

Razor檢視中，我們可以在C#程式碼塊中使用各種控制結構，比如@if, @switch, @for, @foreach, @while, @do while和@try。具體示例可以檢視Views/Home/Index.cshtml程式碼。

指令

Razor檢視會被轉化為繼承自RazorPage的C#類（內部實現，對使用者透明）。而指令可以改變這些類或者檢視引擎的行為。常用的指令有：

@using

向生成的C#類新增一個using指令。類似於普通的C#類，這個指令用來匯入名稱空間。

@model

指定傳入RazorPage的泛型型別T。當控制器返回ViewResult時，可以透過引數來指定模型型別。然後在檢視頁面中透過Model屬性來獲取模型例項。

 @inject

用來向檢視注入服務（首先需要在Startup中在服務容器中註冊此服務）。你需要提供服務型別和名稱（檢視中透過此名稱訪問服務）。檢視的依賴注入用於為檢視提供強型別的資料查詢服務，否則我們就需要動態的ViewData或者ViewBag屬性來實現。

檢視的依賴注入

下面透過一個較完整的示例來講解@using，@model和@inject指令的用法。

首先建立一個服務：

public interface IGreeter
{
	string Greet(string firstname, string surname);
}

public class Greeter : IGreeter
{
	public string Greet(string firstname, string surname)
	{
		return $"Hello {firstname} {surname}";
	}
}　

在Startup的服務容器中註冊此服務：

public void ConfigureServices(IServiceCollection services)
{
	services.AddScoped<IGreeter, Greeter>();

	services.AddMvc();
}

建立一個模型：

public class AboutViewModel
{
	public string Firstname { get; set; }
	public string Surname { get; set; }
}

從控制器方法中返回模型例項：

public class HomeController : Controller
{
	public IActionResult Index()
	{
		return View();
	}

	public IActionResult AboutMe()
	{
		var model = new AboutViewModel
		{
			Firstname = "Tahir",
			Surname = "Naushad"
		};
		return View("Bio", model);
	}
}

現在我們可以在檢視中使用模型和服務了：

@using RazorEngine.Models
@model AboutViewModel
@inject IGreeter GreeterService

<p>@GreeterService.Greet(Model.Firstname, Model.Surname)</p>

執行，此時頁面顯示：

原始碼下載

 

原文：https://tahirnaushad.com/2017/08/23/asp-net-core-2-0-mvc-razor/

 

相關文章