thinkphp笔记-异常处理、日志处理

3597次阅读 132人点赞 作者: WuBin 发布时间: 2024-07-02 07:49:58
扫码到手机查看

异常处理

系统输出的异常信息比PHP 原生的要人性化的多,但需要开启调试模式;

如果你想更改异常页面的样式、布局之类的,可以修改这个页面:

vendor/topthink/framework/src/tpl/think_exception.tpl

如果你想要直接替换掉异常页面,换成别的,可以在config/app.php 中进行设置:

 // 异常页面的模板文件
'exception_tmpl'   => app()->getThinkPath() . 'tpl/think_exception.tpl',

app()->getThinkPath() 这个是一个助手函数,更多的助手函数在

\vendor\topthink\framework\src\think\App.php 文件中

其中有getBasePath()、getAppPath()等等,需要从源码中自己发掘。

系统的异常抛出是自动进行的,并不需要你手动抛出,但也支持手动;

try {

            // 使用助手函数,直接放一个验证类进去
            validate(User::class)
                ->batch(true)
                ->scene('edit') // 写入场景规则,不验证邮箱
                ->check([
                    'name' => '',
                    'price' => '',
                    'email' => 'xiaoxin163.com'
                ]);

        } catch(ValidateException $e) {
            // 手动抛出异常
            throw new Exception('异常', 10086);
        }

我们可以使用try...catch 对可能发生的异常进行手动捕获或抛出;

我们可以抛出HTTP 异常,所谓HTTP 异常比如404 错误,500 错误之类;

try {
...
} catch() {
            // 好处就是可以设置状态码 从而跳转页面
            throw new HttpException(404, '错误信息');
 }

需要引入

use think\exception\HttpException;

或者使用助手函数,系统提供了一个助手函数abort()方法简化HTTP 异常抛出;实现的效果相同

try {
 ...
} catch() {
    // 好处就是可以设置状态码 从而跳转页面
    // throw new HttpException(404, '错误信息');
    abort(404, '错误信息');
}

如果系统关闭了调试模式,进入部署环境下,可以设置HTTP 错误页面,比如404;

比如在根目录下.env中设置
APP_DEBUG = false

然后在config/app.php中,在末尾添加404时跳转属性

<?php
// +----------------------------------------------------------------------
// | 应用设置
// +----------------------------------------------------------------------

return [
    // 应用地址
    'app_host'         => env('app.host', ''),
    // 异常页面的模板文件
    'exception_tmpl'   => app()->getThinkPath() . 'tpl/think_exception.tpl',
    // 显示错误信息
    'show_error_msg'   => true,
    ...
    // 下面这个为新增
    'http_exception_template' => [
        // 定义404 错误的模板文件地址
        404 => \think\facade\App::getAppPath() . '404.html',
    ]
];
其中,\think\facade\App::getAppPath()与app()->getThinkPath()都是使用的\vendor\topthink\framework\src\think\App.php文件中的方法,区别仅仅是调用方式的不同。
由于设置中我们404状态码指向app根目录下的404.html,所以我们需要在app目录下直接新建404.html即可。当然其他页面也可以进行单独设置,比如504等。

日志处理

日志处理的操作由Log 类完成,它记录着所有程序中运行的错误记录;配置文件在config/log.php,在其中可以配置日志写入的方式。

日志是写入磁盘中的,是文本文件。所以这些文件存放在

\runtime\log\202407\01.log
开启调试模式后,.env中APP_DEBUG=true,会记录错误在哪一行。
use think\facade\Log;

 Log::record('测试日志');

然后找到最新的日志文件,可以看到文件中新增了一行

[2024-07-02T08:22:14+08:00][info] 测试日志

系统提供了不同日志级别,默认info 级别,从低到高排列如下:

debug/info/notice/warning/error/critical/alert/emergency/sql;

一般记录就是info 信息,我们也可以指定我们的信息级别;

Log::record('错误日志!', 'error');
[2024-07-02T08:24:52+08:00][error]错误日志
record()方法不是实时记录,需要等待程序完毕后决定是否写入日志;

如果在写入方法后添加close()关闭写入,那么record()方法则不写入;

 Log::record('cuowu日志', 'error');
Log::close();

如此,那么记录的错误日志则不会写入。

系统还提供了一个write()方法,进行时时写入,不理会其它限制;

 Log::write('错误日志', 'error');
 Log::close();

使用write那么,无论是否使用close,都会写入到日志中。

系统发生异常后,会自动写入error 日志,如果你想手动也可以;

try {
    echo 0/0;
} catch (ErrorException $e)
{
   echo '发生错误:'.$e->getMessage();
   Log::record('被除数不得为零', 'error');
}
当使用try-catch捕获到错误的时候,默认是不写入日志的,因此如果在try中写入日志就需要手动操作。

还可以写入错误码

try {
            echo 0/0;
        } catch (ErrorException $e)
        {
           echo '发生错误:'.$e->getMessage();
           Log::record('[' . $e->getCode() . ']被除数不得为零', 'error');
        }

对于各种日志级别,系统提供了一些快捷方式和助手函数,比如

Log::error('错误日志!');   //等价于  Log::record('错误日志!', 'error')
Log::info('信息日志!');    //等价于  Log::record('信息日志!', 'info')
trace('错误日志!', 'error');
trace('信息日志!', 'info');
系统默认并不记录HTTP 异常,因为这种异常容易遭受攻击不断写入日志;

除了系统提供的几种类型,也可以自己定义日志类型;

Log::diy('自定义日志');

[2024-07-02T08:37:16+08:00][diy] 自定义日志

在配置文件config/log.php 中,可以设置限定日志文件的级别,不属于的无法写入;

