首頁 > 軟體

關於Thinkphp6的紀錄檔問題

2023-03-23 22:01:19

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' => appadmindriverEmailDriver::class,
            # 偵錯傳送郵件時將其設定成實時比較好偵錯
            'realtime_write' => true,
        ]
        
       # EmailDriver 需要實現 thinkcontractLogHandlerInterface
       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內建已了一個appExceptionHandle例外處理類可供使用

該類繫結在app目錄下面的provider.php檔案中,直接修改該類的相關方法即可完成應用的自定義例外處理機制。

appExceptionHandle.php 例外處理類,重新定義render方法即可

#appExceptionHandle.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(); //手動關閉本次請求的紀錄檔寫入

更多紀錄檔設定於appconfiglog.php檔案中設定,參考官方檔案設定即可

官方紀錄檔檔案

總結

以上為個人經驗,希望能給大家一個參考,也希望大家多多支援it145.com。


IT145.com E-mail:sddin#qq.com