《PHP编程：PHP的Yii框架的常用日志操作总结》要点：
本文介绍了PHP编程：PHP的Yii框架的常用日志操作总结，希望对您有用。如果有疑问，可以联系我们。
相关主题：YII框架
PHP应用日志
Yii提供了一个高度自定义化和高扩展性的日志框架.根据使用场景的不同,你可以很容易的对各种消息就行记录、过滤、合并,好比说文本文件,数据库文件,邮件.
PHP应用使用Yii的日志框架包括如下步骤：
PHP应用调用日志记录的办法
PHP应用记录日志其实就是简简单单的调用如下的办法：
PHP应用上面的这些办法虽然根据不同的level和类型来记录信息,但是实际上它们调用的是同一个办法function($message, $category = 'application').其中$message就是要记录的信息,$category表示的是这个日志的归属类.下面的代码表示在默认的‘application'分类下面记录了一条trace类型的信息.
PHP应用
Yii::trace('start calculating average revenue');
PHP应用提示:记录的$message可以是简单的string也可以是复杂的数组、对象.你应该根据不同的场景下日志记录的职责选取合适的$message类型.默认情况下,如果你记录的$message不是String,日志在导出的时候都会调用[[yii\helpers\VarDumper::export()]] 办法来输出一个string类型的消息.
PHP应用为了更好的组织管理及筛选日志消息,通常情况下应当为每一种日志分配合适的类别.你可以选择一种有明显等级区分意思的分类,用以方便根据不同的目的来筛选不同分类的日志.一种简单且有效的命名方式就是使用PHP的魔术常量METHOD来作为分类的名称.Yii框架里面的核心代码在做日志记录的时候就是这么干的.好比说：
PHP应用
Yii::trace('start calculating average revenue', __METHOD__);
PHP应用在有常量METHOD出现的地方,它表示的就是当前的办法的名称(并且加上了当前办法所属的类的完整前缀).举个例子吧,如果在app\controllers\RevenueController这个类里面的calculate办法里面有上面的那行代码,那么此时的METHOD表示的就是‘app\controllers\RevenueController::calculate'.
PHP应用提示：上面所说的办法事实上只是单例对象[[yii\log\Logger|logger object]] 的[[yii\log\Logger::log()|log()]]办法的简单使用,我们可以通过Yii::getLogger()办法来获得这个单例对象.当我们记录了足够的日志信息或者当前的应用运行结束了,日志对象将调用[yii\log\Dispatcher|message dispatcher]] 办法把记录的日志信息写入到配置的目的位置.
PHP应用log targets
一个log target是[[yii\log\Target]]或者其子类的实例.它根据严重的等级和分类类过滤日志,然后把日志导出到合适的媒介上面去.就好比说,一个[[yii\log\DbTarget|database target]] 对象就会把过滤之后的日志信息导出到对应数据库.
你可以在应用的配置文件中的日志组件处注册多个log targets,就像下面这样：
PHP应用
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',
],
],
],
],
],
];
PHP应用注意:日志组件必需在bootstrap中配置,这样才能把日志信息分发到对应的log target.
上面的代码里面,两个log target注册到了[[yii\log\Dispatcher::targets]]里面.
PHP应用第一个筛选出错误和警告信息并且把这些信息保留到了数据库.
第二个筛选出分类以yii\db*开头的错误信息,并把这些信息通过邮件发送到admin@example.com 和 developer@example.com.
Yii有下面这些内置的log targets,你可以参考API文档来学习具体怎么去配置和使用它们.
PHP应用接下来,我们就来看看常见的log target具有的功能.
PHP应用消息过滤
就每一种log target而言,你可以配置它的 [[yii\log\Target::levels|levels]] 和 [[yii\log\Target::categories|categories]]属性类设置它的严重程度以及归属的分类.
[[yii\log\Target::levels|levels]]属性的采用一个数组里面的一个或者多个值,这个数组包括如下值：
PHP应用如果你没有指定[[yii\log\Target::levels|levels]] 的值,那么任何level的信息都会被记录.
PHP应用[[yii\log\Target::categories|categories]] 属性的值是数组,这个数组里面的值可以是一个具体的分类名称,也可以是类似正则的匹配模式.只有在target能在这个数组里面找到对应的分类名或者符合某一个匹配模式,他才会处理这些消息.这里的匹配模式的组成是在分类的名称后面加上一个号.如果这个分类恰好和这个匹配模式的号前的字符匹配,那么也就是这个分类找到对应匹配值.举个例来说,在类[[yii\db\Command]]中的yii\db\Command::execute和yii \db\Command:: query 办法使用类名类记录相关日志信息,那么这个时候他们都匹配模式yii\db*
PHP应用同样的,如果我们没有指定[[yii\log\Target::categories|categories]],那么每一种分类的日志信息都会被处理.
除了通过[[yii\log\Target::categories|categories]] 属性来设置分类的白名单外,你也可以通过 [[yii\log\Target::except|except]]属性来设置分类的黑名单.属于黑名单的分类日志信息不会被target处理.
PHP应用下面的配置指定了一个分类匹配yii\db*或者 yii\web\HttpException:*,但又不包含yii\web\HttpException:404的分类,而且它只处理错误和警告的日志信息.
PHP应用
[
'class' => 'yii\log\FileTarget',
'levels' => ['error', 'warning'],
'categories' => [
'yii\db\*',
'yii\web\HttpException:*',
],
'except' => [
'yii\web\HttpException:404',
],
]
PHP应用
2014-10-04 18:10:15 [::1][][-][trace][yii\base\Module::getModule] Loading module: debug
PHP应用默认情况下,[[yii\log\Target::formatMessage()]]:会帮我们把日志信息格式化成下面的这种格式：
PHP应用
Timestamp [IP address][User ID][Session ID][Severity Level][Category] Message Text
PHP应用你可以通过给[[yii\log\Target::prefix]] 属性配置一个自定义的回调函数来 自定义日志的前缀.下面的代码就实现了在每条日志信息前面加上了用户的ID(ip地址,sessionId等敏感信息因为个人隐私被去掉了).
PHP应用
[
'class' => 'yii\log\FileTarget',
'prefix' => function ($message) {
$user = Yii::$app->has('user', true) ? Yii::$app->get('user') : null;
$userID = $user ? $user->getId(false) : '-';
return "[$userID]";
}
]
PHP应用除了日志消息的前缀,日志的target还把一些上下文信息附加在了每一批的日志记录中.默认情况下,全局的PHP变量包括$_GET, $_POST, $_FILES, $_COOKIE, $_SESSION 和 $_SERVER. 你可以通过配置 [[yii\log\Target::logVars]] 来调整日志记录的全局变量.下面的代码表示的是只记录$_SERVER相关的变量.
PHP应用
[
'class' => 'yii\log\FileTarget',
'logVars' => ['_SERVER'],
]
PHP应用当 'logVars'为空的时候,表示不记录相关的上下文信息.如果你想自定义上下文信息的提供方式,你可以覆写[[yii\log\Target::getContextMessage()]] 办法.
PHP应用消息的trace等级
在开发的过程当中,我们总是期望能够知道每一条日志消息是来自哪里.在Yii中你可以通过配置[[yii\log\Dispatcher::traceLevel|traceLevel]] 属性来实现.配置的示例如下：
PHP应用
return [
'bootstrap' => ['log'],
'components' => [
'log' => [
'traceLevel' => YII_DEBUG ? 3 : 0,
'targets' => [...],
],
],
];
PHP应用上面的示例在YII_DEBUG为true的时候将[[yii\log\Dispatcher::traceLevel|traceLevel]] 设置为3,反之设置为0. 意思是什么呢?3表现每一条日志记录都会记录与之相关的三层栈调用信息,0表现不记录任何相关的栈调用信息
PHP应用提示：没有必要总是记录调用的堆栈信息,比较耗性能.所以,你应该只在你开发的时候或者用于调试的情况下使用该功能.
消息的清空和导出
就如同上面说的,记录的消息以数组的形式保存在[[yii\log\Logger|logger object]]中.为了限制这个数组消耗过多的内存,当这个数组包括的内容大小达到某个量的时候会被对应的target从内存中转移到对应的目标(文件,数据库...)中.你可以通过设置 [[yii\log\Dispatcher::flushInterval|flushInterval]] 的值来决定量的大小.像下面这样：
PHP应用
return [
'bootstrap' => ['log'],
'components' => [
'log' => [
'flushInterval' => 100, // default is 1000
'targets' => [...],
],
],
];
PHP应用注意：在应用运行结束的时候也会刷新内存,这样办事为了让日志的target能够记录完整的信息.
把日志信息从内存刷到对应存放的地方的这一动作不是立即发生的.事实上,和上面一样,都是当内存中的日志大小达到一定程度才会发生.你可以像下面的示例一样通过配置不同target的[[yii\log\Target::exportInterval|exportInterval]]值,来达到修改的目的：
PHP应用
[
'class' => 'yii\log\FileTarget',
'exportInterval' => 100, // default is 1000
]
PHP应用因为清空和导出的设定,默认情况下你调用 Yii::trace() 或者其他的日志记录办法的时候不会在日志target下立马看到日志消息.这对某些长时间运行的控制台程序是一个问题.不过这个问题是可以解决的,办法入下面的代码,你需要把[[yii\log\Dispatcher::flushInterval|flushInterval]] 和[[yii\log\Target::exportInterval|exportInterval]] 的值都设置成1：
PHP应用
return [
'bootstrap' => ['log'],
'components' => [
'log' => [
'flushInterval' => 1,
'targets' => [
[
'class' => 'yii\log\FileTarget',
'exportInterval' => 1,
],
],
],
],
];
PHP应用注意：如此频繁的清空和导出日志消息会降低系统的性能.
切换日志的targets
你可以通过设置[[yii\log\Target::enabled|enabled]] 属性来禁止日志的target.就如同下面的代码描述的一样：
PHP应用
Yii::$app->log->targets['file']->enabled = false;
PHP应用上面的代码必要你在配置文件里面有一个下面的配置：
PHP应用
return [
'bootstrap' => ['log'],
'components' => [
'log' => [
'targets' => [
'file' => [
'class' => 'yii\log\FileTarget',
],
'db' => [
'class' => 'yii\log\DbTarget',
],
],
],
],
];
PHP应用创建一个新的target
首先,创建一个新的日志target是很简单的.你主要做的事情是实现[[yii\log\Target::export()]] 办法并且把数组类型的消息[[yii\log\Target::messages]]发送到指定的存储媒介上去就行了.在这个过程中你可以调用[[yii\log\Target::formatMessage()]] 办法来格式化每一条日志消息.至于更多的细节你可以在Yiid的发行版本里找到详细的信息.
PHP应用性能评测
性能评测是一种比拟特别的日志记录.它通常用来获取某些模块执行时间的数据,以此来找到性能的问题所在.比如说,[[yii\db\Command]] 这个类就用性能评测日志来获得每一条sql查询所花费的时间.
PHP应用要使用该类日志,你首先要做的时确定你要测试的代码范围.然后在每一段代码之间你都应该要坚持它们是闭合的,就像下面这个样子：
PHP应用
\Yii::beginProfile('myBenchmark');
...code block being profiled...
\Yii::endProfile('myBenchmark');
PHP应用myBenchmark只是一个标识,用于你在查看对应日志记录的时候快速定位.
在beginProfile和endProfile之间是可以再嵌套的,但是必需保证正确的闭合关系,如下所示：
PHP应用
\Yii::beginProfile('block1');
// some code to be profiled
\Yii::beginProfile('block2');
// some other code to be profiled
\Yii::endProfile('block2');
\Yii::endProfile('block1');
PHP应用如果上面的闭合关系出错了,对应的记录都不会正常工作.
PHP应用对于每一块被评测的代码,日志的level都是profile.你可以再日志的target中配置这些信息并导出它们. Yii内建了 Yii debugger来展示评测的成果.
欢迎参与《PHP编程：PHP的Yii框架的常用日志操作总结》讨论，分享您的想法，维易PHP学院为您提供专业教程。
转载请注明本页网址：
http://www.vephp.com/jiaocheng/8280.html
