curl -sS https://getcomposer.org/installer | php
mv composer.phar /usr/local/bin/composer


composer create-project topthink/think tp
composer require topthink/think-view
composer require topthink/think-captcha
composer require topthink/think-helper

安装稳定版

如果你是第一次安装的话，在命令行下面，切换到你的WEB根目录下面并执行下面的命令：

composer create-project topthink/think tp

这里的tp目录名你可以任意更改，这个目录就是我们后面会经常提到的应用根目录。

如果你之前已经安装过，那么切换到你的应用根目录下面，然后执行下面的命令进行更新：

composer update topthink/framework

安装和更新命令所在的目录是不同的，更新必须在你的应用根目录下面执行

如果出现错误提示，请根据提示操作或者参考Composer中文文档。

安装开发版

一般情况下，composer 安装的是最新的稳定版本，不一定是最新版本，如果你需要安装实时更新的版本（适合学习过程），可以安装8.0.x-dev版本。

composer create-project topthink/think=8.0.x-dev tp

开启调试模式

应用默认是部署模式，在开发阶段，可以修改环境变量APP_DEBUG开启调试模式，上线部署后切换到部署模式。

本地开发的时候可以在应用根目录下面定义.env文件。

通过create-project安装后在根目录会自带一个.example.env文件（环境变量示例），你可以直接更名为.env文件并根据你的要求进行修改，该示例文件已经开启调试模式

测试运行

现在只需要做最后一步来验证是否正常运行。

进入命令行下面，执行下面指令

php think run

在浏览器中输入地址：

http://localhost:8000/

视图

视图功能由\think\View类配合视图驱动（也即模板引擎驱动）类一起完成，新版仅内置了PHP原生模板引擎（主要用于内置的异常页面输出），如果需要使用其它的模板引擎需要单独安装相应的模板引擎扩展。

如果你需要使用think-template模板引擎，只需要安装think-view 模板引擎驱动。

composer require topthink/think-view

安装验证码支持

composer require topthink/think-captcha

验证码

安装

首先使用Composer安装think-captcha扩展包：

composer require topthink/think-captcha

验证码库需要开启Session才能生效。

使用

扩展包内定义了一些常见用法方便使用，可以满足大部分常用场景，以下示例说明。

在模版内添加验证码的显示代码

<div>{:captcha_img()}</div>

或者

<div><img src="{:captcha_src()}" alt="captcha" /></div>

上面两种的最终效果是一样的，根据需要调用即可。

然后使用框架的内置验证功能（具体可以参考验证章节），添加captcha验证规则即可

$this->validate($data,[
    'captcha|验证码'=>'require|captcha'
]);

如果没有使用内置验证功能，则可以调研内置的函数手动验证

if(!captcha_check($captcha)){
 // 验证失败
};

如果是多应用模式下，你需要自己注册一个验证码的路由。

Route::get('captcha/[:config]','\\think\\captcha\\CaptchaController@index');

配置

Captcha类带有默认的配置参数，支持自定义配置。这些参数包括：

直接在应用的config目录下面的captcha.php文件中进行设置即可，例如下面的配置参数用于输出4位数字验证码。

return [
    'length'    =>  4,
    'codeSet'   =>  '0123456789',
];

自定义验证码

如果需要自己独立生成验证码，可以调用Captcha类（think\captcha\facade\Captcha）操作。

在控制器中使用下面的代码进行验证码生成：

<?php
namespace app\index\controller;

use think\captcha\facade\Captcha;

class Index 
{
	public function verify()
    {
        return Captcha::create();    
    }
}

然后访问下面的地址就可以显示验证码：

http://serverName/index/index/verify

输出效果如图

通常可以给验证码地址注册路由

Route::get('verify','index/verify');

在模板中就可以使用下面的代码显示验证码图片

<div><img src="{:url('index/verify')}" alt="captcha" /></div>

可以用Captcha类的check方法检测验证码的输入是否正确，

// 检测输入的验证码是否正确，$value为用户输入的验证码字符串
$captcha = new Captcha();
if( !$captcha->check($value))
{
	// 验证失败
}

