经验首页 前端设计 程序设计 Java相关 移动开发 数据库/运维 软件/图像 大数据/云计算 其他经验
当前位置：技术经验 » 程序设计 » PHP » 查看文章
重写Laravel异常处理类
来源：cnblogs　　作者：itbsl　　时间：2020/12/21 15:14:25　　对本文有异议

现在开发前后端分离变得越来越流行了，后端只提供接口返回json格式的数据，即使是错误信息也要以json格式来返回，然而目前无论是Laravel框架还是ThinkPHP框架，都只提供了返回json数据的方法，对异常的处理并不是以json格式来返回给我们，所以这里就需要我们自己来改写。

首先我们在app/Exceptions目录新建一个ExceptionHandler.php继承自Handler.php

  1. namespace App\Exceptions;
  4. class ExceptionHandler extends Handler
  5. {
  7. }

然后我们在bootstrap/app.php中，使用我们自定义的异常处理类ExceptionHandler替换掉默认的Handler类

  1. //改为我们自定义的ExceptionHandler类
  2. $app->singleton(
  3.     Illuminate\Contracts\Debug\ExceptionHandler::class,
  4.     App\Exceptions\ExceptionHandler::class
  5. );

接下来我们就开始重写渲染方法

在render方法里，我们根据.env文件中的APP_DEBUG来判断，如果是调试模式，我们还是按照默认方式来渲染错误，如果是非调试模式，我们就返回JSON格式的信息

  1. namespace App\Exceptions;
  3. use Exception;
  5. class ExceptionHandler extends Handler
  6. {
  7.     public function render($request, Exception $exception)
  8.     {
  9.         if (env('APP_DEBUG')) {
  10.             return parent::render($request, $exception);
  11.         }
  12.         return response()->json([
  13.             'code' => $exception->getCode(),
  14.             'msg'  => $exception->getMessage()
  15.         ]);
  16.     }
  17. }

这样我们就可以根据APP_DEBUG的值设置是否返回JSON格式的数据了，现在我们把.env的APP_DEBUG的值设为false来测试一下，然后我们故意把代码写错，通过postman或浏览器来访问接口

  1. Route::get('/', function () {
  2.     //这是一段缺少了分号的代码，会报异常
  3.     echo 'Hello World!'
  4. });

在APP_DEBUG=true的情况下还仍然是默认渲染，方便我们查找错误排错

异常类默认会把异常以日志的形式记录在storage/logs目录下，并且以laravel-日期(YYYY-MM-DD)命名的形式，.log为后缀保存错误日志

我们打开这个日志文件查看记录的错误信息，我们可以发现错误信息记录的非常详细，除了错误说明之外，还记录了调用栈，如下图所示

基本上红框里的信息就够我们排错了，不需要像现在这样记录的这么详细，所以要想不记录调用栈，我们可以重写report方法

首先我们看一下框架的report方法，代码在(src/Illuminate/Foundation/Exceptions/Handler.php),我用红框框起来的代码就是调用栈信息，我们在重写这个方法时只需要完全拷贝这个方法里的所有代码到我们自定义的report方法里，然后把红框里的代码去掉即可

我们在我们自定义的异常处理类ExceptionHandler.php中重写report方法

  1. public function report(Exception $exception)
  2. {
  3.     if ($this->shouldntReport($exception)) {
  4.         return;
  5.     }
  7.     if (Reflector::isCallable($reportCallable = [$exception, 'report'])) {
  8.         return $this->container->call($reportCallable);
  9.     }
  11.     try {
  12.         $logger = $this->container->make(LoggerInterface::class);
  13.     } catch (Exception $ex) {
  14.         throw $exception;
  15.     }
  17.     $logger->error(
  18.         $exception->getMessage()
  19.     );
  20. }

