ThinkPHP模板引擎實作與常見問題

模板引擎由來

早期做PHP開發WEB應用都是把PHP程式碼和HTML模板混在一起，模板引擎的誕生主要就是為了解決後端與前端的完全分離（現在來看其實是屬於不完全分離）的問題，讓開發與美工可以分工合作（雖然實際上最終模板工作大多仍然是由後端開發人員完成），從而提高開發效率和便於維護。

伴隨著PHP的快速成長，模板引擎也越來越多，但大致分為解釋型和編譯型兩種，目前主流的模板引擎大多是編譯型的，也就是會先把模板編譯成PHP檔案執行，只要模板檔本身不變化，就不需要重新編譯，例如老牌的Smarty。解釋型的模板引擎每次執行的時候都會進行模板解析流程，例如小強（tinybutstrong）。

ThinkPHP從一開始就內建了一個基於XML標籤庫技術的編譯型模板引擎，早期參考自Struts，並且不斷在汲取新的思想不斷進化。

如何選擇模板引擎

目前主流框架都帶有模板引擎元件或封裝了模板引擎的實現，因此選擇內建的解決方案是最佳之選，功能和穩定性都有保證。目前最受歡迎的模板引擎當屬Laravel自備的Blade模板引擎，以及Symfony自帶的Twig模板引擎。

透過安裝模板引擎擴展，你可以在ThinkPHP中輕鬆使用包括Angular、Twig和Blade在內的模板引擎，甚至完全不使用模板引擎而是直接用PHP檔案作為模板。

因為近年來三大前端框架（React/Vue/Angular）的流行，前後端分離開發逐漸成為主流，因此從ThinkPHP5.0開始定位為API開發而設計，導致模板引擎的概念已經被弱化了。 ThinkPHP5.1版的模板引擎進行過一次內部的重構，使得模板標籤更易用且接近PHP語法。

至少對於大部分新的應用來說，應該選擇更主流的前後端分離設計，盡量減輕服務端的壓力，也更方便前後端單獨測試。你會在市面上不經意的看到採用Vue和ThinkPHP的產品（之前幾期的ThinkPHP開發者周刊曾經報道過幾個）。如果是維護一些舊專案尤其是內容管理產品的時候，仍然可能會用到模板引擎。

鑑於這種情況，下一個版本的ThinkPHP框架將不會內建模板引擎，但有需要使用模板引擎的開發者仍然可以使用官方獨立出來的think-template類別庫，具體使用可以參考這篇文章。

後面的篇幅，我們主要來總結下ThinkPHP內建的模板引擎的使用和技巧。

範本執行流程

系統內部的範本引擎呼叫關係如下：

视图（View） <=> 模板驱动（Driver） <=> 模板引擎（Template）

檢視和範本引擎之間增加了一個驅動層，所以可以很方便的替換其它的模板引擎。通常我們在控制器中呼叫的assign/fetch等方法其實都是呼叫的think\View類別的方法。當然，如果有必要，你也完全可以直接在控制器中操作模板引擎類，只是不方便切換其它模板引擎。

以fetch方法為例，我們看下最終的呼叫過程：

think\Controller->fetch();
think\View->fetch();
think\view\driver\Think->fetch();
think\Template->fetch();

如果你呼叫fetch方法的時候沒有傳入要渲染的完整模板檔名，則會在第三步的時候自動辨識要渲染的模板檔。

很顯然，最關鍵是最後一步，模板編譯和執行的流程則全部由

think\Template->fetch();

方法完成，這個環節大體又可以分成幾個流程。

1、判斷和讀取頁面渲染快取

如果目前範本設定了頁面輸出快取並且已經渲染輸出過，如果是則會讀取快取中的輸出內容直接輸出。

if (!empty($this->config['cache_id']) && $this->config['display_cache'])
 {
    // 读取渲染缓存
    $cacheContent = $cache->get($this->config['cache_id']);

    if (false !== $cacheContent) {
        echo $cacheContent;
        return;
    }
}

2、定位模板檔案

定位實際的模板檔案操作由模板引擎類別的parseTemplateFile方法實現，這個方法的邏輯其實和視圖驅動類別的parseTemplate方法是類似的，如果最終的模板檔案不存在則會拋出一個模板檔案不存在的例外。