'level' => ['error','info'], // 只能写入error 和info 其他的不能写入日志

在配置文件log.php 中,添加转换为json 格式(方便处理,以便于展示在页面中);

<?php
return [
    ...
    // 日志通道列表
    'channels'     => [
        'file' => [
            ...
            // 使用JSON格式记录
            'json'           => true,
            ...
        ],
        // 其它日志通道配置
    ],
];

设置后,再写入的日志就会变成如下形式

[2024-07-02T08:35:08+08:00][error] [2]Division by zero[D:\phpstudy\phpstudy_pro\WWW\xuexi\tp6\app\controller\Store.php:101] 
// 上面是设置之前,下面是设置json之后
{"time":"2024-07-02T08:40:57+08:00","type":"diy","msg":"自定义日志"}
{"time":"2024-07-02T08:40:58+08:00","type":"diy","msg":"自定义日志"}

使用::getLog()方法,可以获取写入到内存中的日志;

Log::record('错误日志', 'error');
dump(Log::getLog());
Log::record会在执行之后才会写入日志,而日志信息会存放在内存中,使用Log::getLog()方法会在日志还没写入文件的时候,提前先从内存中获取到将要写入日志的信息。
array:1 [
  "error" => array:1 [
    0 => "错误日志"
  ]
]

但是如果使用Log::write那么,使用getLog就只能获取到一个空数组

Log::write('错误日志', 'error');
dump(Log::getLog()); // []

record原理是先将日志写入内存中,待执行完毕后看看代码有无问题,有问题则写入到日志文件中,因此可以用getLog从内存中将错误信息拉出来;

write是直接写入到日志文件中的,不经过内存,所以无法使用getLog获取到。

使用::clear()方法,可以清理掉内存中的日志;

Log::record('错误日志', 'error');
Log::clear();
dump(Log::getLog());

比如上面代码,1、record先将日志写入内存;2、clear()从内存中将预写的日志删除掉;3、getLog()则无法从内存中获取预写入的日志,因此打印出来的就是空数组;4、同样的,日志文件中也不会写入任何内容,因为在内存阶段都被清除掉了。

在配置文件config/log.php 中,可以设置以单独文件存储的方式(就是永远都只有一个文件);

'single' => true,

如此设置后,会在目录下新建:runtime\log\single.log文件。以后会将所有日志都记录在这个文件中。当然建议不要这么做。

点赞 支持一下 觉得不错?客官您就稍微鼓励一下吧!
关键词:thinkphp
推荐阅读
  • uniapp实现被浏览器唤起的功能

    当用户打开h5链接时候,点击打开app若用户在已经安装过app的情况下直接打开app,若未安装过跳到应用市场下载安装这个功能在实现上主要分为两种场景,从普通浏览器唤醒以及从微信唤醒。

    9664次阅读 631人点赞 发布时间: 2022-12-14 16:34:53 立即查看
  • Vue

    盘点Vue2和Vue3的10种组件通信方式

    Vue中组件通信方式有很多,其中Vue2和Vue3实现起来也会有很多差异;本文将通过选项式API组合式API以及setup三种不同实现方式全面介绍Vue2和Vue3的组件通信方式。

    4342次阅读 322人点赞 发布时间: 2022-08-19 09:40:16 立即查看
  • JS

    几个高级前端常用的API

    推荐4个前端开发中常用的高端API,分别是MutationObserver、IntersectionObserver、getComputedstyle、getBoundingClientRect、requ...

    14542次阅读 951人点赞 发布时间: 2021-11-11 09:39:54 立即查看
  • PHP

    【正则】一些常用的正则表达式总结

    在日常开发中,正则表达式是非常有用的,正则表达式在每个语言中都是可以使用的,他就跟JSON一样,是通用的。了解一些常用的正则表达式,能大大提高你的工作效率。

    13594次阅读 496人点赞 发布时间: 2021-10-09 15:58:58 立即查看
  • 【中文】免费可商用字体下载与考证

    65款免费、可商用、无任何限制中文字体打包下载,这些字体都是经过长期验证,经得住市场考验的,让您规避被无良厂商起诉的风险。

    12136次阅读 971人点赞 发布时间: 2021-07-05 15:28:45 立即查看
  • Vue

    Vue3开发一个v-loading的自定义指令

    在vue3中实现一个自定义的指令,有助于我们简化开发,简化复用,通过一个指令的调用即可实现一些可高度复用的交互。

    16475次阅读 1315人点赞 发布时间: 2021-07-02 15:58:35 立即查看
  • JS

    关于手机上滚动穿透问题的解决

    当页面出现浮层的时候,滑动浮层的内容,正常情况下预期应该是浮层下边的内容不会滚动;然而事实并非如此。在PC上使用css即可解决,但是在手机端,情况就变的比较复杂,就需要禁止触摸事件才可以。

    15243次阅读 1240人点赞 发布时间: 2021-05-31 09:25:50 立即查看
  • Vue

    Vue+html2canvas截图空白的问题

    在使用vue做信网单页专题时,有海报生成的功能,这里推荐2个插件:一个是html2canvas,构造好DOM然后转canvas进行截图;另外使用vue-canvas-poster(这个截止到2021年3月...

    30010次阅读 2359人点赞 发布时间: 2021-03-02 09:04:51 立即查看
  • Vue

    vue-router4过度动画无效解决方案

    在初次使用vue3+vue-router4时候,先后遇到了过度动画transition进入和退出分别无效的情况,搜遍百度没没找到合适解决方法,包括vue-route4有一些API都进行了变化,以前的一些操...

    26052次阅读 2003人点赞 发布时间: 2021-02-23 13:37:20 立即查看
交流 收藏 目录