本文實例講述了YII2框架中日志的配置與使用方法。分享給大家供大家參考,具體如下:
YII2中給我們提供了非常方便的日志組件,只需要簡單配置一下就可以使用。
我們在config/web.php中配置如下:
return [
//log必須在bootstrap期間就被加載,便于及時調度日志消息到目標
'bootstrap' => ['log'],
'components' => [
'log' => [
//消息跟蹤級別,設置yii\log\Dispatcher::traceLevel屬性
//YII_DEBUG開啟時,日志消息被記錄時,追加最多3個調用堆棧信息
'traceLevel' => YII_DEBUG ? 3 : 0,
//日志目標,可定義多個
'targets' => [
[
//日志處理器類
'class' => 'yii\log\FileTarget',
//日志記錄的級別
'levels' => ['error', 'warning'],
//定義日志文件
'logFile' => '@runtime/logs/test.log',
],
],
],
],
];
通過下面5個方法,來寫入我們自已的日志
//跟蹤
Yii::trace('我是一條跟蹤');
//消息
YII::info('我是一條消息');
//調試
YII::debug('我是一條調試');
//警告
YII::warning('我是一條警告');
//錯誤
YII::error('我是一條錯誤');
注意我們上面定義日志的levels為['error', 'warning'],所以日志只會記錄這兩個級別的信息。
有些時候我們并不希望把所有日志寫在一起,我們會根據不同模塊來寫日志,這樣以便區(qū)分,這就需要用到日志的分類了。
重新配置config/web.php如下:
'log' => [
'traceLevel' => YII_DEBUG ? 3 : 0,
'targets' => [
[
//日志處理器類,這里我改用數據庫存日志了
'class' => 'yii\log\DbTarget',
//日志記錄的級別
'levels' => ['error', 'warning'],
//追加上下文信息,默認YII會包含PHP全局變量,這里我們不需要,設為空。
'logVars' => [],
//定義分類
'categories' => ['db'],
],
[
//日志處理器類,這里我改用數據庫存日志了
'class' => 'yii\log\DbTarget',
//日志記錄的級別
'levels' => ['error', 'warning'],
//追加上下文信息,默認YII會包含PHP全局變量,這里我們不需要,設為空。
'logVars' => [],
//定義分類
'categories' => ['pay'],
],
],
],
通過如下方法,添加我們的日志
//警告
YII::warning('我是一條數據庫警告', 'db');
//錯誤
YII::error('我是一條數據庫錯誤', 'db');
//警告
YII::warning('我是一條支付警告', 'pay');
//錯誤
YII::error('我是一條支付錯誤', 'pay');
由于上面的配置我們使用了DbTarget,我們還需要添加一張日志表,用于記錄我們的日志,進入項目目錄。運行如下命令:
yii migrate --migrationPath=@yii/log/migrations
當然categories我們也可以指定為YII的類
'log' => [
'traceLevel' => YII_DEBUG ? 3 : 0,
'targets' => [
[
'class' => 'yii\log\FileTarget',
'levels' => ['error', 'warning'],
],
[
//日志處理器類,這里我改用數據庫存日志了
'class' => 'yii\log\DbTarget',
//日志記錄的級別,這里演示設為info
'levels' => ['info'],
//定義分類
'categories' => ['yii\db\*'],
],
],
],
然后我們操作一下數據庫,看是否日志記錄了。
?php
namespace app\controllers;
use YII;
use yii\db\Query;
use yii\web\Controller;
class TestController extends Controller
{
public function actionTest()
{
$data = (new Query())->from('{{%user}}')
->where('id=:id', [':id' => '1'])
->all();
var_dump($data);
}
}
日志消息的格式化,我們可以自定義日志的前綴。
'log' => [
'traceLevel' => YII_DEBUG ? 3 : 0,
'targets' => [
[
'class' => 'yii\log\FileTarget',
'levels' => ['error', 'warning'],
],
[
//日志處理器類,這里我改用數據庫存日志了
'class' => 'yii\log\DbTarget',
'levels' => ['error', 'warning'],
//定義分類
'categories' => ['db'],
//定義前綴
'prefix' => function($message) {
$uid = !empty(YII::$app->user->id) ? YII::$app->user->id : '-';
$mid = !empty(YII::$app->module->id) ? YII::$app->module->id : '-';
$cid = !empty(YII::$app->controller->id) ? YII::$app->controller->id : '-';
$aid = !empty(YII::$app->controller->action->id) ? YII::$app->controller->action->id : '-';
return "[{$uid}][{$mid}/{$cid}/{$aid}]";
},
],
],
],
使用如下代碼,記錄日志,查看效果
YII::warning('我是警告!!!', 'db');
YII::error('我是錯誤!!!', 'db');
由于沒有登陸和分模塊,所以沒獲取到用戶ID和模塊ID,不過控制器ID和方法ID都獲取到了。
消息的刷新和導出
'log' => [
'traceLevel' => YII_DEBUG ? 3 : 0,
//消息被存放在一個數組里,積累到一定數量,才會被刷新到日志target
//通過flushInterval設置消息刷新到日志target的數量
'flushInterval' => 100,
'targets' => [
[
'class' => 'yii\log\FileTarget',
'levels' => ['error', 'warning'],
],
[
//日志處理器類,這里我改用數據庫存日志了
'class' => 'yii\log\DbTarget',
//當消息刷新到日志對象時,并不會立即導出,只有累積到一定數量才會導出
//通過exportInterval來設置這個導出數量
'exportInterval' => 100,
'levels' => ['error', 'warning'],
//定義分類
'categories' => ['db'],
],
],
],
有人會問YII2設置flushInterval和exportInterval的作用是什么,因為在一些系統(tǒng)中日志的操作會很頻繁,如果頻繁的讀取文件或數據庫來寫日志,會造成嚴重的IO消耗,降低系統(tǒng)性能,這也是YII2的一個優(yōu)化吧。
當然有些時候一些長時間在控制臺運行的程序,需要立即顯示日志,那么可以通過如下配置:
'log' => [
'traceLevel' => YII_DEBUG ? 3 : 0,
'flushInterval' => 1,
'targets' => [
[
'class' => 'yii\log\FileTarget',
'levels' => ['error', 'warning'],
],
[
'class' => 'yii\log\FileTarget',
'exportInterval' => 1,
'levels' => ['error', 'warning'],
//定義分類
'categories' => ['db'],
],
],
],
將flushInterval和exportInterval分別設為1。
有些時候我們需要人為的開啟和關閉某些日志目標,這時就需要我們?yōu)槊總€日志目標設個鍵,以區(qū)分。
'log' => [
'traceLevel' => YII_DEBUG ? 3 : 0,
'targets' => [
'pay' => [
'class' => 'yii\log\DbTarget',
'levels' => ['error', 'warning'],
'categories' => ['pay'],
],
'db' => [
'class' => 'yii\log\DbTarget',
'levels' => ['error', 'warning'],
'categories' => ['db'],
],
],
],
然后通過如下,進行開啟和關閉:
//關閉
Yii::$app->log->targets['db']->enabled = false;
//開啟
Yii::$app->log->targets['db']->enabled = true;
更多關于Yii相關內容感興趣的讀者可查看本站專題:《Yii框架入門及常用技巧總結》、《php優(yōu)秀開發(fā)框架總結》、《smarty模板入門基礎教程》、《php面向對象程序設計入門教程》、《php字符串(string)用法總結》、《php+mysql數據庫操作入門教程》及《php常見數據庫操作技巧匯總》
希望本文所述對大家基于Yii框架的PHP程序設計有所幫助。
您可能感興趣的文章:- yii2.0框架實現上傳excel文件后導入到數據庫的方法示例
- YII2框架中查詢生成器Query()的使用方法示例
- YII2框架中使用RBAC對模塊,控制器,方法的權限控制及規(guī)則的使用示例
- YII2框架中behavior行為的理解與使用方法示例
- YII2 全局異常處理深入講解