或者直接调用封装的一个验证码检测的函数captcha_check

// 检测输入的验证码是否正确，$value为用户输入的验证码字符串
if( !captcha_check($value ))
{
	// 验证失败
}

如果你需要生成多个不同设置的验证码，可以使用下面的配置方式：

<?php
return [
    'verify'=>[
        'codeSet'=>'1234567890'
    ]
];

使用指定的配置生成验证码:

return Captcha::create('verify');

默认情况下，验证码的字体是随机使用扩展包内 think-captcha/assets/ttfs目录下面的字体文件，我们可以指定验证码的字体，例如：
修改或新建配置文件如下:

<?php
return [
    'verify'=>[
        'fontttf'=>'1.ttf'
    ]
];

return Captcha::create('verify');

默认的验证码字符已经剔除了易混淆的1l0o等字符

think助手工具库

常用的一些扩展类库

目前已有字符串操作,数组操作.

安装

composer require topthink/think-helper

更新完善中

以下类库都在\think\helper命名空间下

Str

字符串操作

use think\\helper\\Str;

// 检查字符串中是否包含某些字符串
Str::contains($haystack, $needles)

// 检查字符串是否以某些字符串结尾
Str::endsWith($haystack, $needles)

// 获取指定长度的随机字母数字组合的字符串
Str::random($length = 16)

// 字符串转小写
Str::lower($value)

// 字符串转大写
Str::upper($value)

// 获取字符串的长度
Str::length($value)

// 截取字符串
Str::substr($string, $start, $length = null)

//驼峰转下划线
Str::snake($value, $delimiter  =  '_')

//下划线转驼峰(首字母小写)
Str::camel($value)

//下划线转驼峰(首字母大写)
Str::studly

//转为首字母大写的标题格式
Str::title($value)

Arr

数组操作

use think\\helper\\Arr;

判断能否当做数组一样访问

//数组返回真
//模型查询的结果也为真
Arr::accessible($value)

向数组添加一个元素,支持"点"分割

Arr::add($array, $key, $value)
//如下操作
$arr  = [];
$arr = Arr::add($arr,'name.3.ss','thinkphp'); //本行结果$arr['name'][3]['ss'] = 'thinkphp'
Arr::add($arr,'name','thinkphp2');//本行不会产生影响,因为'name'已存在.

复制

将数据集管理类转换为数组

Arr::collapse($array)

排列数组组合

$arr  =  Arr::crossJoin(['dd'],['ff'=>'gg'],[2],[['a'=>'mm','kk'],'5']);
//上面行没有什么意义,但是可以看到该函数的作用,数组索引被忽略,数组得值被全部组合
$arr  =  Arr::crossJoin(['a','b','c'],['aa','bb','cc','dd']);
//这一行可以看到组合的效果,返回一个二维数组,第二维每个数组是的给定值排列,比如(a,aa),(a,bb),(a,cc)...直到(c,dd)

缓存

概述

ThinkPHP采用think\Cache类（实际使用think\facade\Cache类即可）提供缓存功能支持。

内置支持的缓存类型包括file、memcache、wincache、sqlite、redis。

ThinkPHP的缓存类遵循PSR-16规范。

设置

全局的缓存配置直接修改配置目录下面的cache.php文件。

新版的缓存支持多通道，你可以事先定义好所有的缓存类型及配置参数，然后在使用的时候可以随时切换。默认使用的是文件缓存类型，你可以添加redis缓存支持，例如：

return [
    'default'    =>    'file',
    'stores'    =>    [
        // 文件缓存
        'file'   =>  [
            // 驱动方式
            'type'   => 'file',
            // 设置不同的缓存保存目录
            'path'   => '../runtime/file/',
        ],  
        // redis缓存
        'redis'   =>  [
            // 驱动方式
            'type'   => 'redis',
            // 服务器地址
            'host'       => '127.0.0.1',
        ],  
    ],
];

缓存参数根据不同的缓存方式会有所区别，通用的缓存参数如下：

composer require topthink/think-helper