$template = $this->parseTemplateFile($template);

3、判斷編譯快取

如果目前的範本檔案已經編譯過，會判斷快取是否還有效，有效的話就不用重複解析直接讀取快取的解析內容。由checkCache方法負責完成。

if (!$this->checkCache($cacheFile)) {
    // 缓存无效 重新模板编译
    $content = file_get_contents($template);
    $this->compiler($content, $cacheFile);
}

4、模板編譯並快取

這一步驟是模板引擎最核心的環節，也是功能最複雜的地方，由compiler方法負責完成，主要是解析目前模板檔案中的模板標籤語法為PHP可執行程式碼，然後產生一個模板解析快取文件，也就是所謂的模板“編譯”，其中使用了大量的正則表達式替換技術，雖然正則解析有一定的性能開銷，但得益於一次解析多次呼叫的快取原理，基本上模板解析的效能開銷不會影響實際使用的效能。

模板編譯方法的關鍵程式碼是parse方法，parse方法負責對模板檔案中的標籤進行解析，然後寫入編譯緩存文件，編譯快取預設使用的是文件緩存，支援擴充。

5、讀取編譯快取

模板编译的过程只是生成了模板编译缓存文件，并没有真正载入模板，这一步骤就是载入模板编译缓存，然后导入模板变量。实现方法可以参考think\template\driver\File类的read方法。

public function read($cacheFile, $vars = []){
    $this->cacheFile = $cacheFile;

    if (!empty($vars) && is_array($vars)) {
        // 模板阵列变量分解成为独立变量
        extract($vars, EXTR_OVERWRITE);
    }

    //载入模版缓存文件
    include $this->cacheFile;
}

6、缓存页面输出

如果当前模板渲染的时候开启了页面输出缓存，就会这一步生成页面渲染后的输出缓存。

模板编译原理

我们来了解下ThinkPHP的模板引擎的实现原理。前面提到过，ThinkPHP的模板引擎最早源于Struts的设计理念，基于XML和标签库的技术实现。在设计模板语言的时候使用系统固定的标签来实现普通的变量输出功能（所以称之为普通标签），而利用XML标签库技术实现的动态标签用于变量的控制或者条件判断输出。

普通标签的解析是由think\Template类的parseTag方法完成的，主要实现了下面几个模板功能：

变量输出（包括系统变量）；

函数过滤；

变量运算；

三元运算；

执行函数以及输出结果；

模板注释；

标签库采用的是动态扩展的设计方案，采用了类似XML的闭合/开放定义方式（这个其实也是目前模板引擎的一个局限所在），例如下面的这个：

// 闭合类型标签
<tagLib:tagName name="value" >...</tagLib:tagName>
// 开放类型标签
<tagLib:tagName name="value" />

tagLib就代表了一个标签库（类），后面的tagName标签就表示该标签库下面的某个标签（通常对应了标签库类的某个方法），后面的属性就是该标签支持的属性定义。具体该标签的属性和功能则完全由标签库类的这个方法来决定。

可以在模板开头明确指出，当前模板使用了哪些标签库

{taglib name="html,article" /}

所以要扩展模板引擎的功能只需要通过扩展一个标签库类就可以了。大多数的内容管理系统都会定义一套自己的模板二次开发标签，利用标签库功能就可以很方便的定义一套属于自己的标签功能。

系统内置了一套标签库Cx，主要用于文件包含、条件控制、循环输出等功能。内置标签库在使用的时候无需引入，而且在使用的时候可以省略标签库前缀，例如：

{foreach $list as $key=>$vo } 
    {$vo.id}:{$vo.name}{/foreach}

这个模板语法相信PHP开发的很容易上手，上面的标签解析由think\template\taglib\Cx类的tagForeach方法完成，该方法的返回值是一个字符串，其实就是最终会解析成的一段包含变量的PHP可执行代码。

到这里，模板引擎的执行过程和原理现在基本就明白了，剩下的就是模板标签的解析细节，考验的就是正则表达式的掌握程度了。本文就不做深入了，有兴趣的朋友可以去看一些正则表达式的相关资料（例如这本《正则指引》，开发者周刊第14期也提供了一些在线的正则工具）。

遵循的原则

使用模板引擎，要尽量遵循几个重要的原则。

不要在模板文件中添加任何的业务逻辑

