从零实现:PHP 简易模板引擎教程
为了让程序员专注业务逻辑、美工专注页面设计,PHP 模板引擎能将代码与 HTML 分离。本文将通过构建 parser.class.php 和 Templates.class.php 两个核心类,演示如何实现一个简单的模板解析系统,包含变量替换、条件判断、数组遍历、文件包含及简单的缓存功能。
模板引擎的核心思路
一个基础的模板引擎主要解决以下问题:
- 语法转换:将易于编写的自定义标签(如
{ $var })转换为浏览器可执行的 PHP 代码(如<?php echo $var; ?>)。 - 文件隔离:保持模板文件(.tpl)与业务代码文件的物理分离。
- 性能优化:通过预编译和缓存机制,避免每次请求都进行正则解析。
准备工作与环境配置
在开始编码前,需要定义项目的基础目录结构和常量,确保路径清晰。
第 1 步:定义项目根目录配置
新建 templates.php 作为入口文件,定义各个关键目录的路径常量,以便后续使用。
<?php
//设置字符编码UTF-8
header('Content-Type:text/html;charset=utf-8');
//网站根目录
define('ROOT_PATH',dirname(__FILE__));
//存放模版文件夹
define('TPL_DIR',ROOT_PATH.'/Templates/');
//编译文件夹
define('TPL_C_DIR',ROOT_PATH.'/Templates_c/');
//缓存文件夹
define('CACHE',ROOT_PATH.'/Cache/');
//系统变量配置目录
define('CONFIG',ROOT_PATH.'/Config/');
//是否开启缓冲区(用于测试缓存效果)
define('IS_CACHE',false);
//判断是否需要开启缓冲区
IS_CACHE ? ob_start() : null;
//引入模版类
require ROOT_PATH.'/Class/Templates.class.php';
//实例化模版类
$tpl=new Templates();
$tpl->display('index.tpl');
?>
第一步:构建模板解析类 Parser
Parser 类的核心职责是读取模板文件,利用正则表达式匹配自定义语法,并将其“编译”为标准的 PHP 代码。
第 2 步:初始化与变量解析
在构造函数中加载模板内容,并通过 parvar() 方法处理普通变量。
- 语法示例:
<!-- { $name } --> - 转换结果:
<?php echo $this->_vars['name']; ?>
第 3 步:处理条件语句 If-Else
解析 If 块,支持嵌套的 else。需确保模板中使用了闭合标签,否则报错。
- 标签:
<!-- { if $var } -->,<!-- { else } -->,<!-- { /if } --> - 转换逻辑:分别替换为 PHP 的
if(),}else{,}。
第 4 步:处理列表循环 Foreach
解析数组遍历结构,支持提取键和值。
- 标签:
<!-- { foreach $array(key,value) } -->及<!-- {@key} --> - 转换结果:
<?php foreach ($this->_vars['array'] as $key=>$value) { ?>
第 5 步:其他功能与编译输出
此外,还需实现系统配置文件读取(parConfig)、注释处理(parCommon)以及文件包含(parInclude)。最后通过 compile() 方法将所有规则执行完毕,并将最终生成的 PHP 代码写入编译目录。
完整的 parser.class.php 代码如下:
<?php
/**
* 模版解析类
*/
class Parser
{
// 字段,接收模版文件内容
private $_tpl;
// 构造方法,获取模版文件内容
public function __construct($_tplFile)
{
if (! $this->_tpl = file_get_contents($_tplFile)) {
exit('ERROR:模版文件读取错误');
}
}
// 解析普通变量
private function parvar()
{
$_patten = '/<!--\s+\{\$([\w]+)\}\s+-->/';
if (preg_match($_patten,$this->_tpl)) {
$this->_tpl = preg_replace($_patten, "<?php echo \$this->_vars['$1'];?>",$this->_tpl);
}
}
//解析IF语句
private function parif(){
$_pattenif = '/<!--\s+\{if\s+\$([\w]+)\}\s+-->/';
$_pattenElse = '/<!--\s+\{else\}\s+-->/';
$_pattenEndif = '/<!--\s+\{\/if\}\s+-->/';
if (preg_match($_pattenif,$this->_tpl)) {
if (preg_match($_pattenEndif,$this->_tpl)) {
$this->_tpl = preg_replace($_pattenif,"<?php if (\$this->_vars['$1']){?>",$this->_tpl);
$this->_tpl = preg_replace($_pattenEndif,"<?php } ?>",$this->_tpl);
if (preg_match($_pattenElse,$this->_tpl)) {
$this->_tpl = preg_replace($_pattenElse,"<?php }else{?>",$this->_tpl);
}
}else{
echo 'ERROR:IF语句没有关闭!';
}
}
}
//PHP注释解析
private function parCommon(){
$_pattenCommon = '/<!--\s+\{#\}(.*)\{#\}\s+-->/';
if (preg_match($_pattenCommon,$this->_tpl)) {
$this->_tpl = preg_replace($_pattenCommon,"<?php /* $1 */ ?>",$this->_tpl);
}
}
//解析foreach语句
private function parForeach(){
$_pattenForeach = '/<!--\s+\{foreach\s+\$([\w]+)\(([\w]+),([\w]+)\)\}\s+-->/';
$_pattenForeachEnd = '/<!--\s+\{\/foreach\}\s+-->/';
$_pattenForeachValue = '/<!--\s+\{@([\w]+)\}\s+-->/';
if (preg_match($_pattenForeach,$this->_tpl)) {
if (preg_match($_pattenForeachEnd,$this->_tpl)) {
$this->_tpl = preg_replace($_pattenForeach, "<?php foreach (\$this->_vars['$1'] as \$$2=>\$$3) {?>", $this->_tpl);
$this->_tpl = preg_replace($_pattenForeachEnd, "<?php }?>", $this->_tpl);
if (preg_match($_pattenForeachValue, $this->_tpl)) {
$this->_tpl = preg_replace($_pattenForeachValue,"<?php echo \$$1;?>",$this->_tpl);
}
}else{
echo 'ERROR:Foreach语句没有关闭!';
}
}
}
//解析include方法
private function parInclude(){
$_pattenInclude = '/<!--\s+\{include\s+file="([\w\.\-]+)"\}\s+-->/';
if (preg_match($_pattenInclude,$this->_tpl,$_file,$_file)) {
if (!file_exists($_file[1])||empty($_file)) {
echo 'ERROR:包含文件出错!';
}
$this->_tpl = preg_replace($_pattenInclude,"<?php include '$1';?>",$this->_tpl);
}
}
//解析系统变量方法
private function parConfig(){
$_pattenConfig = '/<!--\s+\{([\w]+)\}\s+-->/';
if (preg_match($_pattenConfig,$this->_tpl)) {
$this->_tpl = preg_replace($_pattenConfig,"<?php echo \$this->_config['$1'];?>",$this->_tpl);
}
}
// 对外公共方法
public function compile($_path)
{
// 解析模版文件
$this->parvar();
$this->parif();
$this->parForeach();
$this->parInclude();
$this->parCommon();
$this->parConfig();
// 生成编译文件
if (! file_put_contents($_path, $this->_tpl)) {
exit('ERROR:编译文件生成错误!');
}
}
}
?>
第二步:构建模板管理类 Templates
Templates 类负责初始化环境、管理变量注入、处理编译缓存以及最终的页面渲染。
第 6 步:环境检测与配置加载
在构造函数中,程序会自动检查必要的目录(模板、编译、缓存、配置)是否存在,若不存在则自动创建。同时读取 config.xml 中的全局系统变量存入 _config 数组。
第 7 步:变量注入与显示分发
使用 assign() 方法向模板注入数据。核心在于 display() 方法:
- 查找编译文件:根据模板文件名计算缓存路径。
- 判断缓存有效性:如果开启了缓存且编译文件与缓存文件存在,对比时间戳。若模板未修改,直接输出缓存以提高性能。
- 触发编译:若无有效缓存,实例化
Parser类重新生成编译文件。 - 执行输出:包含(Include)最终的 PHP 编译文件进行渲染。
Templates.class.php 完整代码如下:
<?php
/**
* 模版类
*/
class Templates
{
//注入变量
private $_vars = array();
//保存系统变量数组字段
private $_config = array();
//创建一个构造方法,来检测各个目录是否存在
public function __construct()
{
if (! is_dir(TPL_DIR) || ! is_dir(TPL_C_DIR) || ! is_dir(CACHE) || !is_dir(CONFIG)) {
echo 'ERROR:模版目录或编译目录,缓存目录不存在!自动创建!<br />';
if (!is_dir(TPL_DIR)) {
mkdir(TPL_DIR);
echo '模版目录'.TPL_DIR.'建立'.'<br />';
}
if (!is_dir(TPL_C_DIR)) {
mkdir(TPL_C_DIR);
echo '编译目录'.TPL_C_DIR.'建立'.'<br />';
}
if (!is_dir(CACHE)) {
mkdir(CACHE);
echo '缓存目录'.CACHE.'建立'.'<br />';
}
if (!is_dir(CONFIG)) {
mkdir(CONFIG);
echo '缓存目录'.CONFIG.'建立'.'<br />';
}
exit();
}
//保存系统变量
$_sxe = simplexml_load_file(CONFIG.'/config.xml');
$_tagLib = $_sxe->xpath('/root/taglib');
foreach ($_tagLib as $_tag) {
$this->_config[$_tag->name] = $_tag->value;
}
}
//assign()方法,用于注入变量
public function assign($_var,$_value){
if (isset($_var)&&!empty($_var)) {
$this->_vars[$_var] = $_value;
}else{
exit('ERROR:设置模版变量!');
}
}
//display()方法
public function display($_file)
{
$_tplFile = TPL_DIR . $_file;
// 判断文件是否存在
if (! file_exists($_tplFile)) {
echo 'ERROR:模版文件不存在!自动创建Index.tpl模版文件!';
file_put_contents($_tplFile,'Index');
exit();
}
//生成编译文件
$_path = TPL_C_DIR.md5($_file).'-'.$_file.'.php';
//缓存文件
$_cacheFile = CACHE.md5($_file).'-'.$_file.'.html';
//当第二次运行相同文件,直接载入缓存文件
if (IS_CACHE) {
//判断缓存文件和编译文件都存在
if (file_exists($_cacheFile)&&file_exists($_path)) {
//判断模版文件是否修改过
if (filemtime($_path)>=filemtime($_tplFile)&&filemtime($_cacheFile)>=filemtime($_path)) {
include $_cacheFile;
echo '<!--cache-->';
return;
}
}
}
//当编译文件不存在或者文件发生改变则重新生成
if (!file_exists($_path)||filemtime($_path)<filemtime($_tplFile)) {
require ROOT_PATH.'/Class/parser.class.php';
//构造方法是传入模版文件地址
$_parser = new Parser($_tplFile);
//传入编译文件地址
$_parser->compile($_path);
}
//载入编译文件
include $_path;
if (IS_CACHE) {
//获取缓冲区数据
file_put_contents($_cacheFile,ob_get_contents());
//清楚缓冲区
ob_end_clean();
//载入缓存文件
include $_cacheFile;
}
}
}
?>
第三步:使用模板编写页面
现在我们可以使用自定义语法的 .tpl 文件来编写前端页面,无需关注后端逻辑。
第 8 步:创建 HTML 模板文件
在 Templates/ 目录下新建 index.tpl,展示变量、循环和判断标签的使用方式。
<!DOCTYPE html>
<html lang="zn-cn">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1, user-scalable=no">
<title><!-- {WebName} --></title>
<link rel="stylesheet" type="text/css" href="css/bootstrap.min.css">
</head>
<body>
<!-- 注释区域 -->
<!-- {#}php注释{#} -->
<!-- 条件判断 -->
<!-- {if $a} -->
<p>变量 a 为真</p>
<!-- {else} -->
<p>变量 a 为假</p>
<!-- {/if} -->
<br />
<!-- 数组循环 -->
<!-- {foreach $array(key,value)} -->
<p>Key: <!-- {@key} -->, Value: <!-- {@value} --></p>
<!-- {/foreach} -->
<p>系统变量:<!-- {WebName} --></p>
<p>普通变量:<!-- {$name} --></p>
</body>
</html>
第 9 步:配置全局参数
在 Config/config.xml 中定义全局站点信息:
<?xml version="1.0" encoding="UTF-8"?>
<root>
<taglib>
<name>WebName</name>
<value>我的简易网站</value>
</taglib>
</root>
完成判断与排错
成功运行的标志:访问 templates.php 后,浏览器正确渲染了 HTML 内容,且在 Templates_c/ 目录下生成了对应的 PHP 编译文件。
常见排错:
- 目录权限不足:若发现自动创建目录失败,请检查 Web 服务器(如 Nginx/Apache)用户对根目录是否有写权限。
- 正则不匹配:若变量未显示,检查
.tpl文件中的标签写法是否符合<!-- ... -->格式。 - XML 配置错误:若
_config为空,检查config.xml的 XML 格式是否合法,路径是否正确指向CONFIG目录。
简要总结
通过以上步骤,我们仅用不到两百行代码就实现了一个具备变量赋值、条件分支、循环遍历、注释处理和简单缓存功能的 PHP 模板引擎。虽然这是一个简易版本,但它清晰地展示了现代 MVC 框架中视图层(View)分离技术背后的核心原理。以上就是从零搭建 PHP 简易模板引擎的详细内容,更多关于 PHP 开发技巧的资料请关注本站其它相关文章!
本站声明
本文内容仅供参考,不代表本站观点。转载或引用请注明出处。如发现内容问题,请通过联系我们页面反馈。