如果是自定义驱动，type的值则为自定义驱动的类名（包含命名空间）

使用

设置缓存

设置缓存有效期

// 缓存在3600秒之后过期
Cache::set('name', $value, 3600);

可以使用DateInterval对象设置多久以后过期

Cache::set('name', $value, DateInterval::createFromDateString('1 day'));

如果设置成功返回true，否则返回false。

缓存自增

针对数值类型的缓存数据，可以使用自增操作，例如：

Cache::set('name', 1);
// name自增（步进值为1）
Cache::inc('name');
// name自增（步进值为3）
Cache::inc('name',3);

只能对数字或者浮点型数据进行自增和自减操作。

缓存自减

针对数值类型的缓存数据，可以使用自减操作，例如：

// name自减（步进值为1）
Cache::dec('name');
// name自减（步进值为3）
Cache::dec('name',3);

获取缓存

获取缓存数据可以使用：

Cache::get('name'); 

如果name值不存在，则默认返回 null。

支持指定默认值，例如：

Cache::get('name',''); 

表示如果name值不存在，则返回空字符串。

追加一个缓存数据

如果缓存数据是一个数组，可以通过push方法追加一个数据。

Cache::set('name', [1,2,3]);
Cache::push('name', 4);
Cache::get('name'); // [1,2,3,4]

删除缓存

Cache::delete('name'); 

获取并删除缓存

Cache::pull('name'); 

如果name值不存在，则返回null。

清空缓存

Cache::clear(); 

不存在则写入缓存数据后返回

Cache::remember('start_time', time());

如果start_time缓存数据不存在，则会设置缓存数据为当前时间。

第二个参数可以使用闭包方法获取缓存数据，并支持依赖注入。

Cache::remember('start_time', function(Request $request){
    return $request->time();
});

remember方法的第三个参数可以设置缓存的有效期。

缓存标签

支持给缓存数据打标签，例如：

Cache::tag('tag')->set('name1','value1');
Cache::tag('tag')->set('name2','value2');

// 清除tag标签的缓存数据
Cache::tag('tag')->clear();

缓存标签不会改变缓存的读取操作，所以获取方式依然是：

Cache::get('name1');

并支持同时指定多个缓存标签操作

Cache::tag(['tag1', 'tag2'])->set('name1', 'value1');
Cache::tag(['tag1', 'tag2'])->set('name2', 'value2');

// 清除多个标签的缓存数据
Cache::tag(['tag1','tag2'])->clear();

可以追加某个缓存标识到标签

Cache::tag('tag')->append('name3');

获取标签的缓存标识列表

Cache::getTagItems('tag');

获取缓存对象

可以获取缓存对象，并且调用驱动类的高级方法，例如：

// 获取缓存对象句柄
$handler = Cache::handler();

助手函数

系统对缓存操作提供了助手函数cache，用法如下：

// 设置缓存数据
cache('name', $value, 3600);
// 获取缓存数据
var_dump(cache('name'));
// 删除缓存数据
cache('name', NULL);
// 返回缓存对象实例
$cache = cache();

跨应用缓存

在多应用模式下，默认文件缓存数据是区分不同应用的，如果你希望缓存跨应用，可以设置一个统一的数据缓存path目录。

切换缓存类型

没有指定缓存类型的话，默认读取的是default缓存配置，可以动态切换

// 使用文件缓存
Cache::set('name','value',3600);
Cache::get('name');

// 使用Redis缓存
Cache::store('redis')->set('name','value',3600);
Cache::store('redis')->get('name');

// 切换到文件缓存
Cache::store('default')->set('name','value',3600);
Cache::store('default')->get('name');

如果要返回当前缓存类型对象的句柄，可以使用

// 获取Redis对象 进行额外方法调用
Cache::store('redis')->handler();

复制

自定义驱动

如果需要自定义缓存驱动，需要继承think\cache\Driver类，并且实现think\contract\CacheHandlerInterface接口。

使用自定义驱动后，只需要配置缓存type的值为该驱动类名（包含命名空间）即可。

多语言

