首頁 > 軟體

go開源Hugo站點渲染之模板詞法解析

2023-02-25 06:01:31

正文

Deps在準備好NewPathSpec,NewSpec,NewContentSpec,NewSourceSpec後,呼叫onCreate正式建立HugoSites,並在最後一步,載入模板執行器。

模板執行器只是提前將模板資訊轉換成了模板執行器,如何使用並沒有涉及到。

為了讓我們對模板生命週期有更全面的瞭解,讓我們以robots.txt為例,來看看是如何通過模板執行器生成最終檔案的。

瞭然於胸 - newTemplateExec時序圖 

從時序圖中,可以瞭解到建立執行器,主要分兩步。

先建立包含了各種功能函數的executor。 其中的功能函數由兩部分組成,一部分來自hugo,像htmlEscape等。 另一部分來自於golang的內建函數,如fmt.Sprint等等。 正是因為有這些功能函數的支援,才得以讓模板的action塊 - ‘{{}}‘功能如此強大。

執行器建立好後,接下來就要建立模板的handler了。 處理器提供了模板載入、查詢等相關的服務,以方便使用。 因為查詢服務依賴於載入服務,所以在處理器範例後,緊接著就是載入模板了。 而模板又分兩部分,一部分是由hugo提供的預設模板,像robot.txt等。 另一部分就是由使用者所提供的layouts檔案,有來於主題的,也有來於使用者自定義的layout。

載入的是磁碟檔案,得到的是解析過後的模板範例。

templ, err := prototype.New(info.name).Parse(info.template)

原始碼裡用的是prototype,而不是直接用的html。 這是因為我們的模板有兩種字尾,一種是txt,另一種是html,需要找到相應的原型來對模板進行解析。

不管是什麼模板,都是文字,HTML也不例外,也是文字。 HTML模板的原始碼也應證了這一點 - 直接呼叫文字模板的方法。 那這種關係是如何用程式碼實現的呢?

拿到模板位元組資訊後,用詞法分析器對模板位元組流進行解析,得到分析好的詞義結構。 對於HTML模板而言,為了安全,需要對詞義結構進行檢查和必要地修改。 因為我們可以從不同渠道,獲得不同的主題,這些主題中又包含了很多模板,並且主題中可以巢狀主題,為了保證安全,避免執行惡意程式碼。 最後就是執行解析好的模板。

為了方便理解,我們來舉個例子 - robot.txt模板使用流程:

  • 查詢:通過名字查詢,呼叫templateExec中的handler查詢方法LookupLayout進行查詢。
  • 執行:準備執行模板所需要的資訊,呼叫templateExec中的executor執行方法ExecuteWithContext開始執行。 這裡的執行方法實際上也是由text template提供的,前面咱們也提到了,不管是什麼型別的模板,都是以text為基礎的。

知道了工作流程後,讓我們從原始碼層面,更深入的對Template進行理解。

我們先來看第一步: 模板解析。

詞法解析 - parse 

建立Deps的最後一步是loadResources,其中主要指的是Template資源。 在建立templateExec範例的過程中,就需要載入hugo預設和使用者建立的模板。 載入模板後,獲取了模板的位元組資訊,要想為我們所有,首先要讀懂這些位元組,這時,我們就用到了解析Parse,而且是由text模板提供的。 Parse為什麼可以讀懂這些字元資訊呢,她依靠的是內部了詞法分析器lex - lexer,分析器需要對action block的語意有充分的理解。 讀懂後轉換為方便後續操作的資料結構tree,在hugo中實際載體是listNode型別。

我們拿一段模板舉個例子:

從上例中,我們可以看到,左上方是輸入的資訊。 包含一篇部落格 - post.md,和一個模板 - single.html。 通過轉換會得到最右邊的輸出網頁內容。 其中,包含在模板中第一行的資訊,剩下的是由部落格提供的資訊,其中的特殊字元,還被進行了跳脫。

在左下方第一步中,建立templateExec過程中,讀取到了模板single.html。 通過解析,利用詞法分析器,會得到如下狀態:

[「<p><!-- HT…」, 「{{」, 「 「, 」.Content」, 」 「, 」}}」, EOF]

為了理解其中的工作原理,讓我們在下一章節中一起來看一下action block的詞法分析器是如何工作的。

以上就是go開源Hugo站點渲染之模板詞法解析的詳細內容,更多關於Hugo站點渲染模板詞法的資料請關注it145.com其它相關文章!


IT145.com E-mail:sddin#qq.com