模板的作用主要是进行模板变量的控制和输出，不要在模板文件中添加业务逻辑代码。

明确指定渲染模板

养成明确指定渲染模板的好习惯，避免当方法名发生变化，或者被其它方法调用的时候发生错误。也不易受模板命名规范的影响。

变量统一赋值

使用assign方法或者在view助手函数的时候，统一一次传入模板变量。不要多次赋值，以免混乱。

系统变量无需赋值到模板

对于系统变量（包括请求变量、$_SESSION和$_SERVER等系统变量）无需进行模板变量赋值，可以直接在模板中输出。

常见问题

这里总结一下经常会遇到的一些常见问题。

修改定界符

可以通过模板配置文件修改模板标签的定界符。

例如，修改普通标签定界符

'tpl_begin'          => '{{', // 模板引擎普通标签开始标记
'tpl_end'            => '}}', // 模板引擎普通标签结束标记

标签库标签定界符

&#39;taglib_begin&#39;       => &#39;<{&#39;, // 标签库标签开始标记
&#39;taglib_end&#39;         => &#39;}>&#39;, // 标签库标签结束标记

保持原样输出

如果担心模板标签和JS代码产生混淆，可以使用literal标签

{literal} Hello,{$name}！ {/literal}

页面最终会直接输出Hello,{$name}！

避免输出转义

5.1版本为了避免XSS攻击，默认对模板变量的输出使用了安全转义，默认的转义函数是htmlentities，你可以通过更改default_filter配置改变默认的转义函数。

如果你不需要对某个模板变量输出进行转义（例如包含了HTML代码），可以使用：

{$data.content|raw}

分页输出就是一个需要输出HTML的典型例子，因此必须增加|raw。

关于模板主题

新版取消了原来的模板主题功能，因为模板主题对模板引擎来说，其实无非是一个模板目录，完全可以根据自己的需求控制。

例如

$theme = 'blue';$this->fetch('/' . $theme. '/user/index');

或者动态设置模板引擎的view_path参数

$this->view->config('view_path', \think\facade\App::getModulePath(). 'view/'. $theme . '/');

如何关闭模板缓存

由于是编译型模板引擎，模板标签不能被直接执行，必须编译成PHP语法后才能执行，因此不能关闭模板编译缓存，模板引擎每次执行渲染的时候会检测模板文件是否有变化，当模板文件的修改时间超过模板编译缓存的修改时间后，模板引擎会自动更新编译缓存。

但你可以强制模板引擎每次都重新编译，只需要在配置文件中设置

'tpl_cache'          => false, // 关闭模板缓存

使用PHP作为模板引擎

如果不希望使用内置的模板引擎，直接使用PHP作为模板引擎，可以配置

 'type'         => 'php',

配置使用PHP作为模板引擎的话，是不会生成模板编译缓存的。

如何使用第三方模板引擎

系统支持扩展其它的第三方模板引擎，你只需要开发一个模板引擎驱动，目前已经支持的第三方模板引擎包括Smarty、Twig和Blade。

如何跨模块输出模板

要渲染一个跨模块的模板文件，你需要使用

// 渲染user模块的模板文件

$this->fetch('User@order/index');

是否支持变量运算

可以直接在模板文件中进行变量运算而不需要在控制器中进行运算后再赋值都模板变量输出。

{$score1+$score2}
{$count++}

文件包含是否支持变量

include标签可以支持传入变量，但只能使用

{include file="$file" /}

而不能使用

{include file="file_$name" /}

可以支持模板输出替换么

支持两个方式对模板进行输出替换，如果需要对模板文件的内容进行替换，可以配置：

'tpl_replace_string'  =>  [
    '__STATIC__'=>'/static',
'__JS__' => '/static/javascript',
]

如果是对模板渲染输出的内容进行替换，可以在控制器中使用视图过滤功能：

public function index(){
    // 使用视图输出过滤
    return $this->filter(function($content){
    return str_replace("\r\n",&#39;<br/>&#39;,$content);
    })->fetch();
}

模板继承的block是否支持嵌套

目前模板继承的block无法支持嵌套功能，你应该使用其它方式解决。

以上是ThinkPHP模板引擎實作與常見問題的詳細內容。更多資訊請關注PHP中文網其他相關文章！