ThinkPHP内置通过\think\facade\Lang类提供多语言支持，如果你的应用涉及到国际化的支持，那么可以定义相关的语言包文件。任何字符串形式的输出，都可以定义语言常量。

开启和加载语言包

默认系统会加载默认语言包，但如果需要多语言自动侦测及自动切换，你需要在全局的中间件定义文件中添加中间件定义：

'think\middleware\LoadLangPack',

如果安装了多应用模式扩展，还需要在应用的中间件定义文件中添加上述定义。

默认情况下，系统载入的是配置的默认语言包，并且不会自动侦测当前系统的语言。多语言相关的设置在lang.php配置文件中进行设置。

默认语言由default_lang配置参数设置，系统默认设置为：

// 默认语言
'default_lang'    => 'zh-cn',

启用中间件后，系统会自动侦测和多语言自动切换，可以在配置文件设置自动侦测的多语言变量名：

// 自动侦测的GET变量名
'detect_var' => 'lang',

开启自动侦测后会会首先检查请求的URL或者Cookie中是否包含语言变量，然后根据HTTP_ACCEPT_LANGUAGE自动识别当前语言（并载入对应的语言包），同时支持通过Header方式自动侦测多语言。

如果在自动侦测语言的时候，希望设置允许的语言列表，不在列表范围的语言则仍然使用默认语言，可以配置：

// 设置允许的语言
'allow_lang_list'    =>    ['zh-cn', 'en-us']

如果希望使用Cookie保存语言，可以设置

// 使用Cookie保存
'use_cookie' => true,
// Cookie保存变量
'cookie_var' => 'think_lang',

设置后，自动检测的语言会通过Cookie记录下来，下次则直接通过Cookie判断语言。

语言变量定义

语言变量的定义，只需要在需要使用多语言的地方，写成：

Lang::get('add user error');
// 使用系统封装的助手函数
lang('add user error');

也就是说，字符串信息要改成Lang::get方法来表示。

语言定义一般采用英语来描述。

语言文件定义

自动加载的应用语言文件位于：

// 单应用模式
app/lang/当前语言.php
// 多应用模式
app/应用/lang/当前语言.php

语言包文件支持多种格式，包括php数组、yaml格式及json格式（V6.0.4+）。

如果你还需要加载其他的语言包，可以通过extend_list设置，例如：

'extend_list'    =>    [
    'zh-cn'    => [
        app()->getBasePath() . 'lang/zh-cn/app.php',
        app()->getBasePath() . 'lang/zh-cn/core.php',
    ],
]

目前核心框架仅内置zh-cn语言包，如果需要其它语言的提示，可以通过扩展语言包的方式自行加载。

ThinkPHP语言文件定义采用返回数组方式：

return [
     'hello thinkphp'  => '欢迎使用ThinkPHP',
     'data type error' => '数据类型错误',
];

通常多语言的使用是在控制器里面，但是模型类的自动验证功能里面会用到提示信息，这个部分也可以使用多语言的特性。

如果使用了多语言功能的话（假设，我们在当前语言包里面定义了' lang_var'=>'标题必须！'），就可以使用下面的字符串来替代原来的错误提示。

{%lang_var}

如果要在模板中输出语言变量不需要在控制器中赋值，可以直接使用模板引擎特殊标签来直接输出语言定义的值：

{$Think.lang.lang_var}

可以输出当前语言包里面定义的 lang_var语言定义。

变量传入支持

语言包定义的时候支持传入变量，有两种方式

使用命名绑定方式，例如：

'file_format'    =>    '文件格式: {:format},文件大小：{:size}',

在模板中输出语言字符串的时候传入变量值即可：

{:lang('file_format',['format' => 'jpeg,png,gif,jpg','size' => '2MB'])}

第二种方式是使用格式字串，如果你需要使用第三方的翻译工具，建议使用该方式定义变量。

'file_format'    =>    '文件格式: %s,文件大小：%d',

在模板中输出多语言的方式更改为：

{:lang('file_format',['jpeg,png,gif,jpg','2MB'])}

语言分组

