錯誤與日志 · laravel 5.5 中文文檔

# Laravel 的錯誤和日志記錄 - [簡介](#introduction) - [配置](#configuration) - [顯示錯誤信息](#error-detail) - [日志存儲](#log-storage) - [日志級別](#log-severity-levels) - [自定義 Monolog 日志](#custom-monolog-configuration) - [異常處理](#the-exception-handler) - [Report 方法](#report-method) - [Render 方法](#render-method) - [自定義異常的 report & render 方法](#renderable-exceptions) - [HTTP 異常](#http-exceptions) - [自定義 HTTP 錯誤頁面](#custom-http-error-pages) - [記錄](#logging) <a name="introduction"></a> ## 簡介當您啟動一個新的 Laravel 項目時，錯誤和異常處理就已為您配置就緒。應用程序觸發的所有異常都被 `App\Exceptions\Handler` 類記錄下來，然后渲染給用戶。我們將在本文檔中深入介紹此類。 Laravel 使用 [Monolog](https://github.com/Seldaek/monolog) 庫進行日志處理，它能為各種強大的日志處理程序提供支持。Laravel 配置了多幾種日志處理程序，方便您在單個日志文件、多個交替日志文件之間進行選擇寫入，或將錯誤信息寫入系統日志。 <a name="configuration"></a> ## 配置 <a name="error-detail"></a> ### 顯示錯誤信息 `config/app.php` 文件的 `debug` 選項，決定了是否向用戶顯示錯誤信息。默認情況下，此選項設置為存儲在 `.env` 文件中的 `APP_DEBUG` 環境變量中。本地開發環境下，應該將 `APP_DEBUG` 環境變量設置為 `true` 。在您的生產環境中，此值應始終保持 `false` 。如果你在生產中將該值設置為 `true` ，則可能會將敏感的配置值暴露給應用程序的最終用戶。 <a name="log-storage"></a> ### 日志存儲 Laravel 的日志存儲功能開箱即用，它支持 `single` 、`daily` 、 `syslog` 和 `errorlog` 日志寫入模式。要配置 Laravel 使用的存儲機制，應該修改 `config/app.php` 配置文件中的 `log` 選項。例如，如果您希望每天產生一個日志文件而不是單個文件，則應將 `app` 配置文件中的 `log` 值設置為 `daily`： 'log' => 'daily' #### 日志文件保存天數限制在使用 `daily` 日志模式時，Laravel 的日志文件將默認只保留五天。如果您想調整日志文件的數量，您可以在 `app` 配置文件中為 `log_max_files` 配置項添加一個值： 'log_max_files' => 30 <a name="log-severity-levels"></a> ### 日志級別使用 Monolog 時，日志消息可能具有不同的嚴重級別。默認情況下，Laravel 將存儲全部日志級別。但是，在生產環境中，您可能希望通過將 `log_level` 選項添加到 `app.php` 配置文件中來配置應當記錄的最低的日志級別。一旦配置了此選項，Laravel 將記錄大于或等于指定嚴重級別的所有級別。例如，默認的 `log_level` 被設置為 `error` 那么將會記錄 **error** , **critical** , **alert** 和 **emergency** 日志信息： 'log_level' => env('APP_LOG_LEVEL', 'error'), > {tip} Monolog 識別以下嚴重級別 - 從低到高為: `debug`, `info`, `notice`, `warning`, `error`, `critical`, `alert`, `emergency`。 <a name="custom-monolog-configuration"></a> ### 自定義 Monolog 日志如果你想讓你的應用程序完全控制 Monolog ，可以使用應用程序的 `configureMonologUsing` 方法。你應該放置一個回調方法到 `bootstrap/app.php` 文件中，在文件返回 `$app` 變量之前，調用這個方法： $app->configureMonologUsing(function ($monolog) { $monolog->pushHandler(...); }); return $app; <a name="the-exception-handler"></a> ## 異常處理 <a name="report-method"></a> ### Report 方法所有異常都由 `App\Exceptions\Handler` 類處理。這個類包含兩個方法：`report` 和 `render` 。我們將詳細研究這些方法。 `report` 方法用于記錄異常或將其發送到外部服務，如 [Bugsnag](https://bugsnag.com) 或 [Sentry](https://github.com/getsentry/sentry-laravel)。默認情況下，`report` 方法只是簡單地將異常傳遞給記錄異常的基類。但是，你可以自由選擇任何方式來進行處理。例如，如果您需要以不同的方式報告不同類型的異常，您可以使用 PHP `instanceof` 比較運算符： /** * 報告或記錄一個異常 * * 這是個給 Bugsnag 或 Sentry 發送異常的好地方 * * @param \Exception $exception * @return void */ public function report(Exception $exception) { if ($exception instanceof CustomException) { // } return parent::report($exception); } #### `report` 輔助函數某些時候您可能想要報告一個異常，但又想繼續處理當前的請求。 `report` 輔助函數允許您使用異常 handler 的 `report` 方法快速報告一個異常而不拋出一個錯誤頁面： public function isValid($value) { try { // 校驗值... } catch (Exception $e) { report($e); return false; } } #### 通過類型忽略異常異常 handler 的 `$dontReport` 屬性包含不會記錄的異常類型數組。例如，404錯誤導致的異常以及其他幾種類型的錯誤不會寫入您的日志文件。您可以根據需要向此數組添加其他異常類型： /** * 不應報告的異常類型列表 * * @var array */ protected $dontReport = [ \Illuminate\Auth\AuthenticationException::class, \Illuminate\Auth\Access\AuthorizationException::class, \Symfony\Component\HttpKernel\Exception\HttpException::class, \Illuminate\Database\Eloquent\ModelNotFoundException::class, \Illuminate\Validation\ValidationException::class, ]; <a name="render-method"></a> ### Render 方法 `render` 方法負責將給定的異常轉換成一個需要回傳給瀏覽器的 HTTP 響應。默認情況下，異常會被傳遞給為您生成響應的基類。但是，您可以自由檢查異常類型或返回您自己的自定義響應： /** * 渲染異常并添加到 HTTP 響應中. * * @param \Illuminate\Http\Request $request * @param \Exception $exception * @return \Illuminate\Http\Response */ public function render($request, Exception $exception) { if ($exception instanceof CustomException) { return response()->view('errors.custom', [], 500); } return parent::render($request, $exception); } <a name="renderable-exceptions"></a> ### 自定義異常的 report & render 方法您并不一定要在異常 handler 中的 `report` 和 `render` 方法中處理異常，而是可以直接在自定義異常中定義 `report` 和 `render` 方法。如果這些方法存的在話，框架會自動調用他們： <?php namespace App\Exceptions; use Exception; class RenderException extends Exception { /** * 報告異常 * * @return void */ public function report() { // } /** * 報告異常 * * @param \Illuminate\Http\Request * @return void */ public function render($request) { return response(...); } } <a name="http-exceptions"></a> ## HTTP 異常一些異常描述了來自服務器的 HTTP 錯誤代碼。例如這可能是「找不到頁面」錯誤（404），「未授權錯誤」（401）甚至是由開發者造成的 500 錯誤。你可以使用 `abort` 輔助函數，在應用程序中的任何地方生成這樣的響應： abort(404); `abort` 輔助函數將立即創建一個被異常 handler 渲染過的異常。此外，您還可以提供響應文本： abort(403, 'Unauthorized action.'); <a name="custom-http-error-pages"></a> ### 自定義 HTTP 錯誤頁面 Laravel 可以輕松地顯示各種 HTTP 狀態代碼的自定義錯誤頁面。例如，如果您要自定義 404 HTTP 狀態代碼的錯誤頁面，請創建一個 `resources/views/errors/404.blade.php` 。此文件將會用于渲染您應用中產生的所有 404 錯誤。此目錄中的視圖文件命名應與它們對應的 HTTP 狀態代碼匹配。由 `abort` 函數引發的 `HttpException` 實例將作為 `$exception` 變量傳遞給視圖。 <h2>{{ $exception->getMessage() }}</h2> <a name="logging"></a> ## 記錄 Laravel 在強大的 [Monolog](https://github.com/seldaek/monolog) 庫上提供了一個簡單的抽象層。默認情況下，Laravel 日志文件的存儲目錄被配置為 `storage/logs` 。您可以使用 `Log` [facade](/docs/{{version}}/facades) 將信息寫入日志： <?php namespace App\Http\Controllers; use App\User; use Illuminate\Support\Facades\Log; use App\Http\Controllers\Controller; class UserController extends Controller { /** * 顯示給用戶的配置. * * @param int $id * @return Response */ public function showProfile($id) { Log::info('Showing user profile for user: '.$id); return view('user.profile', ['user' => User::findOrFail($id)]); } } 該日志記錄器提供八種 [RFC 5424](https://tools.ietf.org/html/rfc5424) 定義的日志級別：**emergency**，**alert**，**critical**，**error**，**warning**，**notice**，**info** 和 **debug**。 Log::emergency($message); Log::alert($message); Log::critical($message); Log::error($message); Log::warning($message); Log::notice($message); Log::info($message); Log::debug($message); #### 上下文信息上下文數據也可以以數組格式傳遞給日志方法。此上下文數據將被格式化并與日志消息一起顯示： Log::info('User failed to login.', ['id' => $user->id]); #### 訪問底層 Monolog 實例 Monolog 還提供了多種額外的 handler 用來記錄日志。如果需要，您可以訪問 Laravel 底層的 Monolog 實例： $monolog = Log::getMonolog(); ## 譯者署名 | 用戶名 | 頭像 | 職能 | 簽名 | |---|---|---|---| |<br>[@ChrisonWang](https://github.com/ChrisonWang) | <img class="avatar-66 rm-style" src="https://avatars0.githubusercontent.com/u/16531947?v=4&s=80"> | <br>翻譯 | <br>[@王欣](https://www.linkedin.com/in/ChrisonWang/) at LinkedIn| --- > {note} 歡迎任何形式的轉載，但請務必注明出處，尊重他人勞動共創開源社區。 > > 轉載請注明：本文檔由 Laravel China 社區 [laravel-china.org](https://laravel-china.org) 組織翻譯，詳見 [翻譯召集帖](https://laravel-china.org/topics/5756/laravel-55-document-translation-call-come-and-join-the-translation)。 > > 文檔永久地址： https://d.laravel-china.org