然后我们再重新请求一下接口再去查看错误日志的记录，可以发现确实没有记录调用栈信息了，但是下面的信息还是不够，我们没法根据下面的信息判断错误发生在哪一个文件和哪一行，如果能在记录错误信息的时候同时记录发生错误的文件和行就更好了，所以借着修改report方法

  1. public function report(Exception $exception)
  2. {
  3.     if ($this->shouldntReport($exception)) {
  4.         return;
  5.     }
  7.     if (Reflector::isCallable($reportCallable = [$exception, 'report'])) {
  8.         return $this->container->call($reportCallable);
  9.     }
  11.     try {
  12.         $logger = $this->container->make(LoggerInterface::class);
  13.     } catch (Exception $ex) {
  14.         throw $exception;
  15.     }
  17.     $logger->error(
  18.         $exception->getMessage()." at ".$exception->getFile().":".$exception->getLine()
  19.     );
  20. }

在代码里我通过exception的getFile()、getLine()方法加上了文件和行数，保存代码再次访问接口，查看错误日志文件我们可以看到发生错误的文件和行数已经记录下来了，有了这些信息基本我们就可以找到错误

截止到这里实现最初的需求我们的ExceptionHandler.php只需要有这些代码

  1. namespace App\Exceptions;
  4. use Exception;
  5. use Illuminate\Support\Reflector;
  6. use Psr\Log\LoggerInterface;
  8. class ExceptionHandler extends Handler
  9. {
  11.     public function render($request, Exception $exception)
  12.     {
  13.         if (env('APP_DEBUG')) {
  14.             return parent::render($request, $exception);
  15.         }
  16.         return response()->json([
  17.             'code' => $exception->getCode(),
  18.             'msg'  => $exception->getMessage()
  19.         ]);
  20.     }
  22.     public function report(Exception $exception)
  23.     {
  24.         if ($this->shouldntReport($exception)) {
  25.             return;
  26.         }
  28.         if (Reflector::isCallable($reportCallable = [$exception, 'report'])) {
  29.             return $this->container->call($reportCallable);
  30.         }
  32.         try {
  33.             $logger = $this->container->make(LoggerInterface::class);
  34.         } catch (Exception $ex) {
  35.             throw $exception;
  36.         }
  38.         $logger->error(
  39.             $exception->getMessage()." at ".$exception->getFile().":".$exception->getLine()
  40.         );
  41.     }
  42. }

然后还不够，我们发现刚刚我们把服务器端的错误信息以JSON格式返回给客户端了，这是不允许的，我们应该只把一些客户端错误返回给客户端，比如密码不足六位、身份证不合法诸如此类，而服务端出现错误时我们只返回给客户端一个模糊的信息即可，比如“服务器错误”，把真实的服务器错误信息记录在日志里面方便开发人员排查错误

所以我们需要定义一个客户端异常专门用户返回客户端错误,使用如下命令在app/Exceptions目录下生成一个ClientException.php文件

  1. php artisan make:exception ClientException

修改为构造方法为如下代码

  1. namespace App\Exceptions;
  3. use Exception;
  5. class ClientException extends Exception
  6. {
  7.     public function __construct($code, $msg)
  8.     {
  9.         parent::__construct($msg, $code);
  10.     }
  11. }

接着我们继续修改ExceptionHandler.php

  1. namespace App\Exceptions;
  4. use Exception;
  5. use Illuminate\Support\Reflector;
  6. use Psr\Log\LoggerInterface;
  8. class ExceptionHandler extends Handler
  9. {
  10.     /**
  11.      * @var int 错误码
  12.      */
  13.     protected $code;
  14.     /**
  15.      * @var string 错误信息
  16.      */
  17.     protected $message;
  19.     protected $dontReport = [
  20.         ClientException::class
  21.     ];
  23.     public function render($request, Exception $exception)
  24.     {
  25.         if ($exception instanceof ClientException) {
  26.             $this->code = $exception->getCode();
  27.             $this->message = $exception->getMessage();
  28.         } else {
  29.             if (env('APP_DEBUG')) {
  30.                 return parent::render($request, $exception);
  31.             }
  32.             
  33.             $this->code = 500;
  34.             $this->message = '服务器错误';
  35.         }
  36.         
  37.         return response()->json([
  38.             'code' => $this->code,
  39.             'msg'  => $this->message
  40.         ]);
  41.     }
  43.     public function report(Exception $exception)
  44.     {
  45.         if ($this->shouldntReport($exception)) {
  46.             return;
  47.         }
  49.         if (Reflector::isCallable($reportCallable = [$exception, 'report'])) {
  50.             return $this->container->call($reportCallable);
  51.         }
  53.         try {
  54.             $logger = $this->container->make(LoggerInterface::class);
  55.         } catch (Exception $ex) {
  56.             throw $exception;
  57.         }
  59.         $logger->error(
  60.             $exception->getMessage()." at ".$exception->getFile().":".$exception->getLine()
  61.         );
  62.     }
  63. }