首先你需要在lang.php配置文件中开启语言分组，

// 开启多语言分组
'allow_group'    =>    true

然后你可以在定义多语言的时候使用分组定义

return [
    'user'    =>    [
         'welcome'  => '欢迎回来',
         'login' => '用户登录',
         'logout' => '用户登出',
    ]
];

复制

然后使用下面的方式获取多语言变量

Lang::get('user.login');
lang('user.login');

上传

上传文件

内置的上传只是上传到本地服务器，上传到远程或者第三方平台的话需要安装额外的扩展。

上传到远程需要安装think-filesystem扩展，首先使用下面的命令安装。

composer require topthink/think-filesystem

假设表单代码如下：

<form action="/index/upload" enctype="multipart/form-data" method="post">
<input type="file" name="image" /> <br> 
<input type="submit" value="上传" /> 
</form> 

然后在控制器中添加如下的代码：

public function upload(){
    // 获取表单上传文件 例如上传了001.jpg
    $file = request()->file('image');
    // 上传到本地服务器
    $savename = \think\facade\Filesystem::putFile( 'topic', $file);
}

$file变量是一个\think\File对象，你可以获取相关的文件信息，支持使用SplFileObject类的属性和方法。

上传规则

默认情况下是上传到本地服务器，会在runtime/storage目录下面生成以当前日期为子目录，以微秒时间的md5编码为文件名的文件，例如上面生成的文件名可能是：

runtime/storage/topic/20160510/42a79759f284b767dfcb2a0197904287.jpg

如果是多应用的话，上传根目录默认是runtime/index/storage，如果你希望上传的文件是可以直接访问或者下载的话，可以使用public存储方式。

$savename = \think\facade\Filesystem::disk('public')->putFile( 'topic', $file);

你可以在config/filesystem.php配置文件中配置上传根目录及上传规则，例如：

return [
    'default' =>  'local',
    'disks'   => [
        'local'  => [
            'type' => 'local',
            'root'   => app()->getRuntimePath() . 'storage',
        ],
        'public' => [
            'type'     => 'local',
            'root'       => app()->getRootPath() . 'public/storage',
            'url'        => '/storage',
            'visibility' => 'public',
        ],
        // 更多的磁盘配置信息
    ],
];

系统默认根据日期和微秒数生成文件命名规则，为了避免并发导致的冲突可能，我们可以指定上传文件的命名规则，例如：

$savename = \think\facade\Filesystem::putFile( 'topic', $file, 'md5');

最终生成的文件名类似于：

runtime/storage/topic/72/ef580909368d824e899f77c7c98388.jpg

你可以使用hash_file支持的任意哈希规则（也就是hash_algos函数返回的规则列表），会自动以散列值的前两个字符作为子目录，后面的散列值作为文件名。

如果需要使用自定义命名规则，可以在rule方法中传入函数或者使用闭包方法，例如：

$savename = \think\facade\Filesystem::putFile( 'topic', $file, 'uniqid');

如果希望以指定的文件名保存,可调用putFileAs方法,例如:

$savename = \think\facade\Filesystem::putFileAs( 'topic', $file,'abc.jpg');

多文件上传

如果你使用的是多文件上传表单，例如：

<form action="/index/index/upload" enctype="multipart/form-data" method="post">
<input type="file" name="image[]" /> <br> 
<input type="file" name="image[]" /> <br> 
<input type="file" name="image[]" /> <br> 
<input type="submit" value="上传" /> 
</form> 

控制器代码可以改成：

public function upload(){
    // 获取表单上传文件
    $files = request()->file('image');
    $savename = [];
    foreach($files as $file){
        $savename[] = \think\facade\Filesystem::putFile( 'topic', $file);
    }
}

上传验证

支持使用验证类对上传文件的验证，包括文件大小、文件类型和后缀：

public function upload(){
    // 获取表单上传文件
    $files = request()->file();
    try {
        validate(['image'=>'fileSize:10240|fileExt:jpg|image:200,200,jpg'])
            ->check($files);
        $savename = [];
        foreach($files as $file) {
            $savename[] = \think\facade\Filesystem::putFile( 'topic', $file);
        }
    } catch (\think\exception\ValidateException $e) {
        echo $e->getMessage();
    }
}

