ThinkPHP テンプレート エンジンの実装と一般的な問題

テンプレート エンジンの起源

PHP による WEB アプリケーション開発の初期には、PHP コードと HTML テンプレートが混在していました。バックエンドとフロントエンドの完全な分離（実際には不完全な分離であるようですが）の問題により、開発とアーティストが分業して協力できるようになります（ただし、実際には、最終的なテンプレート作業のほとんどはまだ完了しています）バックエンド開発者による）により、開発効率が向上し、メンテナンスが容易になります。

PHP の急速な成長に伴い、テンプレート エンジンはますます増えていますが、大きく分けてインタプリタ型とコンパイル型の 2 種類に分かれており、現在主流のテンプレート エンジンのほとんどはコンパイル型です。テンプレートはPHPファイルにコンパイルされて実行されるため、テンプレートファイル自体を変更しない限り、旧Smartyのように再コンパイルする必要はありません。 tinybutstrong など、解釈されたテンプレート エンジンは、実行されるたびにテンプレート解析プロセスを実行します。

ThinkPHP は、XML タグ ライブラリ技術をベースとしたコンパイル済みテンプレート エンジンを最初から内蔵しており、Struts から早期に参照され、新しいアイデアを吸収して常に進化しています。

テンプレート エンジンの選択方法

現在主流のフレームワークにはテンプレート エンジン コンポーネントが付属しているか、テンプレート エンジンの実装がカプセル化されているため、組み込みソリューションを選択するのが最善です機能性と安定性が保証されています。現在、最も人気のあるテンプレート エンジンは、Laravel 独自の Blade テンプレート エンジンと Symfony 独自の Twig テンプレート エンジンです。

テンプレート エンジン拡張機能をインストールすると、ThinkPHP で Angular、Twig、Blade などのテンプレート エンジンを簡単に使用したり、テンプレート エンジンをまったく使用せずに PHP ファイルを直接テンプレートとして使用したりできます。

近年、3大フロントエンドフレームワーク(React/Vue/Angular)の人気により、フロントエンドとバックエンドを分けて開発することが徐々に主流になってきており、ThinkPHP5.0ではAPI 開発に位置付けられ、テンプレート エンジンの概念が弱体化されました。 ThinkPHP バージョン 5.1 のテンプレート エンジンは内部的に再構築され、テンプレート タグが使いやすくなり、PHP 構文に近づきました。

少なくともほとんどの新しいアプリケーションでは、サーバーへの負荷を可能な限り軽減し、フロントエンドとバックエンドのテストを容易にするために、より主流のフロントエンドとバックエンドの分離設計を選択する必要があります。別々に。市場では Vue や ThinkPHP を使用した製品を偶然目にすることがあります (ThinkPHP Developer Weekly の前号でいくつかの製品が報告されています)。古いプロジェクト、特にコンテンツ管理製品を保守している場合は、引き続きテンプレート エンジンを使用する可能性があります。

この状況を考慮して、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 メソッドを呼び出すときにレンダリングされる完全なテンプレート ファイル名を渡さなかった場合, 3 番目の「実行中にレンダリングされるテンプレート ファイルを自動的に識別する」ステップに表示されます。

明らかに、最も重要なステップは最後のステップです。テンプレートのコンパイルと実行のプロセスは、すべて

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. テンプレートのコンパイルとキャッシュ

このステップは、テンプレート エンジンのコア リンクであり、最も複雑な機能です。主に現在のテンプレート ファイルを解析するコンパイラ メソッドによって完了します。テンプレート タグの構文は 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 中国語 Web サイトの他の関連記事を参照してください。