PHP的Yii框架的常用日志操作总结

日志
Yii提供了一个高度自定义化和高扩展性的日志框架。根据使用场景的不同,你可以很容易的对各种消息就行记录、过滤、合并,比如说文本文件,数据库文件,邮件。

使用Yii的日志框架包含如下步骤:

调用日志记录的方法

在主应用的配置文件(例如basic下面的web.php)中配置好日志的过滤和导出的设置

检查不同场景下经过过滤之后的日志信息

记录日志

记录日志其实就是简简单单的调用如下的方法:

[[Yii::trace()]]: 记录关于某段代码运行的相关消息。主要是用于开发环境。

[[Yii::info()]]: 在某些位置记录一些比较有用的信息的时候使用。

[[Yii::warning()]]: 当某些期望之外的事情发生的时候,使用该方法。

[[Yii::error()]]: 当某些需要立马解决的致命问题发生的时候,调用此方法记录相关信息。

上面的这些方法虽然根据不同的level和类型来记录信息,但是实际上它们调用的是同一个方法function($message, $category = 'application')。其中$message就是要记录的信息,$category表示的是这个日志的归属类。下面的代码表示在默认的‘application'分类下面记录了一条trace类型的信息。

Yii::trace('start calculating average revenue');

提示:记录的$message可以是简单的string也可以是复杂的数组、对象。你应该根据不同的场景下日志记录的职责选取合适的$message类型。默认情况下,如果你记录的$message不是String,日志在导出的时候都会调用[[yii\helpers\VarDumper::export()]] 方法来输出一个string类型的消息。

为了更好的组织管理及筛选日志消息,通常情况下应当为每一种日志分配合适的类别。你可以选择一种有明显等级区分意思的分类,用以方便根据不同的目的来筛选不同分类的日志。一种简单且有效的命名方式就是使用PHP的魔术常量METHOD来作为分类的名称。Yii框架里面的核心代码在做日志记录的时候就是这么干的。比如说:

Yii::trace('start calculating average revenue', __METHOD__);

在有常量METHOD出现的地方,它表示的就是当前的方法的名称(并且加上了当前方法所属的类的完整前缀)。举个例子吧,如果在app\controllers\RevenueController这个类里面的calculate方法里面有上面的那行代码,那么此时的METHOD表示的就是‘app\controllers\RevenueController::calculate'。

提示:上面所说的方法事实上只是单例对象[[yii\log\Logger|logger object]] 的[[yii\log\Logger::log()|log()]]方法的简单使用,我们可以通过Yii::getLogger()方法来获得这个单例对象。当我们记录了足够的日志信息或者当前的应用运行结束了,日志对象将调用[yii\log\Dispatcher|message dispatcher]] 方法把记录的日志信息写入到配置的目的位置。

log targets
一个log target是[[yii\log\Target]]或者其子类的实例。它根据严重的等级和分类类过滤日志,然后把日志导出到合适的媒介上面去。就比如说,一个[[yii\log\DbTarget|database target]] 对象就会把过滤之后的日志信息导出到对应数据库。
你可以在应用的配置文件中的日志组件处注册多个log targets,就像下面这样:

return [ // the "log" component must be loaded during bootstrapping time 'bootstrap' => ['log'], 'components' => [ 'log' => [ 'targets' => [ [ 'class' => 'yii\log\DbTarget', 'levels' => ['error', 'warning'], ], [ 'class' => 'yii\log\EmailTarget', 'levels' => ['error'], 'categories' => ['yii\db\*'], 'message' => [ 'from' => ['log@example.com'], 'to' => ['admin@example.com', 'developer@example.com'], 'subject' => 'Database errors at example.com', ], ], ], ], ], ];

注意:日志组件必须在bootstrap中配置,这样才能把日志信息分发到对应的log target.
上面的代码里面,两个log target注册到了[[yii\log\Dispatcher::targets]]里面。

第一个筛选出错误和警告信息并且把这些信息保存到了数据库。
第二个筛选出分类以yii\db*开头的错误信息,并把这些信息通过邮件发送到admin@example.com 和 developer@example.com.
Yii有下面这些内置的log targets,你可以参考API文档来学习具体怎么去配置和使用它们。

[[yii\log\DbTarget]]:把日志信息保存到数据库。

[[yii\log\EmailTarget]]: 把日志信息发送到指定的邮箱,上面的例子就是。

[[yii\log\FileTarget]]: 把日志写到到文件。

[[yii\log\SyslogTarget]]: 调用PHP的syslog()方法将日志写入到系统日志。

接下来,我们就来看看常见的log target具有的功能。

消息过滤
就每一种log target而言,你可以配置它的 [[yii\log\Target::levels|levels]] 和 [[yii\log\Target::categories|categories]]属性类设置它的严重程度以及归属的分类。
[[yii\log\Target::levels|levels]]属性的采用一个数组里面的一个或者多个值,这个数组包含如下值:

error:对应[[Yii::error()]]记录的消息

warning:对应[[Yii::warning()]]记录的消息

info :对应 [[Yii::info()]]记录的信息

trace:对应 [[Yii::trace()]]记录的信息.

profile :对应[[Yii::beginProfile()]] 和 [[Yii::endProfile()]]记录的信息,这种方式下面更多详细信息会被记录。

如果你没有指定[[yii\log\Target::levels|levels]] 的值,那么任何level的信息都会被记录。

内容版权声明:除非注明,否则皆为本站原创文章。

转载注明出处:http://www.heiqu.com/87ec69507901362aa82162ab987040db.html