具体用法可以参考验证章节的内置规则-> 上传验证。

获取文件hash散列值

可以获取上传文件的哈希散列值，例如：

// 获取表单上传文件
$file = request()->file('image');
// 获取上传文件的hash散列值
echo $file->md5();
echo $file->sha1();

可以统一使用hash方法获取文件散列值

// 获取表单上传文件
$file = request()->file('image');
// 获取上传文件的hash散列值
echo $file->hash('sha1');
echo $file->hash('md5');

复制

异常处理

和PHP默认的异常处理不同，ThinkPHP抛出的不是单纯的错误信息，而是一个人性化的错误页面。

异常显示

新版的异常页面显示会自动判断当前的请求是否为Json请求，如果是JSON请求则采用JSON格式输出异常信息，否则按照HTML格式输出。

在调试模式下，系统默认展示的异常页面：

只有在调试模式下面才能显示具体的错误信息，如果在部署模式下面，你可能看到的是一个简单的提示文字，例如：

V8.0.4+版本，你可以通过给异常类添加注解（通常是业务中的异常类），不管是否调试模式始终会输出错误信息。

<?php

namespace app\exception;
use think\exception\AlwaysErrorMsg;

#[AlwaysErrorMsg]
class QuotaException extends \Exception
{

}

你可以通过设置exception_tmpl配置参数来自定义你的异常页面模板，默认的异常模板位于：

thinkphp/tpl/think_exception.tpl

你可以在应用配置文件app.php中更改异常模板

// 自定义异常页面的模板文件
'exception_tmpl'         => \think\facade\App::getAppPath() . 'template/exception.tpl',

默认的异常页面会返回500状态码，如果是一个HttpException异常则会返回HTTP的错误状态码。

异常处理接管

本着严谨的原则，框架会对任何错误（包括警告错误）抛出异常。系统产生的异常和错误都是程序的隐患，要尽早排除和解决，而不是掩盖。对于应用自己抛出的异常则做出相应的捕获处理。

框架支持异常处理由开发者自定义类进行接管，需要在app目录下面的provider.php文件中绑定异常处理类，例如：

    // 绑定自定义异常处理handle类
    'think\exception\Handle'       => '\\app\\exception\\Http',

自定义类需要继承think\exception\Handle并且实现render方法，可以参考如下代码：

<?php
namespace app\common\exception;

use think\exception\Handle;
use think\exception\HttpException;
use think\exception\ValidateException;
use think\Response;
use Throwable;

class Http extends Handle
{
    public function render($request, Throwable $e): Response
    {
        // 参数验证错误
        if ($e instanceof ValidateException) {
            return json($e->getError(), 422);
        }

        // 请求异常
        if ($e instanceof HttpException && $request->isAjax()) {
            return response($e->getMessage(), $e->getStatusCode());
        }

        // 其他错误交给系统处理
        return parent::render($request, $e);
    }

}

自定义异常处理的主要作用是根据不同的异常类型发送不同的状态码和响应输出格式。

事实上，默认安装应用后，已经帮你内置了一个app\ExceptionHandle异常处理类，直接修改该类的相关方法即可完成应用的自定义异常处理机制。

需要注意的是，如果自定义异常处理类没有再次调用系统render方法的话，配置http_exception_template就不再生效，具体可以参考Handle类内实现的功能。

手动抛出和捕获异常

ThinkPHP大部分情况异常都是自动抛出和捕获的，你也可以手动使用throw来抛出一个异常，例如：

// 使用think自带异常类抛出异常
throw new \think\Exception('异常消息', 10006);

手动捕获异常方式是使用try-catch，例如：

try {
    // 这里是主体代码
} catch (ValidateException $e) {
    // 这是进行验证异常捕获
    return json($e->getError());
} catch (\Exception $e) {
    // 这是进行异常捕获
    return json($e->getMessage());
}

支持使用try-catch-finally结构捕获异常。

