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

雨芳小哥_2256

雨芳小哥_2256

2026-05-10

984人浏览

原创

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="%7B%7B%20slide.image%20%7D%7D" 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 生态下最接近现代组件化开发体验的实践模式。

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
C语言变量命名
C语言变量命名

c语言变量名规则是:1、变量名以英文字母开头;2、变量名中的字母是区分大小写的;3、变量名不能是关键字;4、变量名中不能包含空格、标点符号和类型说明符。php中文网还提供c语言变量的相关下载、相关课程等内容,供大家免费下载使用。

2023.06.20

2909

3

c语言入门自学零基础
c语言入门自学零基础

C语言是当代人学习及生活中的必备基础知识,应用十分广泛,本专题为大家c语言入门自学零基础的相关文章,以及相关课程,感兴趣的朋友千万不要错过了。

2023.07.25

2208

9

c语言运算符的优先级顺序
c语言运算符的优先级顺序

c语言运算符的优先级顺序是括号运算符 > 一元运算符 > 算术运算符 > 移位运算符 > 关系运算符 > 位运算符 > 逻辑运算符 > 赋值运算符 > 逗号运算符。本专题为大家提供c语言运算符相关的各种文章、以及下载和课程。

2023.08.02

1180

5

c语言数据结构
c语言数据结构

数据结构是指将数据按照一定的方式组织和存储的方法。它是计算机科学中的重要概念,用来描述和解决实际问题中的数据组织和处理问题。数据结构可以分为线性结构和非线性结构。线性结构包括数组、链表、堆栈和队列等,而非线性结构包括树和图等。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.09

1118

4

c语言random函数用法
c语言random函数用法

c语言random函数用法:1、random.random,随机生成(0,1)之间的浮点数;2、random.randint,随机生成在范围之内的整数,两个参数分别表示上限和下限;3、random.randrange,在指定范围内,按指定基数递增的集合中获得一个随机数;4、random.choice,从序列中随机抽选一个数;5、random.shuffle,随机排序。

2023.09.05

1316

5

c语言const用法
c语言const用法

const是关键字,可以用于声明常量、函数参数中的const修饰符、const修饰函数返回值、const修饰指针。详细介绍:1、声明常量,const关键字可用于声明常量,常量的值在程序运行期间不可修改,常量可以是基本数据类型,如整数、浮点数、字符等,也可是自定义的数据类型;2、函数参数中的const修饰符,const关键字可用于函数的参数中,表示该参数在函数内部不可修改等等。

2023.09.20

2038

7

c语言get函数的用法
c语言get函数的用法

get函数是一个用于从输入流中获取字符的函数。可以从键盘、文件或其他输入设备中读取字符,并将其存储在指定的变量中。本文介绍了get函数的用法以及一些相关的注意事项。希望这篇文章能够帮助你更好地理解和使用get函数 。

2023.09.20

3220

8

c数组初始化的方法
c数组初始化的方法

c语言数组初始化的方法有直接赋值法、不完全初始化法、省略数组长度法和二维数组初始化法。详细介绍:1、直接赋值法,这种方法可以直接将数组的值进行初始化;2、不完全初始化法,。这种方法可以在一定程度上节省内存空间;3、省略数组长度法,这种方法可以让编译器自动计算数组的长度;4、二维数组初始化法等等。

2023.09.22

14275

6

c语言中null和NULL的区别
c语言中null和NULL的区别

c语言中null和NULL的区别是:null是C语言中的一个宏定义,通常用来表示一个空指针,可以用于初始化指针变量,或者在条件语句中判断指针是否为空;NULL是C语言中的一个预定义常量,通常用来表示一个空值,用于表示一个空的指针、空的指针数组或者空的结构体指针。

2023.09.22

529

3

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
热门推荐
/
最新课程
phpStudy极速入门视频教程
phpStudy极速入门视频教程

共6课时 | 54.6万人学习

独孤九贱(4)_PHP视频教程
独孤九贱(4)_PHP视频教程

共89课时 | 133.4万人学习