當前位置：首頁 > 编程资源 > 编程问答 >内容正文

编程问答

Handlebars partials 隐藏的力量

發布時間：2025/3/20 编程问答 36 豆豆

生活随笔收集整理的這篇文章主要介紹了 Handlebars partials 隐藏的力量小編覺得挺不錯的,現在分享給大家,幫大家做個參考.

一個項目的機會再加上我自己的探索，讓我對Handlebars partials有了更深的理解。事實證明，你可以做得比我了解的更多。

我最近在負責一個小項目，只有很少的靜態頁面。因為太小了，我們最開始沒有使用模板系統。當項目開始往深一層推進時，我們發現把靜態頁面拆分成partials & layout的模板明顯更好。

我們以前用過handlebars-layouts并且很喜歡它提供的那些特性。我本來想同時安裝Handlebars和handlebars-layouts，但是又感覺過于累贅了。

我在想有沒有可能只使用Handlebars而不用額外的handlebars-layouts庫？

我并不是想吐槽handlebars-layouts，我們以后可能還會用到這個項目。但是我想試試只用Handlebars partials來實現一些handlebars-layouts通過helper來實現的一些特性。

花了一些時間來評估項目需求后我問自己：handlebars-layouts helpers提供的哪些特性是我需要的？根據過去的經驗，我列出了如下helpers：

