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


Posted in PHP onMarch 18, 2020

本文实例讲述了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('我是一条错误');

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

注意我们上面定义日志的levels为['error', 'warning'],所以日志只会记录这两个级别的信息。

有些时候我们并不希望把所有日志写在一起,我们会根据不同模块来写日志,这样以便区分,这就需要用到日志的分类了。

重新配置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

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

当然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);
  }
}

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

日志消息的格式化,我们可以自定义日志的前缀。

'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');

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

由于没有登陆和分模块,所以没获取到用户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的作用是什么,因为在一些系统中日志的操作会很频繁,如果频繁的读取文件或数据库来写日志,会造成严重的IO消耗,降低系统性能,这也是YII2的一个优化吧。

当然有些时候一些长时间在控制台运行的程序,需要立即显示日志,那么可以通过如下配置:

'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。

有些时候我们需要人为的开启和关闭某些日志目标,这时就需要我们为每个日志目标设个键,以区分。

'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框架的PHP程序设计有所帮助。

PHP 相关文章推荐
在PHP中读取和写入WORD文档的代码
Apr 09 PHP
PHP 类商品秒杀计时实现代码
May 05 PHP
PHP编程最快明白(第一讲 软件环境和准备工作)
Oct 25 PHP
单一index.php实现PHP任意层级文件夹遍历(Zjmainstay原创)
Jul 31 PHP
php stream_get_meta_data返回值
Sep 29 PHP
PHP实现的比较完善的购物车类
Dec 02 PHP
php天翼开放平台短信发送接口实现方法
Dec 22 PHP
PHP实现微信发红包程序
Aug 24 PHP
Laravel SQL语句记录方式(推荐)
May 26 PHP
PHP实现的字符串匹配算法示例【sunday算法】
Dec 19 PHP
PHP通过文件保存和更新信息的方法分析
Sep 12 PHP
laravel框架语言包拓展实现方法分析
Nov 22 PHP
YII2框架中查询生成器Query()的使用方法示例
Mar 18 #PHP
YII2框架中使用RBAC对模块,控制器,方法的权限控制及规则的使用示例
Mar 18 #PHP
Laravel框架下的Contracts契约详解
Mar 17 #PHP
使用Entrust扩展包在laravel 中实现RBAC的功能
Mar 16 #PHP
PHP代码加密的方法总结
Mar 13 #PHP
YII2框架中behavior行为的理解与使用方法示例
Mar 13 #PHP
YII2框架中actions的作用与使用方法示例
Mar 13 #PHP
You might like
非洲第一个咖啡超凡杯大赛承办国—卢旺达的咖啡怎么样
2021/03/03 咖啡文化
PHP实现删除非站内外部链接实例代码
2014/06/17 PHP
php查看当前Session的ID实例
2015/03/16 PHP
PHP输入输出流学习笔记
2015/05/12 PHP
又十个超级有用的PHP代码片段
2015/09/24 PHP
ThinkPHP自定义Redis处理SESSION的实现方法
2016/05/16 PHP
PHP实现的62进制转10进制,10进制转62进制函数示例
2019/06/06 PHP
javaScript函数中执行C#代码中的函数方法总结
2013/08/07 Javascript
js的延迟执行问题分析
2014/06/23 Javascript
高性能JavaScript模板引擎实现原理详解
2015/02/05 Javascript
jquery删除table当前行的实例代码
2016/10/07 Javascript
本地存储localStorage用法详解
2017/07/31 Javascript
详解vue中引入stylus及报错解决方法
2017/09/22 Javascript
vue.js-div滚动条隐藏但有滚动效果的实现方法
2018/03/03 Javascript
[45:38]DOTA2上海特级锦标赛主赛事日 - 1 胜者组第一轮#1Liquid VS Alliance第一局
2016/03/02 DOTA
[01:02:53]DOTA2上海特级锦标赛主赛事日 - 5 总决赛Liquid VS Secret第二局
2016/03/06 DOTA
python动态监控日志内容的示例
2014/02/16 Python
python求crc32值的方法
2014/10/05 Python
python用来获得图片exif信息的库实例分析
2015/03/16 Python
Python中使用copy模块实现列表(list)拷贝
2015/04/14 Python
基于scrapy实现的简单蜘蛛采集程序
2015/04/17 Python
Python算法应用实战之队列详解
2017/02/04 Python
Python自定义函数定义,参数,调用代码解析
2017/12/27 Python
Python向Excel中插入图片的简单实现方法
2018/04/24 Python
Django 使用Ajax进行前后台交互的示例讲解
2018/05/28 Python
python生成多个只含0,1元素的随机数组或列表的实例
2018/11/12 Python
python递归下载文件夹下所有文件
2019/08/31 Python
Python序列化pickle模块使用详解
2020/03/05 Python
基于python实现模拟数据结构模型
2020/06/12 Python
Java byte数组操纵方式代码实例解析
2020/07/22 Python
未婚证明书模板
2014/10/08 职场文书
爱心捐款活动总结
2015/05/09 职场文书
关于远足的感想
2015/08/10 职场文书
《吃水不忘挖井人》教学反思
2016/02/22 职场文书
Redis Lua脚本实现ip限流示例
2022/07/15 Redis
win10此电脑打不开怎么办 win10双击此电脑无响应的解决办法
2022/07/23 数码科技