对于上面的修改做一下说明，laravel的$dontReport属性的异常类都不会被上报，因为客户端错误信息我们不需要记录，所以将其添加到$dontReport属性里，并且在render方法里把异常大概分为了两大类，一大类就是客户端异常，另一大类就是服务器异常，我们把服务器异常统一code为500，错误信息为服务器错误，将真实的错误信息记录在了错误日志里，避免把服务器信息暴露给了客户端。

现在我们来测试我们重写异常的结果

假如我们想返回客户端异常，比如没有权限,这类客户端异常在错误日志里都不会产生记录，我们本身也不需要记录

  1. Route::get('/', function () {
  2.     throw new \App\Exceptions\ClientException(403, '你没有权限');
  3. });

对于服务器端的错误，如少些了分号,客户端就只会知道服务器的某个接口出了问题，但是不清楚具体问题是什么

  1. Route::get('/', function () {
  2.     echo 'Hello World!'
  3. });

但是真实的错误信息会记录在错误日志里，我们仍旧可以通过错误日志来修改我们服务端的错误

我们还可以在render方法中加入告警代码，如果是服务端错误就给管理员发送邮件。

至此，我们的重写Laravel异常处理类就算完成啦，希望对正在准备使用Laravel做前后端分离项目的你有所帮助。

原文链接：http://www.cnblogs.com/itbsl/p/14153586.html

 友情链接：直通硅谷 　点职佳 　北美留学生论坛

PHP热门文章

  • 收藏了8年的PHP优秀资源，都给你整理好了
  • php对微信支付回调处理的方法（合集）
  • 聊聊TCP连接耗时的那些事儿
  • php如何比较两个浮点数是否相等详解
  • PHP实现PDO操作mysql存储过程示例
  • 富文本编辑器新增导入word功能，自动转为html，可直接显示图片
  • curl put方式上传文件
  • thinkphp3.2模块名如何不区分大小写?
  • php去掉字符串的最后一个字符
  • WebSocket 长连接 及超时问题解决

    • PHP推荐文章

  • 【workerman】uniapp+thinkPHP5使用GatewayWorker实现实时通讯
  • PHP转Go系列 | ThinkPHP与Gin框架之API接口签名设计实践
  • MagicArray:像php一样，让Go业务代码不再卷！
  • 2023年的PHP项目部署笔记。什么？还有人用PHP？
  • [CTF/Web] PHP 反序列化学习笔记
  • PHP的序列化和反序列化入门
  • 详解PHP实现HTTP服务器过程
  • 高效率开发Web安全扫描器之路（一）
  • PHP实现微信扫码登录功能的两种方式总结
  • PHP内存溢出的解决方法详解

    • 本站QQ群：前端 618073944 | Java 606181507 | Python 626812652 | C/C++ 612253063 | 微信 634508462 | 苹果 692586424 | C#/.net 182808419 | PHP 305140648 | 运维 608723728

    W3xue 的所有内容仅供测试，对任何法律问题及风险不承担任何责任。通过使用本站内容随之而来的风险与本站无关。
    关于我们  |  意见建议  |  捐助我们  |  报错有奖  |  广告合作、友情链接（目前9元/月）请联系QQ：27243702 沸活量
    皖ICP备17017327号-2　皖公网安备34020702000426号