快速入门 10：公共模板和模板布局
最后更新于：2022-04-01 00:18:36
# 快速入门（十）：公共模板和模板布局
我们学习了模板的输出后，就会发现很多应用存在大量的模板文件，如何简化模板文件的定义和公共调用就成了关键，ThinkPHP的模板引擎内置了公共模板和布局模板功能支持，可以方便的规划和公用你的模板文件。
## 公共模板
在当前模版文件中包含其他公用的模版文件使用include标签，标签用法：
~~~
<include file='模版表达式或者模版文件1,模版表达式或者模版文件2,...' />
~~~
### 使用模版表达式
模版表达式的定义规则为：
~~~
模块@主题/控制器/操作
~~~
例如：
~~~
<include file="Public/header" /> // 包含头部模版header
<include file="Public/menu" /> // 包含菜单模版menu
<include file="Blue/Public/menu" /> // 包含blue主题下面的menu模版
~~~
可以一次包含多个模版，例如：
~~~
<include file="Public/header,Public/menu" />
~~~
> 注意，包含模版文件并不会自动调用控制器的方法，也就是说包含的其他模版文件中的变量赋值需要在当前操作中完成。
### 使用模版文件
可以直接包含一个模版文件名（包含完整路径），例如：
~~~
<include file="./Application/Home/View/default/Public/header.html" />
~~~
### 传入参数
无论你使用什么方式包含外部模板，Include标签支持在包含文件的同时传入参数，例如，下面的例子我们在包含header模板的时候传入了title和keywords变量：
~~~
<include file="Public/header" title="ThinkPHP框架" keywords="开源WEB开发框架" />
~~~
就可以在包含的header.html文件里面使用title和keywords变量，如下：
~~~
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>[title]</title>
<meta name="keywords" content="[keywords]" />
</head>
~~~
注意：如果外部模板有所更改，模板引擎并不会重新编译模板，除非在调试模式下或者缓存已经过期。如果部署模式下修改了包含的外部模板文件后，需要把模块的缓存目录清空，否则无法生效。
## 模板布局
有三种布局模板的支持方式：
### 第一种方式：全局配置方式
这种方式仅需在项目配置文件中添加相关的布局模板配置，就可以简单实现模板布局功能，比较适用于全站使用相同布局的情况，需要配置开启`LAYOUT_ON` 参数（默认不开启），并且设置布局入口文件名`LAYOUT_NAME`（默认为layout）。
~~~
'LAYOUT_ON'=>true,
'LAYOUT_NAME'=>'layout',
~~~
开启LAYOUT_ON后，我们的模板渲染流程就有所变化，例如：
~~~
<?php
namespace Home\Controller;
use Think\Controller;
Class UserController extends Controller {
Public function add() {
$this->display('add');
}
}
~~~
在不开启`LAYOUT_ON`布局模板之前，会直接渲染`Home/View/User/add.html` 模板文件,开启之后首先会渲染`Home/View/layout.html` 模板，布局模板的写法和其他模板的写法类似，本身也可以支持所有的模板标签以及包含文件，区别在于有一个特定的输出替换变量`{__CONTENT__}`，例如，下面是一个典型的layout.html模板的写法：
~~~
<include file="Public:header" />
{__CONTENT__}
<include file="Public:footer" />
~~~
读取layout模板之后，会再解析`Home/View/User/add.html` 模板文件，并把解析后的内容替换到layout布局模板文件的`{__CONTENT__}` 特定字符串。
采用这种布局方式的情况下，一旦`Home/View/User/add.html` 模板文件或者`Home/View/layout.html`布局模板文件发生修改，都会导致模板重新编译。
如果需要指定其他位置的布局模板，可以使用：
~~~
'LAYOUT_NAME'=>'Layout/layoutname',
~~~
就表示采用`Home/View/Layout/layoutname.html`作为布局模板。
如果某些页面不需要使用布局模板功能，可以在模板文件开头加上 `{__NOLAYOUT__}` 字符串。
如果上面的`Home/View/User/add.html` 模板文件里面包含有`{__NOLAYOUT__}`，则即使当前开启布局模板，也不会进行布局模板解析。
### 第二种方式：模板标签方式
这种布局模板不需要在配置文件中设置任何参数，也不需要开启**LAYOUT_ON**，直接在模板文件中指定布局模板即可，相关的布局模板调整也在模板中进行。
以前面的输出模板为例，这种方式的入口还是在`Home/View/User/add.html` 模板，但是我们可以修改下add模板文件的内容，在头部增加下面的布局标签（记得首先关闭前面的LAYOUT_ON设置，否则可能出现布局循环）：
~~~
<layout name="layout" />
~~~
表示当前模板文件需要使用`Home/View/layout.html` 布局模板文件，而布局模板文件的写法和上面第一种方式是一样的。当渲染`Home/View/User/add.html` 模板文件的时候，如果读取到layout标签，则会把当前模板的解析内容替换到layout布局模板的`{__CONTENT__}` 特定字符串。
一个模板文件中只能使用一个布局模板，如果模板文件中没有使用任何layout标签则表示当前模板不使用任何布局。
如果需要使用其他的布局模板，可以改变layout的name属性，例如：
~~~
<layout name="newlayout" />
~~~
还可以在layout标签里面指定要替换的特定字符串：
~~~
<layout name="Layout/newlayout" replace="{__REPLACE__}" />
~~~
由于所有include标签引入的文件都支持layout标签，所以，我们可以借助layout标签和include标签相结合的方式实现布局模板的嵌套。例如，上面的例子
~~~
<include file="Public:header" />
<div id="main" class="main" >
{__CONTENT__}
</div>
<include file="Public:footer" />
~~~
在引入的header和footer模板文件中也可以添加layout标签，例如header模板文件的开头添加如下标签：
~~~
<layout name="menu" />
~~~
这样就实现了在头部模板中引用了menu布局模板。
也可以采用两种布局方式的结合，可以实现更加复杂的模板布局以及嵌套功能。
### 第三种方式：使用layout控制模板布局
使用内置的layout方法可以更灵活的在程序中控制模板输出的布局功能，尤其适用于局部需要布局或者关闭布局的情况，这种方式也不需要在配置文件中开启LAYOUT_ON。例如：
~~~
<?php
namespace Home\Controller;
use Think\Controller;
Class UserController extends Controller {
Public function add() {
layout(true);
$this->display('add');
}
}
~~~
表示当前的模板输出启用了布局模板，并且采用默认的layout布局模板。
如果当前输出需要使用不同的布局模板，可以动态的指定布局模板名称，例如：
~~~
<?php
namespace Home\Controller;
use Think\Controller;
Class UserController extends Controller {
Public function add() {
layout('Layout/newlayout');
$this->display('add');
}
}
~~~
或者使用layout方法动态关闭当前模板的布局功能（这种用法可以配合第一种布局方式，例如全局配置已经开启了布局，可以在某个页面单独关闭）：
~~~
<?php
namespace Home\Controller;
use Think\Controller;
Class UserController extends Controller {
Public function add() {
layout(false); // 临时关闭当前模板的布局功能
$this->display('add');
}
}
~~~
三种模板布局方式中，第一种和第三种是在程序中配置实现模板布局，第二种方式则是单纯通过模板标签在模板中使用布局。具体选择什么方式，需要根据项目的实际情况来了。
## 总结
本章主要讲述了如何在模板中调用外部公共模板和使用模板布局简化模板定义，下一篇开始我们会讲述控制器的一些高级特性。