RazorEngineCore 使用教程

2026-01-18 10:13:22作者：秋泉律Samson

项目介绍

RazorEngineCore 是一个基于 .NET 的开源模板引擎，它允许开发者使用 Razor 语法来动态生成内容。Razor 是一种简洁的标记语法，最初由 ASP.NET MVC 引入，现在广泛用于各种 .NET 应用中。RazorEngineCore 提供了对 Razor 语法的完整支持，并且易于集成到任何 .NET 项目中。

项目快速启动

安装

首先，通过 NuGet 安装 RazorEngineCore：

dotnet add package RazorEngineCore

基本使用

以下是一个简单的示例，展示如何使用 RazorEngineCore 渲染模板：

using RazorEngineCore;

class Program
{
    static void Main(string[] args)
    {
        IRazorEngine razorEngine = new RazorEngine();
        IRazorEngineCompiledTemplate template = razorEngine.Compile("Hello @Model.Name!");

        string result = template.Run(new
        {
            Name = "World"
        });

        Console.WriteLine(result); // 输出: Hello World!
    }
}

应用案例和最佳实践

动态生成电子邮件内容

RazorEngineCore 常用于动态生成电子邮件内容。以下是一个示例：

string template = @"
    <html>
        <body>
            <h1>Welcome, @Model.UserName!</h1>
            <p>Thank you for registering. Your confirmation code is: @Model.ConfirmationCode.</p>
        </body>
    </html>";

IRazorEngine razorEngine = new RazorEngine();
IRazorEngineCompiledTemplate emailTemplate = razorEngine.Compile(template);

string emailContent = emailTemplate.Run(new
{
    UserName = "JohnDoe",
    ConfirmationCode = "123456"
});

Console.WriteLine(emailContent);

生成动态报告

RazorEngineCore 也可以用于生成动态报告：

string reportTemplate = @"
    <h1>Sales Report</h1>
    <ul>
        @foreach (var item in Model.Items)
        {
            <li>@item.Name: @item.Amount</li>
        }
    </ul>";

IRazorEngine razorEngine = new RazorEngine();
IRazorEngineCompiledTemplate reportTemplate = razorEngine.Compile(reportTemplate);

string reportContent = reportTemplate.Run(new
{
    Items = new[]
    {
        new { Name = "Product A", Amount = 100 },
        new { Name = "Product B", Amount = 200 }
    }
});

Console.WriteLine(reportContent);

典型生态项目

ASP.NET Core

RazorEngineCore 可以与 ASP.NET Core 项目集成，用于动态生成视图内容。以下是一个简单的集成示例：

public class HomeController : Controller
{
    public IActionResult Index()
    {
        IRazorEngine razorEngine = new RazorEngine();
        IRazorEngineCompiledTemplate template = razorEngine.Compile("Hello @Model.Name!");

        string result = template.Run(new
        {
            Name = "World"
        });

        return Content(result, "text/html");
    }
}