laravel 基礎教程 —— 錯誤和日志

錯誤和日志

簡介

當你開始一個新的 laravel 項目時,你一定會需要到對錯誤和異常的處理,而這些 laravel 都已經為你配置好了。另外,laravel 還集成了 Monolog 日志組件庫,它提供了各種強大的日志處理器。

配置

錯誤詳情

你的應用中通過瀏覽器來展示的錯誤詳情程度是通過你的 config/app.php 配置文件中的 debug 選項來進行配置的。默認的該配置項遵從 .env 文件中的 APP_DEBUG 環境變量。

日志模式

larvel 提供了幾種開箱即用的日志模式:singledailysyslogerrorlog。比如,如果你希望使用每日日期文件記錄日志來替換默認的單文件記錄方式。你可以簡單的在 config/app.php 配置文件中該設置 log 選項的值:

'log' => 'daily'

當使用 daily 日志模式時,laravel 默認只會保留 5 天內的日志文件。如果你需要保留更多的日志文件,你需要在 config/app.php 文件中添加 log_max_files 選項:

'log_max_files' => 30

自定義 Monolog 配置

如果你想要在應用中對 Monolog 的配置擁有完全的控制,你可以使用應用的 configureMonologUsing 方法。你應該在 bootstrap/app.php 文件中進行方法的調用,并且你應該把它放置在返回 $app 之前:

$app->configureMonologUsing(function ($monolog) {
  $monolog->pushHandler(...); 
});

return $app;

默認的,laravel 會記錄所有等級的日志。在生產環境中,你可能會想要只記錄某些等級的日志,你可以通過在 app.php 配置文件中添加 log_level 選項來做到。laravel 會記錄這個等級的日志和比這個等級日志更高級的日志。比如,設置 log_levelerror,那么它會記錄 errorcriticalalertemergency 等級的消息:

'log_level' => app_env('APP_LOG_LEVEL', 'debug'),

異常處理

所有的異常都會在 App\Exceptions\Handler 類中進行處理。該類包含了兩個方法:reportrender。我們將會對這個兩個方法進行詳細的剖析。

Report 方法

report 方法被用來記錄異常或者發送異常到其他的服務中去,比如 BugSnag 或者 Sentry。默認的,report 方法只是簡單的傳遞異常到異常記錄的基類中。事實上,你可以自由的按照自己的希望去記錄異常。

比如,如果你希望用不同的方式來記錄不同類型的異常,你可以使用 PHP 的 instanceof 方法來進行篩選操作:

/**
 * Report or log an exception.
 *
 * This is a great spot to send exceptions to Sentry, Bugsnag, etc.
 *
 * @param \Exception $e
 * @return void
 */
 public function report(Exception $e)
 {
   if ($e instanceof CustomException) {
     //
   }

   return parent::report($e);
 }

根據類型來忽略異常

異常處理類的 $dontReport 屬性包含了一個需要忽略的異常類數組。這個數組中類型的異常將不會被記錄。默認的 404 類型的錯誤就不會記錄在日志文件中,你可以按需在這個數組中進行追加忽略的異常類名。

Render 方法

render 方法用來將異常轉換為傳遞回瀏覽器的響應信息。默認異常會被傳遞到基類并返回一個響應。事實上,你可以自由的按需進行定制化響應:

/**
 * Render an exception into an HTTP response.
 *
 * @param \Illuminate\Http\Request $request
 * @param \Exception $e
 * @return \Illuminate\Http\Response
 */
public function render($request, Exception $e)
{
  if ($e instanceof CustomException) {
    return response()->view('errors.custom', [], 500);
  }

  return parent::render($request, $e);
}

HTTP 異常

有些異常是直接從服務器來描述 HTTP 的錯誤代碼。比如,這可能是一個“頁面沒有找到”的錯誤(404),一個“未授權”的錯誤(401)或者是一個“開發錯誤”(500)。為了在你的應用中快速的生成這種類型的響應,你可以使用下面的方式:

abort(404);

abort 方法會立即的提出一個異常,該異常會在異常處理中被渲染。你也可以在該方法中提供一個可選的響應文本:

abort(403, 'Unauthorized action.');

該方法可以在請求的生命周期中的任意時間點使用。

自定義 HTTP 錯誤頁面

laravel 使根據 HTTP 響應狀態碼來創建自定義的錯誤頁面非常簡單。比如,你可能希望自定義一個錯誤頁面來提供給 404 HTTP 狀態碼。你可以創建一個 resoucres/views/errors/404.blade.php 文件。該文件會在應用拋出 404 錯誤時自動的提供服務。

在該目錄下的視圖的命名應該與 HTTP 狀態碼相對應。

日志

laravel 的日志系統是基于強大的 Monolog 類庫的。默認的,laravel 設置了 storage/logs 目錄來存放日志文件。你可以使用 Log 假面來記錄日志信息:

<?php

namespace App\Http\Controllers;

use Log;
use App\User;
use App\Http\Controllers\Controller;

class UserController extends Controller 
{
  /**
   * Show the profile for the given user.
   * 
   * @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 規范定義了 8 中日志等級:emergency,alert,critical,error,warning,notice,infodebug

Log::emergency($error);
Log::alert($error);
Log::critical($error);
Log::error($error);
Log::warning($error);
Log::notice($error);
Log::info($error);
Log::debug($error);

上下文信息

你可以在入日志方法中傳遞一個上下文數據的數組,這個上下文數據將會被格式化并在日志信息中顯示:

Log::info('User failed to login.', ['id' => $user->id]);

訪問底層的 Monolog 實例

Monolog 擁有多種額外日志處理方法。如果你需要,你可以在 laravel 中使用下面的方式訪問底層的 Monolog 實例:

$monolog = Log::getMonolog();
最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 228,786評論 6 534
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 98,656評論 3 419
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 176,697評論 0 379
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,098評論 1 314
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,855評論 6 410
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 55,254評論 1 324
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,322評論 3 442
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,473評論 0 289
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 49,014評論 1 335
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 40,833評論 3 355
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 43,016評論 1 371
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,568評論 5 362
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,273評論 3 347
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,680評論 0 26
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,946評論 1 288
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,730評論 3 393
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 48,006評論 2 374

推薦閱讀更多精彩內容

  • Spring Cloud為開發人員提供了快速構建分布式系統中一些常見模式的工具(例如配置管理,服務發現,斷路器,智...
    卡卡羅2017閱讀 134,787評論 18 139
  • 原文鏈接 必備品 文檔:Documentation API:API Reference 視頻:Laracasts ...
    layjoy閱讀 8,619評論 0 121
  • 必備品文檔:DocumentationAPI: API Reference視頻:Laracasts速查表:Lara...
    ethanzhang閱讀 5,758評論 0 68
  • 校園失物招領平臺開發 ——基于laravel框架構建最小內容管理系統 摘要 ? 針對目前大學校園人口密度大、人群活...
    藍蓮花xzsky閱讀 6,218評論 8 54
  • 無人能從這個讓他厭惡的世界逃離 像螨蟲般的攀爬 在枯盡的細縫里尋找死絕的生機 是生命存在的意義 是鬼魂在人間的嚎叫...
    果子_你好閱讀 288評論 0 0