技术文档：Scriban 使用全攻略

技术文档：Scriban 使用全攻略

scriban A fast, powerful, safe and lightweight scripting language and engine for .NET 项目地址: https://gitcode.com/gh_mirrors/sc/scriban

---

安装指南

Scriban 可通过 NuGet 包管理器轻松获取，确保您的开发环境支持 .NET Standard 2.0 或更高版本。在命令行界面或 Visual Studio 的包管理器控制台中执行以下命令：

Install-Package Scriban

如果您需要签名版本的库，可以选择 Scriban.Signed 包。

对于老版本的 .NET Framework（3.5, 4.0, 4.5）或较旧的 .NET Standard，您应考虑使用 Scriban 2.x 系列，但请注意这可能不再被官方支持。

若您希望直接嵌入源码而非依赖二进制包，从 Scriban 3.2.1 版本起，提供了该选项以适应特定部署需求。

---

项目使用说明

基础模板渲染

Scriban 支持快速模板处理，例如简单的文本替换：

var template = Template.Parse("Hello {{ name }}!");
var result = template.Render(new { name = "World" });
Console.WriteLine(result); // 输出: Hello World!

对 Liquid 模板的支持使得迁移现有项目变得简单：

var template = Template.ParseLiquid("Hello {{ name }}!");
result = template.Render(new { name = "Reader" });
Console.WriteLine(result); // 输出: Hello Reader!

动态脚本示例

Scriban 不仅限于模板渲染，它也可以作为通用的脚本引擎：

var result = Template.Run("return 1 + 2;");
Console.WriteLine(result); // 输出: 3

控制流与变量

复杂逻辑可通过 if、for 循环等实现，例如：

var template = Template.Parse(@"
{{ if products.Count > 0 }}
  <ul>
  {{ for product in products }}
    <li>{{ product.Name }} - {{ product.Price }}</li>
  {{ end }}
  </ul>
{{ else }}
  <p>No products found.</p>
{{ end }}
");
var products = new List<Product> { /* ... */ };
var result = template.Render(new { products });

---

项目API使用文档

解析与渲染

• 解析: 使用 Template.Parse(string) 或 Template.ParseLiquid(string) 来解析模板字符串。
• 渲染: 调用 Render(object model) 或 RenderAsync(object model) 方法来应用模型数据并生成最终结果。

运行时配置

可以通过 TemplateContext 细化控制运行时行为，如启用或禁用特定功能，导入.NET类库函数等。

自定义成员命名规则

若需改变自动转换的命名规则，如将PascalCase转为snake_case，可设置 MemberRenamer 属性。

---

项目安装方式

已详细描述于安装指南部分，主要通过NuGet包 Install-Package Scriban 完成。对于不同的框架选择合适版本，并考虑是否需要签名版本的包。

---

通过此文档，您现在应该能够深入了解Scriban的核心功能，进行安装、使用以及更高级的脚本设计。利用它的灵活性和强大功能，加速您的文本生成和处理任务。对于更多细节，请参考官方GitHub仓库的文档链接。

scriban A fast, powerful, safe and lightweight scripting language and engine for .NET 项目地址: https://gitcode.com/gh_mirrors/sc/scriban