首页
/ Nustache - .NET 的无逻辑模板引擎

Nustache - .NET 的无逻辑模板引擎

2024-12-23 19:47:43作者:温艾琴Wonderful

安装指南

通过 NuGet 安装

Nustache 可以通过 NuGet 包管理器进行安装。打开 Visual Studio 的包管理器控制台,输入以下命令:

Install-Package Nustache

如果你使用的是 MVC 项目,还需要安装 Nustache.Mvc3 包:

Install-Package Nustache.Mvc3

通过 GitHub 安装

你也可以从 GitHub 下载源代码并自行编译。步骤如下:

  1. 克隆或下载 Nustache 的 GitHub 仓库。
  2. 使用 Visual Studio 2012 或更高版本打开解决方案文件 Nustache.sln
  3. 编译项目,生成 Nustache.Core.dllNustache.Mvc3.dll(如果需要)。

项目的使用说明

非 MVC 项目

  1. 添加对 Nustache.Core.dll 的引用(如果你通过 NuGet 安装,这一步会自动完成)。
  2. 在代码中导入 Nustache.Core 命名空间。
  3. 使用 Render 类的静态方法来渲染模板。例如:
var html = Render.FileToString("foo.template", myData);
  • myData 可以是对象、IDictionaryDataTable
  • 如果你需要更多的控制,可以使用 Render.Template

MVC 项目

  1. 添加对 Nustache.Mvc3.dll 的引用(如果你通过 NuGet 安装,这一步会自动完成)。
  2. Global.asax.cs 中将 NustacheViewEngine 添加到视图引擎列表中。例如:
ViewEngines.Engines.Add(new NustacheViewEngine());
  1. 参考 Nustache.Mvc3.Example 项目中的 Global.asax.cs 文件获取更多示例。

命令行工具

Nustache 提供了一个命令行工具 nustache.exe,用于从命令行渲染模板。使用方法如下:

nustache.exe foo.template myData.json foo.html
  • foo.template 是模板文件路径。
  • myData.json 是数据文件路径,支持 JSON 或 XML 格式。
  • foo.html 是输出文件路径。

项目 API 使用文档

核心 API

Render.FileToString(string templatePath, object data)

  • 渲染指定路径的模板文件,并返回渲染后的字符串。
  • templatePath:模板文件的路径。
  • data:用于渲染的数据,可以是对象、IDictionaryDataTable

Render.Template

  • 提供更灵活的模板渲染方式。你可以手动加载模板并进行渲染。例如:
var template = new Template();
template.Load(new StringReader(templateText));
var compiled = template.Compile<Foo>(null);

var html = compiled(fooInstance);

MVC API

NustacheViewEngine

  • 用于在 ASP.NET MVC 项目中注册 Nustache 视图引擎。
ViewEngines.Engines.Add(new NustacheViewEngine());

辅助函数(Helpers)

Nustache 支持自定义辅助函数,用于在模板中执行自定义逻辑。例如:

Nustache.Core.Helpers.Register("FormatDateTime", FormatDateTime);

FormatDateTime 函数的实现如下:

static void FormatDateTime(RenderContext context, IList<object> arguments, IDictionary<string, object> options, RenderBlock fn, RenderBlock inverse)
{
    if (arguments != null && arguments.Count > 0 && arguments[0] != null && arguments[0] is DateTime)
    {
        DateTime datetime = (DateTime)arguments[0];
        if (options != null && options.ContainsKey("format"))
            context.Write(datetime.ToString(options["format"] as string));
        else
            context.Write(datetime.ToString());
    }
}

项目安装方式

Nustache 可以通过以下两种方式安装:

  1. NuGet 安装:推荐使用 NuGet 包管理器进行安装,方便快捷。
  2. GitHub 安装:从 GitHub 下载源代码并自行编译,适合需要进行二次开发的用户。

通过以上步骤,你可以轻松安装并使用 Nustache 模板引擎,无论是非 MVC 项目还是 MVC 项目,Nustache 都提供了简单易用的 API 和丰富的功能。

登录后查看全文
热门项目推荐