Laravel中如何进行异常处理

2023-06-15 14:03:09 laravel 异常

这篇文章主要介绍“Laravel中如何进行异常处理”，在日常操作中，相信很多人在Laravel中如何进行异常处理问题上存在疑惑，小编查阅了各式资料，整理出简单好用的操作方法，希望对大家解答”Laravel中如何进行异常处理”的疑惑有所帮助！接下来，请跟着小编一起来学习吧！

基本配置

在开始研究异常处理类之前，让我们先来看看几个和异常相关且很重要的参数配置。

打开

config/app.php

文件，并仔细的看看下面的代码片段。

...
...
/*
|--------------------------------------------------------------------------
| 应用的调试模式
|--------------------------------------------------------------------------
|
| 当引用处于调试模式，将会显示错误产生式的详细堆栈信息
| 如果禁用，则只显示一个简单的错误页面
|
*/

'debug' => env('APP_DEBUG', false),
...
...

从参数的名称可以猜到，如果设置为

TRUE

，将有利于我们调试应用产生的错误。默认值由

.env

环境变量配置文件中的

APP_DEBUG

参数指定。

在开发环境下，建议你将它设置为

TRUE

，这样，通过清晰的错误堆栈信息，能很快的定位错误产生的原因并修复。另外，当处于正式环境是，我们需要通过环境变量的配置项来关闭它，当错误产生式将只显示通用的提示页面。

除了将错误显示在页面上，Laravel 也允许你将错误记录到日志文件中。现在，让我们来看看日志相关的配置，打开

config/app.php

文件，并仔细的看看下面的代码片段。

...
...
'log' => env('APP_LOG', 'single'),

'log_level' => env('APP_LOG_LEVEL', 'debug'),
...
...

Laravel 框架中，是使用 Monolog 库来记录日志的。你可以通过上面的配置项来配置 Monolog 库。

默认的日志文件保存路径为

storage/logs/laravel.log

，通常情况下，你无需更改它。与此同时，你可以通过

APP_LOG_LEVEL

来指定需要被记录到日志文件的错误级别。

前面介绍了异常和日志的基本配置。

接下来，我们看看 Laravel 应用默认的异常处理类。打开

app/Exceptions/Handler.php

文件.

expectsJson()) {
            return response()->json(['error' => 'Unauthenticated.'], 401);
        }

        return redirect()->guest(route('login'));
    }
}

上面的处理类主要包含2个功能：报告和显示所有的异常信息。

让我们仔细看一眼

report

方法。

/**
 * 报告或记录一个异常。
 *
 * 这是一个将异常发送给 Sentry 和 Bugsnag 等机构的好时机。
 *
 * @param  Exception  $exception
 * @return void
 */
public function report(Exception $exception)
{
    parent::report($exception);
}

report 方法用于将错误记录到日志文件中。同时，关注一项重要的

dontReport

属性，它列出了所有不应该被记录到日志的异常类别。

接下来，我们介绍

render

方法。

/**
 * 将异常渲染至 HTTP 响应值中。
 *
 * @param  IlluminateHttpRequest  $request
 * @param  Exception  $exception
 * @return IlluminateHttpResponse
 */
public function render($request, Exception $exception)
{
    return parent::render($request, $exception);
}

如果说

report

方法是用于记录或报告错误，那么

render

方法是用于将错误渲染显示在屏幕上。事实上，当异常发生时，这个方法决定了哪些内容将被展示给用户。

render

方法也允许你针对不同类别的错误自定义响应值，这部分内容我们将在下一章学习。

最后，

unauthenticated

方法处理了

AuthenticationException

异常，你能够在此决定当用户访问了一个未授权页面时所展示的内容。

自定义异常类

在这一节，我们将创建一个自定义异常类，用于处理

CustomException

类别的异常。创建自定义异常类背后的想法是更轻松地管理自定义异常同时显示自定义响应。

开始着手创建一个文件

app/Exceptions/CustomException.php

，内容如下所示。

view(
                'errors.custom',
                array(
                    'exception' => $this
                )
        );
    }
}

重要的是需要注意

CustomException

类必须继承核心

Exception

类。为了演示用途，我们仅仅讨论了 render 方法，但显然你也能够自定义修改 report 方法。

正如你看到的，在样例中我们将用户重定向至

errors.custom

错误页面。通过这种方式，你能够为特定类型的异常实现自定义的错误页面。

当然，我们需要创建一个关联的视图文件

resources/views/errors/custom.blade.php

。

Exception details: {{ $exception->getMessage() }}

登录后复制

这是一个相当简单的视图文件，只显示一行错误消息，不过你也可以按照自己希望的方式设计这个视图。

我们也需要在

app/Exceptions/Handler.php

文件的 render 方法中进行一些修改，保证我们的自定义异常类能够被调用。让我们将

app/Exceptions/Handler.php

文件中的 render 方法替换为以下内容。

...
...
/**
 * 将异常渲染至 HTTP 响应值中。
 *
 * @param  IlluminateHttpRequest  $request
 * @param  Exception  $exception
 * @return IlluminateHttpResponse
 */
public function render($request, Exception $exception)
{
    if ($exception instanceof AppExceptionsCustomException)  {
        return $exception->render($request);
    }

    return parent::render($request, $exception);
}
...
...

正如你所看到的，我们会在 render 方法中首先检查异常的类型。如果异常的类别是

AppExceptionsCustomException

，我们将调用这个类的 render 方法。

一切准备就绪。现在我们创建一个控制

app/Http/Controllers/ExceptionController.php

来测试自定义的异常类。

<?php
namespace AppHttpControllers;

use AppHttpControllersController;

class ExceptionController extends Controller
{
    public function index()
    {
        // 出错了，你可以抛出自定义的异常 CustomException
        throw new AppExceptionsCustomException('Something Went Wrong.');
    }
}

当然，你需要先在

routes/web.php

文件中添加相关的路由，就像下面一样。

// Exception routes
Route::get('exception/index', 'ExceptionController@index');

之后，你可以浏览 http://your-laravel-site.com/exception/ind... 地址来查看是否和预期的一样。一切正常的话，页面将显示我们前面配置

errors.custom

视图。

相关文章