当前位置:首页 > 文章列表 > 文章 > 前端 > Nunjucks 嵌套模板包含与数据传递技巧

Nunjucks 嵌套模板包含与数据传递技巧

2026-05-20 12:18:37 0浏览 收藏
Nunjucks 虽不支持原生的 `{% include "xxx" with {...} %}` 语法,但通过自定义 `render` 过滤器可安全、灵活地实现类似 React 的组件化开发体验——精准传递纯净上下文、严格隔离作用域、支持多层递归嵌套,并兼顾路径解析与 XSS 防护;本文手把手教你注册过滤器、重构模板结构、规避常见陷阱(如宏不可用、异步加载限制),并给出已在 11ty 等生产环境验证的可靠实践,让 Nunjucks 模板真正拥有现代前端般的可维护性与可预测性。

Nunjucks 中实现嵌套模板包含与数据传递的正确方法

Nunjucks 原生不支持 {% include "xxx" with {...} %} 语法,但可通过自定义 render 过滤器安全、递归地传递上下文数据,实现类似 React 的 props 下传效果。本文详解替代方案、代码实现及关键注意事项。

Nunjucks 原生不支持 `{% include "xxx" with {...} %}` 语法,但可通过自定义 `render` 过滤器安全、递归地传递上下文数据,实现类似 React 的 props 下传效果。本文详解替代方案、代码实现及关键注意事项。

在 Nunjucks 中模拟 React 的“组件化 + props 透传”能力,核心挑战在于其 include 标签不支持 with 子句(如 {% include "card.html" with {item: slide} %} 会直接报错 expected block end in include statement)。官方语法仅允许 {% include "template.njk" %},且被包含模板默认继承父模板全部上下文——这既不安全也不灵活,尤其在嵌套层级较深、需隔离/精简传入数据时极易引发变量污染或命名冲突。

✅ 正确解法:注册自定义 render 过滤器
该方案通过 env.render() 手动渲染子模板,并显式传入纯净上下文对象,完全绕过 include 的语法限制,同时保留作用域隔离与类型可控性。

1. 在 Node.js 环境中注册 render 过滤器(推荐在初始化 Nunjucks 时配置):

const nunjucks = require('nunjucks');

const env = nunjucks.configure({
  autoescape: true,
  // 其他配置项...
});

// 注册安全的 render 过滤器
env.addFilter('render', (templatePath, context = {}) => {
  try {
    // 使用 env.render(非 renderString)以支持相对路径和 loader 机制
    return env.filters.safe(env.render(templatePath, context));
  } catch (err) {
    console.error(`Failed to render template "${templatePath}":`, err);
    throw err;
  }
});

⚠️ 注意:务必使用 env.filters.safe() 包裹结果,否则 HTML 内容会被自动转义,导致

显示为文本而非实际标签。

2. 改写原始模板结构(保持语义清晰):

Page 模板(page.html):

{% set slides = [
  { "alt": "Tokenization Visualization", "title": "Tokenization", "description": "The LLM starts by breaking down the input text...", "image": "/img/ai/carousels/how-llm-works/tokenization.png" },
  { "alt": "Embedding Visualization", "title": "Embedding", "description": "Next, each token is converted into a numerical representation...", "image": "/img/ai/carousels/how-llm-works/embedding.png" },
  // ...其余项
] %}

{{ 'partials/image-cards/image-cards.html' | render({ slides: slides }) }}

Image-cards 模板(partials/image-cards/image-cards.html):

<div class="image-cards flex flex-wrap justify-between py-6 ff-inter">
  {% for slide in slides %}
    {{ 'partials/image-cards/image-card.html' | render({
        slide: slide,
        index: loop.index
      }) }}
  {% endfor %}
</div>

Image-card 模板(partials/image-cards/image-card.html):

<div id="item{{ index }}" class="card card-compact w-full md:w-[45%] shrink-0 grow-0s mt-10">
  <figure class="card-figure !mt-0 !mb-0">
    <img src="{{ slide.image }}" alt="{{ slide.alt }}" class="w-full" />
  </figure>
  <div class="card-body !px-0 text-primary-content whitespace-normal">
    <div class="font-semibold mb-0">{{ slide.title }}</div>
    <p>{{ slide.description }}</p>
  </div>
</div>

✅ 优势总结:

  • 作用域隔离:每个 render 调用只接收明确传入的 context,无隐式变量泄漏;
  • 类型安全:IDE 和 Lint 工具可更好校验 slide.title 等字段是否存在;
  • 可递归嵌套:支持多层 render 调用(如 image-card 再 render 一个 caption.html);
  • 路径友好:基于 Nunjucks 的 loader 机制,支持相对路径与模板继承。

