關於Thinkphp6的日志問題
Thinkphp6的日志問題
日志級別
debug, info, notice, warning, error, critical, alert, emergency
其中有一個特別的級別:sql,專門用來記錄sql語句的
設置日志記錄級別
對於程序比較重要的業務模塊可以進行埋點(進行日志記錄)
可以通過設置日志記錄級別來開啟和關閉記錄
有助於排除錯誤(比每次出現錯誤去代碼裡增加記錄日志好多瞭)
# 修改 config/log.php # 配置 'level' => ['notice','warning'] # level 不為空時,隻記錄level中指定的錯誤級別 # level 為空時,記錄所有級別 $user = UserService::getInstance()->findByUsername('xieruixiang'); Log::warning("warning:{user}", compact('user')); # info 不再 level 中 則不會記錄 Log::info("I'm info");
單一日志
默認的tp日志是寫在當前日期(年月)目錄下的,如(runtime/admin/log/202204/30_info.log)
單一日志設置 修改config/log.php 中通道single屬性為true
設置單一日志後,將不再寫在時間目錄下(一直寫一個固定目錄),如(runtime/admin/log/single_info.log)
# 開啟單一日志 # channels.file.single # 這裡給file通道開啟單一日志 'single' => true
獨立日志
每一種日志級別的日志都歸類到一個文件之中(推薦開啟獨立日志)
設置 config/log.php 中通道apart_level屬性
# 設置 file 通道 info,notice,warning 級別開啟獨立日志 # channels.file.apart_level # 'apart_level' => ['info', 'notice', 'warning'] # 在 apart_level中的級別會獨立寫到一個文件中去 # write to runtime/admin/log/202204/30_warning.log Log::warning("I'm "); # write to runtime/admin/log/202204/30_info.log Log::info("I'm info"); # write to runtime/admin/log/202204/30_notice.log Log::notice("I'm notice");
日志的寫入時機
日志寫入時機提供兩種(實時寫入,程序執行完後寫入)
通過設置config/log.php中通道 realtime_write 屬性
# 這裡中斷程序的執行 # 如果 realtime_write = false 則無法寫到日志中去 # realtime_write = true 可以寫入日志中去 Log::warning("I'm "); # 如果 realtime_write = false # 又想實時寫入 # 可以通過 Log::write($msg, $type) 實時寫入 # $msg 信息 # $type 日志級別 Log::write("I'm write", 'warning'); die("日志將不會寫入");
日志通道
可以自定義通道
以增加郵件通道為例
將config/log.php 中通道type 改成自定義驅動類即可
# config/log.php channels 添加 'email' => [ 'type' => \app\admin\driver\EmailDriver::class, # 調試發送郵件時將其設置成實時比較好調試 'realtime_write' => true, ] # EmailDriver 需要實現 think\contract\LogHandlerInterface class EmailDriver implements LogHandlerInterface { public function save(array $log): bool { # 這裡進行發送郵件邏輯 # 想知道郵件發送邏輯的可以參考我的文章 《php發送郵件》 # 不想知道的 可以調用第三方封裝好的php發送郵件組件 return true; } }
使用郵件通道
# channel($channelName) 指定發送通道 # 不指定則使用默認發送通道 # config/log.php # 'default' => env('log.channel', 'file'), Log::channel('email')->info("this is info"); # 就能以郵件形式通知瞭
Thinkphp6異常處理與日志
異常處理
目標:返回json格式的異常信息 # url_route_must:true強制路由模式下
thinkphp6內置已瞭一個app\ExceptionHandle異常處理類可供使用
該類綁定在app目錄下面的provider.php文件中,直接修改該類的相關方法即可完成應用的自定義異常處理機制。
app\ExceptionHandle.php 異常處理類,重新定義render方法即可
#app\ExceptionHandle.php public function render($request, Throwable $e): Response { // app_debug模式下按原thinkphp6異常模式處理異常 if (env('app_debug')) { return parent::render($request, $e); } // 自定義json返回錯誤 if ($e instanceof ValidateException) { return json($e->getError(), 422); return json(['code' => 0, 'msg' => $e->getError()], 422); } // 自定義json返回異常 if ($e instanceof HttpException && $request->isAjax()) { return json(['code' => 0, 'msg' => $e->getMessage()], $e->getStatusCode()); } // 自定義json返回異常 if ($e instanceof HttpException) { return json(['code' => 0, 'msg' => $e->getMessage()]); } // 自定義json返回異常 return json(['code' => 0, 'msg' => 'Biny服務器錯誤']); }
目標:訪問未定義的路由時返回json格式的信息 # url_route_must:false 非強制路由模式下
php think make:controller Error –plain
public function index() { return json([ 'code' => 0, 'data' => 'Route is Not Found', 'msg' => 'success' ]); } public function __call($name, $arguments) { return json([ 'code' => 0, 'data' => 'Route is Not Found', 'msg' => 'success' ]); }
日志
- DEBUG模式下默認記錄error級別和sql執行語句日志
- 非DEBUG模式默認僅記錄error級別日志
- DEBUG模式在根目錄增加.env文件 設置APP_DEBUG = false/true
手動記錄日志
方法 | 描述 |
---|---|
record() | Log::record(‘record方法記錄的日志信息不是實時保存的’,‘info’); |
write() | Log::write(‘要實時記錄的話,可以采用write方法’,‘info’); |
系統在請求結束後會自動調用Log::save方法統一進行日志信息寫入
關閉日志
Log::close(); //手動關閉本次請求的日志寫入
更多日志配置於app\config\log.php文件中配置,參考官方文檔配置即可
官方日志文檔
總結
以上為個人經驗,希望能給大傢一個參考,也希望大傢多多支持WalkonNet。
推薦閱讀:
- Django項目如何正確配置日志(logging)
- PHP實現RabbitMQ消息列隊的示例代碼
- ThinkPHP基於think-queue的隊列插件實現消息推送
- 如何在Python項目中引入日志
- Postgresql的日志配置教程詳解