{{#extend}} layouts的能力
{{#embed}} partials的能力
能像{{#block}} 和 {{#content}}一樣配合

列出來后，我開始查Handlebars partials文檔來看看行不行。然后我發現我從來沒有利用到partials的全部潛力，只要做一點小小的努力就可以讓它們實現我的需求。有兩個特性吸引了我：partial blocks和inline partials。

我興奮地意識到Handlebars partials可以做到比我想象中多得多的事情并馬上開始了工作。

Partials基礎

在開始前，還是先看一看基本partials, partial blocks 和 inline partials。

基本partials就像這樣：

它會試圖找到一個命名為content-block的partial進行渲染，否則就報錯。

Handlebars partial的文檔上寫：

The normal behavior when attempting to render a partial that is not found is for the implementation to throw an error. If failover is desired instead, partials may be called using the block syntax.

渲染一個partial的默認行為是，如果沒找到就報錯。如果要進行錯誤處理，就要用block的方式來使用。

partial block就像這樣：

{{#> content-block}}Default content {{/content-block}}

這樣寫有一個好處，就是當content-block沒有找到時，partial block里面的部分就會被渲染，像上面就會渲染“Default content”。

而inline partial就像這樣：

{{#*inline "content-block"}}My new content {{/inline}}

文檔里是這樣說的：

Templates may define block scoped partials via the inline decorator.

通過使用inline修飾符，可以在模板中定義塊級partials。

inline partial允許你臨時創建partials。如果頁面中有一個content-block partial block，然后我們創建了content-block inline partial的話，inline partial中的內容(“My new content”) 就會替換partial block中默認內容。inline partial同樣可以替換基本partials，只是基本partials沒有默認內容而已。

了解完這些后我們就可以開始了。

目錄結構

我想同時擁有layouts/、includes/和pages/，目錄結構看起來如下：

src/ ├── pages │ ├── page-one.hbs │ └── page-two.hbs └── partials├── includes│ ├── hero.hbs│ └── footer.hbs└── layouts└── base.hbs

為了進行渲染使用了Gulp + gulp-compile-handlebars，在htmlgulp任務中把src/pages/*.hbs當成source目錄，就像下面這樣：

// gulpfile.jsconst handlebars = require('gulp-compile-handlebars'); const rename = require('gulp-rename');gulp.task('html', () => {return gulp.src('./src/pages/*.hbs').pipe(handlebars({}, {ignorePartials: true,batch: ['./src/partials']})).pipe(rename({extname: '.html'})).pipe(gulp.dest('./dist')); });

需要注意，我們口中的“page”, “include”和“layout”，本質上都是Handlebars partial，這就是保證可擴展性的關鍵。一旦了解了這個，新世界的大門就打開了。

Layouts, pages 和 includes

再來分別看看每個文件：

Layouts 文件

首先是layouts/base.hbs：

{{!-- layouts/base.hbs --}}<!doctype html> <html><head><title>{{#if title}}{{title}}{{else}}Base Page Title{{/if}}</title><link rel="stylesheet" href="main.css">{{#> head-block}}{{!-- Custom <head> content per page could be added. --}}{{/head-block}}</head><body>{{#> hero-block}}{{!-- Hero content goes here. --}}{{/hero-block}}<footer>{{#> footer-block}}{{!--The `includes/footer` partial is the default content,but can be overridden.--}}{{> includes/footer }}{{/footer-block}}</footer>{{#> scripts-block}}{{!-- Custom scripts per page can be added. --}}{{/scripts-block}}</body> </html>

有些值得注意的地方，拆開來單獨看：

引入了一個虛構的main.css。然后設置了head-block，當一個具體的page繼承此layout時在這里傳入<head>中的內容(注：就跟handlebars-layouts的{{#block}} helper一樣)。

{{#> hero-block}}{{!-- Hero content goes here. --}} {{/hero-block}} {{#> scripts-block}}{{!-- Custom scripts per page can be added. --}} {{/scripts-block}}

跟head-block一樣，我們在hero和scripts部分都用了Handlebars partial blocks。在同一套模板有不同的內容和scripts的時候，顯得更加靈活。

<footer>{{#> footer-block}}{{!--The `includes/footer` partial is the default content,but can be overridden.--}}{{> includes/footer }}{{/footer-block}} </footer>

footer部分我們又用了Handlebars partial block，不同的是我們用了{{> includes/footer }}基本partial來指定默認內容。

當footer-block沒有被傳入內容時就會渲染默認內容。所有代碼中，我們都用的Handlebars注釋(注：這些注釋不會被渲染到HTML中，如果你用HTML注釋就會被渲染到HTML中，因為partial block中所有內容都會被渲染)。

page 文件

拼圖的下一部分就是page partial。我們也用到了Handlebars partial blocks，同時還有Handlebars inline partials，下面是pages/page-one.hbs的示例：

{{!-- pages/page-one.hbs --}}{{#> layouts/base title="Page One" }}{{#*inline "hero-block"}}{{> includes/herohero-src="img/hero-1.png"hero-alt="Hero 1 alt title"}}{{/inline}}{{/layouts/base}}

同樣拆開來看看：

{{#> layouts/base title="Page One" }}... {{/layouts/base}}

這里又用到了Handlebars partial block。但是這次，我們用它來繼承layouts/base（注：就跟handlebars-layouts {{#extend}} helper一樣），同時設置了page的title（注：用到了partial 參數特性）。

{{#*inline "hero-block"}}... {{/inline}}

這是我們第一次用到Handlebars inline partial。這個inline partial被傳入layouts/base然后被其中的hero-block注入（注：用法就跟 handlebars-layouts 的 {{#content}} helper 一樣）。

{{> includes/herohero-src="http://fpoimg.com/500x200"hero-alt="Hero 1 alt title" }}

最后我們引入indludes/hero基本partial（注：就跟handlebars-layouts {{#embed}} helper一樣）。

includes 文件

includes/*.hbs可以被layouts 和 pages引用。既然都用到了，那就看看大概是什么樣子的：

{{!-- includes/hero.hbs --}}<div class="hero"><img src="{{hero-src}}" alt="{{hero-alt}}"/> </div>

沒什么開創性的東西，只是簡單地渲染傳入的hero-src 和 hero-alt（注：可以改進的地方：用{{#if}}{{else}}來判斷參數是否為空）。

再看看includes/footer.hbs：

{{!-- includes/footer.hbs --}}<p>This is some default footer content.</p>

沒啥特別的，這就是layouts/base中footer的默認內容。

最后成果

來概括一下所有東西。

layouts/base.hbs

充當基礎layout文件
使用partial blocks定義默認和動態內容

pages/page-one.hbs

充當page文件
使用partial block來繼承基本layout
使用inline partials填充內容到layout中的 partial blocks

includes/*.hbs

partials可以被 layouts 或 pages 引用
可以在partial block或inline partial中使用

然后就是最后渲染出的page-one.html文件，看起來就是這樣：

<!doctype html> <html><head><title>Page One</title><link rel="stylesheet" href="main.css"></head><body><div class="hero"><img src="http://fpoimg.com/500x200" alt="Hero 1 alt title"/></div><footer><p>This is some default footer content.</p></footer></body> </html>

讓我們再試試使用同一個layout，但改一些東西，就叫它pages/page-two.hbs好了：

{{!-- pages/page-two.hbs --}}{{#> layouts/base title="Page Two" }}{{!-- Let's add a second stylesheet for this layout. --}}{{#*inline "head-block"}}<link rel="stylesheet" href="some-other-styles.css">{{/inline}}{{!-- Let's change the hero image for this layout. --}}{{#*inline "hero-block"}}{{> includes/herohero-src="http://fpoimg.com/400x400"hero-alt="Hero 2 alt title"}}{{/inline}}{{!-- Let's override the "footer-block" content. --}}{{#*inline "footer-block"}}<p>We are now overriding the default "footer-block" content with this content.</p>{{/inline}}{{!-- Let's add a script for this layout. --}}{{#*inline "scripts-block"}}<script src="new-script.js"></script>{{/inline}}{{/layouts/base}}

渲染出來就是這樣：

<!doctype html> <html><head><title>Page Two</title><link rel="stylesheet" href="main.css"><link rel="stylesheet" href="some-other-styles.css"></head><body><div class="hero"><img src="http://fpoimg.com/400x400" alt="Hero 2 alt title"/></div><footer><p>We are now overriding the default "footer-block" content with this content.</p></footer><script src="new-script.js"></script></body> </html>

這樣我們就用同一個layout渲染出了兩個不同的頁面。

感謝

我們用Handlebars 的partial blocks, inline partials, basic partials 和partial parameters模擬出了handlebars-layouts的{{#extend}, {{#embed}}, {{#block}} 和 {{#content}} helpers。

這是一次有趣的嘗試，讓我更好地理解了Handlebars partials。注意在不同的項目中，我們必須先評估庫提供的特性，有哪些是需要的，哪些是不需要的，沒有一個完美的解決方案（注：有些特性是無法模擬的，比如 {{#content}} 的 append 和 prepend，又比如content作subexpression時，用conditonal blocks 檢查content是否為空）。

如果你想要了解更多，可以看看這個項目，試試各種組合，看看能不能挖掘出更多的Handlebars partials的潛力。

總結

以上是生活随笔為你收集整理的Handlebars partials 隐藏的力量的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。