⚠️ 注意事项:

  • ❌ render 过滤器无法调用宏(macro) —— 宏必须在当前模板作用域内定义或 import;若需复用逻辑,建议将宏提取为独立模板并用 render 调用;
  • ⚠️ 异步模板加载(如从数据库读取)需扩展 render 为异步过滤器(addAsyncFilter),并配合 async/await 使用;
  • ? 生产环境务必开启 autoescape: true 并始终用 safe() 包裹 render 结果,防止 XSS。

此方案已在多个大型静态站点生成器(如 11ty + Nunjucks)中验证稳定,是目前 Nunjucks 生态下最接近现代组件化开发体验的实践模式。

今天带大家了解了的相关知识,希望对你有所帮助;关于文章的技术知识我们会一点点深入介绍,欢迎大家关注golang学习网公众号,一起学习编程~

搜狗输入法开启手写输入方法搜狗输入法开启手写输入方法
上一篇
搜狗输入法开启手写输入方法
Java 9 Stream.dropWhile 使用详解
下一篇
Java 9 Stream.dropWhile 使用详解
查看更多
最新文章
资料下载
查看更多
课程推荐
  • 前端进阶之JavaScript设计模式
    前端进阶之JavaScript设计模式
    设计模式是开发人员在软件开发过程中面临一般问题时的解决方案,代表了最佳的实践。本课程的主打内容包括JS常见设计模式以及具体应用场景,打造一站式知识长龙服务,适合有JS基础的同学学习。
    543次学习
  • GO语言核心编程课程
    GO语言核心编程课程
    本课程采用真实案例,全面具体可落地,从理论到实践,一步一步将GO核心编程技术、编程思想、底层实现融会贯通,使学习者贴近时代脉搏,做IT互联网时代的弄潮儿。
    516次学习
  • 简单聊聊mysql8与网络通信
    简单聊聊mysql8与网络通信
    如有问题加微信:Le-studyg;在课程中,我们将首先介绍MySQL8的新特性,包括性能优化、安全增强、新数据类型等,帮助学生快速熟悉MySQL8的最新功能。接着,我们将深入解析MySQL的网络通信机制,包括协议、连接管理、数据传输等,让
    500次学习
  • JavaScript正则表达式基础与实战
    JavaScript正则表达式基础与实战
    在任何一门编程语言中,正则表达式,都是一项重要的知识,它提供了高效的字符串匹配与捕获机制,可以极大的简化程序设计。
    487次学习
  • 从零制作响应式网站—Grid布局
    从零制作响应式网站—Grid布局
    本系列教程将展示从零制作一个假想的网络科技公司官网,分为导航,轮播,关于我们,成功案例,服务流程,团队介绍,数据部分,公司动态,底部信息等内容区块。网站整体采用CSSGrid布局,支持响应式,有流畅过渡和展现动画。
    485次学习
查看更多
AI推荐
  • ChatExcel酷表:告别Excel难题,北大团队AI助手助您轻松处理数据
    ChatExcel酷表
    ChatExcel酷表是由北京大学团队打造的Excel聊天机器人,用自然语言操控表格,简化数据处理,告别繁琐操作,提升工作效率!适用于学生、上班族及政府人员。
    4704次使用
  • Any绘本:开源免费AI绘本创作工具深度解析
    Any绘本
    探索Any绘本(anypicturebook.com/zh),一款开源免费的AI绘本创作工具,基于Google Gemini与Flux AI模型,让您轻松创作个性化绘本。适用于家庭、教育、创作等多种场景,零门槛,高自由度,技术透明,本地可控。
    5065次使用
  • 可赞AI:AI驱动办公可视化智能工具,一键高效生成文档图表脑图
    可赞AI
    可赞AI,AI驱动的办公可视化智能工具,助您轻松实现文本与可视化元素高效转化。无论是智能文档生成、多格式文本解析,还是一键生成专业图表、脑图、知识卡片,可赞AI都能让信息处理更清晰高效。覆盖数据汇报、会议纪要、内容营销等全场景,大幅提升办公效率,降低专业门槛,是您提升工作效率的得力助手。
    4945次使用
  • 星月写作:AI网文创作神器,助力爆款小说速成
    星月写作
    星月写作是国内首款聚焦中文网络小说创作的AI辅助工具,解决网文作者从构思到变现的全流程痛点。AI扫榜、专属模板、全链路适配,助力新人快速上手,资深作者效率倍增。
    6869次使用
  • MagicLight.ai:叙事驱动AI动画视频创作平台 | 高效生成专业级故事动画
    MagicLight
    MagicLight.ai是全球首款叙事驱动型AI动画视频创作平台,专注于解决从故事想法到完整动画的全流程痛点。它通过自研AI模型,保障角色、风格、场景高度一致性,让零动画经验者也能高效产出专业级叙事内容。广泛适用于独立创作者、动画工作室、教育机构及企业营销,助您轻松实现创意落地与商业化。
    5301次使用
微信登录更方便
  • 密码登录
  • 注册账号
登录即同意 用户协议隐私政策
返回登录
  • 重置密码