Laravel核心解读--异常处理
异常处理是编程中十分重要但也最容易被人忽视的语言特性,它为开发者提供了处理程序运行时错误的机制,对于程序设计来说正确的异常处理能够防止泄露程序自身细节给用户,给开发者提供完整的错误回溯堆栈,同时也能提高程序的健壮性。
这篇文章我们来简单梳理一下Laravel中提供的异常处理能力,然后讲一些在开发中使用异常处理的实践,如何使用自定义异常、如何扩展Laravel的异常处理能力。
注册异常Handler
这里又要回到我们说过很多次的Kernel处理请求前的bootstrap阶段,在bootstrap阶段的Illuminate\Foundation\Bootstrap\HandleExceptions
部分中Laravel设置了系统异常处理行为并注册了全局的异常处理器:
class HandleExceptions
{public function bootstrap(Application $app){$this->app = $app;error_reporting(-1);set_error_handler([$this, 'handleError']);set_exception_handler([$this, 'handleException']);register_shutdown_function([$this, 'handleShutdown']);if (! $app->environment('testing')) {ini_set('display_errors', 'Off');}}public function handleError($level, $message, $file = '', $line = 0, $context = []){if (error_reporting() & $level) {throw new ErrorException($message, 0, $level, $file, $line);}}
}
set_exception_handler([$this, 'handleException'])
将HandleExceptions
的handleException
方法注册为程序的全局处理器方法:
public function handleException($e)
{if (! $e instanceof Exception) {$e = new FatalThrowableError($e);}$this->getExceptionHandler()->report($e);if ($this->app->runningInConsole()) {$this->renderForConsole($e);} else {$this->renderHttpResponse($e);}
}protected function getExceptionHandler()
{return $this->app->make(ExceptionHandler::class);
}// 渲染CLI请求的异常响应
protected function renderForConsole(Exception $e)
{$this->getExceptionHandler()->renderForConsole(new ConsoleOutput, $e);
}// 渲染HTTP请求的异常响应
protected function renderHttpResponse(Exception $e)
{$this->getExceptionHandler()->render($this->app['request'], $e)->send();
}
在处理器里主要通过ExceptionHandler
的report
方法上报异常、这里是记录异常到storage/laravel.log
文件中,然后根据请求类型渲染异常的响应生成输出给到客户端。这里的ExceptionHandler就是\App\Exceptions\Handler
类的实例,它是在项目最开始注册到服务容器中的:
// bootstrap/app.php/*
|--------------------------------------------------------------------------
| Create The Application
|--------------------------------------------------------------------------
*/$app = new Illuminate\Foundation\Application(realpath(__DIR__.'/../')
);/*
|--------------------------------------------------------------------------
| Bind Important Interfaces
|--------------------------------------------------------------------------
*/
......$app->singleton(Illuminate\Contracts\Debug\ExceptionHandler::class,App\Exceptions\Handler::class
);
这里再顺便说一下set_error_handler
函数,它的作用是注册错误处理器函数,因为在一些年代久远的代码或者类库中大多是采用PHP那件函数trigger_error
函数来抛出错误的,异常处理器只能处理Exception不能处理Error,所以为了能够兼容老类库通常都会使用set_error_handler
注册全局的错误处理器方法,在方法中捕获到错误后将错误转化成异常再重新抛出,这样项目中所有的代码没有被正确执行时都能抛出异常实例了。
/*** Convert PHP errors to ErrorException instances.** @param int $level* @param string $message* @param string $file* @param int $line* @param array $context* @return void** @throws \ErrorException*/
public function handleError($level, $message, $file = '', $line = 0, $context = [])
{if (error_reporting() & $level) {throw new ErrorException($message, 0, $level, $file, $line);}
}
常用的Laravel异常实例
Laravel
中针对常见的程序异常情况抛出了相应的异常实例,这让开发者能够捕获这些运行时异常并根据自己的需要来做后续处理(比如:在catch中调用另外一个补救方法、记录异常到日志文件、发送报警邮件、短信)
在这里我列一些开发中常遇到异常,并说明他们是在什么情况下被抛出的,平时编码中一定要注意在程序里捕获这些异常做好异常处理才能让程序更健壮。
Illuminate\Database\QueryException
Laravel中执行SQL语句发生错误时会抛出此异常,它也是使用率最高的异常,用来捕获SQL执行错误,比方执行Update语句时很多人喜欢判断SQL执行后判断被修改的行数来判断UPDATE是否成功,但有的情景里执行的UPDATE语句并没有修改记录值,这种情况就没法通过被修改函数来判断UPDATE是否成功了,另外在事务执行中如果捕获到QueryException 可以在catch代码块中回滚事务。Illuminate\Database\Eloquent\ModelNotFoundException
通过模型的findOrFail
和firstOrFail
方法获取单条记录时如果没有找到会抛出这个异常(find
和first
找不到数据时会返回NULL)。Illuminate\Validation\ValidationException
请求未通过Laravel的FormValidator验证时会抛出此异常。Illuminate\Auth\Access\AuthorizationException
用户请求未通过Laravel的策略(Policy)验证时抛出此异常Symfony\Component\Routing\Exception\MethodNotAllowedException
请求路由时HTTP Method不正确Illuminate\Http\Exceptions\HttpResponseException
Laravel的处理HTTP请求不成功时抛出此异常
扩展Laravel的异常处理器
上面说了Laravel把\App\Exceptions\Handler
注册成功了全局的异常处理器,代码中没有被catch
到的异常,最后都会被\App\Exceptions\Handler
捕获到,处理器先上报异常记录到日志文件里然后渲染异常响应再发送响应给客户端。但是自带的异常处理器的方法并不好用,很多时候我们想把异常上报到邮件或者是错误日志系统中,下面的例子是将异常上报到Sentry系统中,Sentry是一个错误收集服务非常好用:
public function report(Exception $exception)
{if (app()->bound('sentry') && $this->shouldReport($exception)) {app('sentry')->captureException($exception);}parent::report($exception);
}
还有默认的渲染方法在表单验证时生成响应的JSON格式往往跟我们项目里统一的JOSN
格式不一样这就需要我们自定义渲染方法的行为。
public function render($request, Exception $exception)
{//如果客户端预期的是JSON响应, 在API请求未通过Validator验证抛出ValidationException后//这里来定制返回给客户端的响应.if ($exception instanceof ValidationException && $request->expectsJson()) {return $this->error(422, $exception->errors());}if ($exception instanceof ModelNotFoundException && $request->expectsJson()) {//捕获路由模型绑定在数据库中找不到模型后抛出的NotFoundHttpExceptionreturn $this->error(424, 'resource not found.');}if ($exception instanceof AuthorizationException) {//捕获不符合权限时抛出的 AuthorizationExceptionreturn $this->error(403, "Permission does not exist.");}return parent::render($request, $exception);
}
自定义后,在请求未通过FormValidator
验证时会抛出ValidationException
, 之后异常处理器捕获到异常后会把错误提示格式化为项目统一的JSON响应格式并输出给客户端。这样在我们的控制器中就完全省略了判断表单验证是否通过如果不通过再输出错误响应给客户端的逻辑了,将这部分逻辑交给了统一的异常处理器来执行能让控制器方法瘦身不少。
使用自定义异常
这部分内容其实不是针对Laravel
框架自定义异常,在任何项目中都可以应用我这里说的自定义异常。
我见过很多人在Repository
或者Service
类的方法中会根据不同错误返回不同的数组,里面包含着响应的错误码和错误信息,这么做当然是可以满足开发需求的,但是并不能记录发生异常时的应用的运行时上下文,发生错误时没办法记录到上下文信息就非常不利于开发者进行问题定位。
下面的是一个自定义的异常类
namespace App\Exceptions\;use RuntimeException;
use Throwable;class UserManageException extends RuntimeException
{/*** The primitive arguments that triggered this exception** @var array*/public $primitives;/*** QueueManageException constructor.* @param array $primitives* @param string $message* @param int $code* @param Throwable|null $previous*/public function __construct(array $primitives, $message = "", $code = 0, Throwable $previous = null){parent::__construct($message, $code, $previous);$this->primitives = $primitives;}/*** get the primitive arguments that triggered this exception*/public function getPrimitives(){return $this->primitives;}
}
定义完异常类我们就能在代码逻辑中抛出异常实例了
class UserRepository
{public function updateUserFavorites(User $user, $favoriteData){......if (!$executionOne) {throw new UserManageException(func_get_args(), 'Update user favorites error', '501');}......if (!$executionTwo) {throw new UserManageException(func_get_args(), 'Another Error', '502');}return true;}
}class UserController extends ...
{public function updateFavorites(User $user, Request $request){.......$favoriteData = $request->input('favorites');try {$this->userRepo->updateUserFavorites($user, $favoritesData);} catch (UserManageException $ex) {.......}}
}
除了上面Repository
列出的情况更多的时候我们是在捕获到上面列举的通用异常后在catch
代码块中抛出与业务相关的更细化的异常实例方便开发者定位问题,我们将上面的updateUserFavorites
按照这种策略修改一下
public function updateUserFavorites(User $user, $favoriteData)
{try {// database execution// database execution} catch (QueryException $queryException) {throw new UserManageException(func_get_args(), 'Error Message', '501' , $queryException);}return true;
}
在上面定义UserMangeException
类的时候第四个参数$previous
是一个实现了Throwable
接口类实例,在这种情景下我们因为捕获到了QueryException
的异常实例而抛出了UserManagerException
的实例,然后通过这个参数将QueryException
实例传递给PHP
异常的堆栈,这提供给我们回溯整个异常的能力来获取更多上下文信息,而不是仅仅只是当前抛出的异常实例的上下文信息, 在错误收集系统可以使用类似下面的代码来获取所有异常的信息。
while($e instanceof \Exception) {echo $e->getMessage();$e = $e->getPrevious();
}
异常处理是PHP
非常重要但又容易让开发者忽略的功能,这篇文章简单解释了Laravel
内部异常处理的机制以及扩展Laravel
异常处理的方式方法。更多的篇幅着重分享了一些异常处理的编程实践,这些正是我希望每个读者都能看明白并实践下去的一些编程习惯,包括之前分享的Interface
的应用也是一样。
Laravel核心解读--异常处理相关推荐
- Laravel核心解读--服务容器(IocContainer)
Laravel的核心是IocContainer, 文档中称其为"服务容器",服务容器是一个用于管理类依赖和执行依赖注入的强大工具,Laravel中的功能模块比如 Route.Elo ...
- Laravel核心解读--完结篇
过去一年时间写了20多篇文章来探讨了我认为的Larave框架最核心部分的设计思路.代码实现.通过更新文章自己在软件设计.文字表达方面都有所提高,在刚开始决定写Laravel源码分析地文章的时候我地期望 ...
- Laravel核心解读--完结篇 1
过去一年时间写了20多篇文章来探讨了我认为的Larave框架最核心部分的设计思路.代码实现.通过更新文章自己在软件设计.文字表达方面都有所提高,在刚开始决定写Laravel源码分析地文章的时候我地期望 ...
- Laravel核心解读--服务提供器(ServiceProvider)
服务提供器是所有 Laravel 应用程序引导中心.你的应用程序自定义的服务.第三方资源包提供的服务以及 Laravel 的所有核心服务都是通过服务提供器进行注册(register)和引导(boot) ...
- Laravel核心解读--控制器
控制器 控制器能够将相关的请求处理逻辑组成一个单独的类, 通过前面的路由和中间件两个章节我们多次强调Laravel应用的请求在进入应用后首现会通过Http Kernel里定义的基本中间件 protec ...
- Laravel核心解读--Console内核
Console内核 上一篇文章我们介绍了Laravel的HTTP内核,详细概述了网络请求从进入应用到应用处理完请求返回HTTP响应整个生命周期中HTTP内核是如何调动Laravel各个核心组件来完成任 ...
- Laravel核心解读--HTTP内核
Http Kernel Http Kernel是Laravel中用来串联框架的各个核心组件来网络请求的,简单的说只要是通过public/index.php来启动框架的都会用到Http Kernel,而 ...
- Laravel核心解读--Contracts契约
Contracts Laravel 的契约是一组定义框架提供的核心服务的接口, 例如我们在介绍用户认证的章节中到的用户看守器契约IllumninateContractsAuthGuard 和用户提供器 ...
- Laravel核心解读 -- 用户认证系统(基础介绍)
用户认证系统(基础介绍) 使用过Laravel的开发者都知道,Laravel自带了一个认证系统来提供基本的用户注册.登录.认证.找回密码,如果Auth系统里提供的基础功能不满足需求还可以很方便的在这些 ...
最新文章
- python音乐的数据抓取与分析_Python练习之抓取QQ音乐数据
- 重温.NET下Assembly的加载过程
- Time-of-Flight技术在距离测量和定位上的应用
- 数学建模 割平面算法求解整数规划基本原理与编程实现
- java .net 3des_Java.net3DES差异及互通
- mpython掌控板_用mpython x玩转掌控板——微信小程序 遇上掌控板
- element 点击控制expend的显示隐藏_四、ArcGIS Runtime SDK for iOS 100.X教程系列之图层控制显示隐藏...
- 1.14_radix_sort_基数排序
- 使用HttpWebRequest方式访问外部接口
- 程序员的灯下黑:如果你想考研究生或是研究生
- UnDistort Audio File(音频修复软件)官方正式版V1.0 | 音频修复软件哪个好用 | 专业修复音频的软件
- 2017年经典hadoop体系课程-徐培成-专题视频课程
- Java多线程+线程池
- [国家集训队2011]跳跳棋
- Linux企业运维篇——git+gitlab+jenkins+docker构成持续集成环境
- k8s介绍及与docker搭建集群
- UVM——TLM通信(1)
- 阅读java源代码的阅读器_TXT小说阅读器java代码
- 【微信小程序】echarts视图层会悬浮在所有视图之上问题原因
- pdf虚拟打印机下载后怎么把Word转图片?
热门文章
- Java实现发送邮件(可配置)忘记密码,发送邮件
- 两个Liunx服务器之间的文件夹迁移
- Codeforces Round #311 (Div. 2)B. Pasha and Tea 水题
- 解决C# Repeater内嵌Repeater 数据绑定,以及第二次层Repeater的ItemDataBound事件怎么处理...
- 26.如何实现关机时清空页面文件:
- cmd完成拷贝文件,并生成两个快捷脚本
- Shell编程(逻辑判断、文件目录属性判断、if特殊用法、case判断)
- VirtualBox下安装MacOS11
- Dubbo -- 系统学习 笔记 -- 目录
- layoutSubviews调用