HTTP 异常

可以使用\think\exception\HttpException类来抛出HTTP异常

<?php
namespace app\index\controller;
use think\exception\HttpException;

class Index
{
    public function index()
    {
      // 抛出 HTTP 异常
      throw new HttpException(404, '异常消息');
    }
}

系统提供了助手函数abort简化HTTP异常的处理，例如：

<?php
namespace app\index\controller;


class Index
{
    public function index()
    {
        // 抛出404异常
        abort(404, '页面异常');
    }
}

如果你的应用是API接口，那么请注意在客户端首先判断HTTP状态码是否正常，然后再进行数据处理，当遇到错误的状态码的话，应该根据状态码自行给出错误提示，或者采用下面的方法进行自定义异常处理。

部署模式下一旦抛出了HttpException异常，可以定义单独的异常页面模板，只需要在app.php配置文件中增加：

'http_exception_template'    =>  [
    // 定义404错误的模板文件地址
    404 =>  \think\facade\App::getAppPath() . '404.html',
    // 还可以定义其它的HTTP status
    401 =>  \think\facade\App::getAppPath() . '401.html',
]

复制

模板文件支持模板引擎中的标签。

http_exception_template配置仅在部署模式下面生效。

Trace调试

调试模式并不能完全满足我们调试的需要，有时候我们需要手动的输出一些调试信息。除了本身可以借助一些开发工具进行调试外，ThinkPHP还提供了一些内置的调试工具和函数。

Trace调试功能就是ThinkPHP提供给开发人员的一个用于开发调试的辅助工具。可以实时显示当前页面或者请求的请求信息、运行情况、SQL执行、错误信息和调试信息等，并支持自定义显示，并且支持没有页面输出的操作调试。最新版本页面Trace功能已经不再内置在核心，但默认安装的时候会自动安装topthink/think-trace扩展，所以你可以在项目里面直接使用。

如果部署到服务器的话，你可以通过下面方式安装

composer install --no-dev

就不会安装页面Trace扩展。

使用

页面Trace功能仅在调试模式下有效

安装页面Trace扩展后，如果开启调试模式并且运行后有页面有输出的话，页面右下角会显示ThinkPHP的LOGO：

LOGO后面的数字就是当前页面的执行时间（单位是秒） 点击该图标后，会展开详细的Trace信息，如图：

Trace框架有6个选项卡，分别是基本、文件、流程、错误、SQL和调试，点击不同的选项卡会切换到不同的Trace信息窗口。

Trace的选项卡是可以定制和扩展的，如果你希望增加新的选项卡，则可以修改配置目录下的trace.php文件中的配置参数如下：

return [
    'type' => 'Html',
    'tabs' => [
        'base'  => '基本',
        'file'  => '文件',
        'info'  => '流程',
        'error' => '错误',
        'sql'   => 'SQL',
        'debug' => '调试',
        'user'  => '用户',
    ],
];

base和file是系统内置的，其它的选项其实都属于日志的等级（user是用户自定义的日志等级）。

也可以把某几个选项卡合并，例如：

return [
    'type' => 'Html',
    'tabs' => [
        'base'                 => '基本',
        'file'                 => '文件',
        'error|notice|warning' => '错误',
        'sql'                  => 'SQL',
        'debug|info'           => '调试',
    ],
];

更改后的Trace显示效果如图：

如果需要更改页面Trace输出的样式，可以自定义模板文件（可以复制内置模板文件vendor/topthink/think-trace/src/tpl/page_trace.tpl的内容），然后配置file参数指定模板文件位置。

'file'    =>    'app\trace\page_trace.html',

浏览器控制台输出

trace功能支持在浏览器的console直接输出，这样可以方便没有页面输出的操作功能调试，只需要在配置文件中设置：

    // 使用浏览器console输出trace信息
    'type'  =>  'console',

运行后打开浏览器的console控制台可以看到如图所示的信息：

浏览器Trace输出同样支持tabs设置。

由于页面Trace功能是通过中间件来执行，所以命令行下面不会显示任何的页面Trace信息