YII2框架中日志的配置與使用方法實例分析

更新時間：2020年03月18日 10:54:25 作者：懷素真

這篇文章主要介紹了YII2框架中日志的配置與使用方法,結合實例形式分析了YII2框架中日志的功能、配置方法及使用相關操作技巧,需要的朋友可以參考下

本文實例講述了YII2框架中日志的配置與使用方法。分享給大家供大家參考，具體如下：

YII2中給我們提供了非常方便的日志組件，只需要簡單配置一下就可以使用。

我們在config/web.php中配置如下：

return [
	//log必須在bootstrap期間就被加載，便于及時調(diào)度日志消息到目標
	'bootstrap' => ['log'],

	'components' => [
		'log' => [
			//消息跟蹤級別，設置yii\log\Dispatcher::traceLevel屬性
			//YII_DEBUG開啟時，日志消息被記錄時，追加最多3個調(diào)用堆棧信息
			'traceLevel' => YII_DEBUG ? 3 : 0,
			//日志目標，可定義多個
			'targets' => [
				[
					//日志處理器類
					'class' => 'yii\log\FileTarget',
					//日志記錄的級別
					'levels' => ['error', 'warning'],
					//定義日志文件
					'logFile' => '@runtime/logs/test.log',
				],
			],
		],
	],
];

通過下面5個方法，來寫入我們自已的日志

//跟蹤
Yii::trace('我是一條跟蹤');
//消息
YII::info('我是一條消息');
//調(diào)試
YII::debug('我是一條調(diào)試');
//警告
YII::warning('我是一條警告');
//錯誤
YII::error('我是一條錯誤');

注意我們上面定義日志的levels為['error', 'warning']，所以日志只會記錄這兩個級別的信息。

有些時候我們并不希望把所有日志寫在一起，我們會根據(jù)不同模塊來寫日志，這樣以便區(qū)分，這就需要用到日志的分類了。

重新配置config/web.php如下：

'log' => [
	'traceLevel' => YII_DEBUG ? 3 : 0,
	'targets' => [
		[
			//日志處理器類，這里我改用數(shù)據(jù)庫存日志了
			'class' => 'yii\log\DbTarget',
			//日志記錄的級別
			'levels' => ['error', 'warning'],
			//追加上下文信息，默認YII會包含PHP全局變量，這里我們不需要，設為空。
			'logVars' => [],
			//定義分類
			'categories' => ['db'],
		],
		[
			//日志處理器類，這里我改用數(shù)據(jù)庫存日志了
			'class' => 'yii\log\DbTarget',
			//日志記錄的級別
			'levels' => ['error', 'warning'],
			//追加上下文信息，默認YII會包含PHP全局變量，這里我們不需要，設為空。
			'logVars' => [],
			//定義分類
			'categories' => ['pay'],
		],
	],
],

通過如下方法，添加我們的日志

//警告
YII::warning('我是一條數(shù)據(jù)庫警告', 'db');
//錯誤
YII::error('我是一條數(shù)據(jù)庫錯誤', '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'],
		],
		[
			//日志處理器類，這里我改用數(shù)據(jù)庫存日志了
			'class' => 'yii\log\DbTarget',
			//日志記錄的級別，這里演示設為info
			'levels' => ['info'],
			//定義分類
			'categories' => ['yii\db\*'],
		],
	],
],

然后我們操作一下數(shù)據(jù)庫，看是否日志記錄了。

<?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'],
		],
		[
			//日志處理器類，這里我改用數(shù)據(jù)庫存日志了
			'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,
	//消息被存放在一個數(shù)組里，積累到一定數(shù)量，才會被刷新到日志target
	//通過flushInterval設置消息刷新到日志target的數(shù)量
	'flushInterval' => 100,
	'targets' => [
		[
			'class' => 'yii\log\FileTarget',
			'levels' => ['error', 'warning'],
		],
		[
			//日志處理器類，這里我改用數(shù)據(jù)庫存日志了
			'class' => 'yii\log\DbTarget',
			//當消息刷新到日志對象時，并不會立即導出，只有累積到一定數(shù)量才會導出
			//通過exportInterval來設置這個導出數(shù)量
			'exportInterval' => 100,
			'levels' => ['error', 'warning'],
			//定義分類
			'categories' => ['db'],
		],
	],
],

有人會問YII2設置flushInterval和exportInterval的作用是什么，因為在一些系統(tǒng)中日志的操作會很頻繁，如果頻繁的讀取文件或數(shù)據(jù)庫來寫日志，會造成嚴重的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相關內(nèi)容感興趣的讀者可查看本站專題：《Yii框架入門及常用技巧總結》、《php優(yōu)秀開發(fā)框架總結》、《smarty模板入門基礎教程》、《php面向?qū)ο蟪绦蛟O計入門教程》、《php字符串(string)用法總結》、《php+mysql數(shù)據(jù)庫操作入門教程》及《php常見數(shù)據(jù)庫操作技巧匯總》

希望本文所述對大家基于Yii框架的PHP程序設計有所幫助。

您可能感興趣的文章:

YII2
日志

PHP處理二進制數(shù)據(jù)的實現(xiàn)方法
下面小編就為大家?guī)硪黄狿HP處理二進制數(shù)據(jù)的實現(xiàn)方法。小編覺得挺不錯的，現(xiàn)在就分享給大家，也給大家做個參考。一起跟隨小編過來看看吧
2016-06-06
PHP設計模式之工廠模式（Factory）入門與應用詳解
這篇文章主要介紹了PHP設計模式之工廠模式（Factory）,結合實例形式詳細分析了PHP工廠模式的概念、原理、基本應用與相關操作注意事項,需要的朋友可以參考下
2019-12-12
淺談Laravel核心解讀之Console內(nèi)核
這篇文章主要介紹了淺談Laravel核心解讀之Console內(nèi)核，小編覺得挺不錯的，現(xiàn)在分享給大家，也給大家做個參考。一起跟隨小編過來看看吧
2018-12-12
VPS中使用LNMP安裝WordPress教程
這篇文章主要介紹了VPS中使用LNMP安裝WordPress教程,需要的朋友可以參考下
2014-12-12
Zend的Registry機制的使用說明
本篇文章介紹了，Zend的Registry機制的使用說明。需要的朋友參考下
2013-05-05
利用中國天氣預報接口實現(xiàn)簡單天氣預報
這篇文章主要介紹了利用中國天氣預報接口實現(xiàn)簡單天氣預報的示例，大家參考使用吧
2014-01-01
微博短鏈接算法php版本實現(xiàn)代碼
將長網(wǎng)址md5生成32位簽名串,分為4段, 每段8個字節(jié)
2012-09-09
php桌面中心(一) 創(chuàng)建數(shù)據(jù)庫
php桌面中心(一) 創(chuàng)建數(shù)據(jù)庫...
2007-03-03
Joomla實現(xiàn)組件中彈出一個模式(modal)窗口的方法
這篇文章主要介紹了Joomla實現(xiàn)組件中彈出一個模式(modal)窗口的方法,列舉了2種常用的Joomla彈出模式窗口的技巧供大家對比參考,需要的朋友可以參考下
2016-05-05
關于尾遞歸的使用詳解
本篇文章介紹了，關于尾遞歸的使用詳解。需要的朋友參考下
2013-05-05