2015-03-09 一

By?youngsterxyf

使用

Yii框架為開發者提供兩個靜態方法進行日志記錄：

Yii::log($message, $level, $category); Yii::trace($message, $category);

兩者的區別在于后者依賴于應用開啟調試模式，即定義常量YII_DEBUG：

defined('YII_DEBUG') or define('YII_DEBUG', true);

Yii::log方法的調用需要指定message的level和category。category是格式為“xxx.yyy.zzz”的路徑別名字符串，比如日志是在yii/framework/web/CController類中記錄的，那么category為“system.web.CController”。level應為以下幾種之一：

• trace：Yii::trace方法即是使用的這個level。用于跟蹤執行流
• info：記錄通用信息日志
• profile：用于性能分析
• warning：用于記錄警告日志
• error：用于記錄重大錯誤日志

要想日志真的輸出到文件、郵件、web頁面等地方，還得為應用添加如下配置：

array( ...... 'preload'=>array('log'), 'components'=>array( ...... 'log'=>array( 'class'=>'CLogRouter', 'routes'=>array( array( 'class'=>'CFileLogRoute', 'levels'=>'trace, info', 'categories'=>'system.*', ), array( 'class'=>'CEmailLogRoute', 'levels'=>'error, warning', 'emails'=>'admin@example.com', ), ), ), ), )

注冊使用名為log的組件，組件對應的類為CLogRouter（見類文件yii/framework/logging/CLogRouter.php），并且需要為組件提供參數routes， 從目錄yii/framework/logging可以看到可使用的日志輸出目標路由有：CDbLogRoute（將日志記錄到數據庫中）、CEmailLogRoute（將日志發送到郵箱）、CFileLogRoute（記錄到文件中）、CWebLogRoute（將日志顯示在對應的網頁中）、CProfileLogRoute，其中CProfileLogRoute直接繼承自CWebLogRoute，其他路由類都直接繼承自CLogRoute類。

至于為什么需要對log組件進行preload，即預先實例化，后邊再說。

分析

先來看看Yii::log和Yii::trace的實現：

/** * Writes a trace message. * This method will only log a message when the application is in debug mode. * @param string $msg message to be logged * @param string $category category of the message * @see log */ public static function trace($msg,$category='application') { // 得先定義常量YII_DEBUG為true if(YII_DEBUG) // CLogger::LEVEL_TRACE self::log($msg,CLogger::LEVEL_TRACE,$category); } /** * Logs a message. * Messages logged by this method may be retrieved via {@link CLogger::getLogs} * and may be recorded in different media, such as file, email, database, using * {@link CLogRouter}. * @param string $msg message to be logged * @param string $level level of the message (e.g. 'trace', 'warning', 'error'). It is case-insensitive. * @param string $category category of the message (e.g. 'system.web'). It is case-insensitive. */ public static function log($msg,$level=CLogger::LEVEL_INFO,$category='application') { if(self::$_logger===null) self::$_logger=new CLogger; // 注意這里的常量YII_TRACE_LEVEL，如果想日志中含有對應文件名、對應行，那么應該定義YII_TRACE_LEVEL大于0， // 這個常量的意思應該是日志追蹤的深度 if(YII_DEBUG && YII_TRACE_LEVEL>0 && $level!==CLogger::LEVEL_PROFILE) { $traces=debug_backtrace(); $count=0; foreach($traces as $trace) { if(isset($trace['file'],$trace['line']) && strpos($trace['file'],YII_PATH)!==0) { $msg.="\nin ".$trace['file'].' ('.$trace['line'].')'; if(++$count>=YII_TRACE_LEVEL) break; } } } // 調用的是CLogger類的log方法 self::$_logger->log($msg,$level,$category); }

CLogger類的log方法實現如下所示：

/** * Logs a message. * Messages logged by this method may be retrieved back via {@link getLogs}. * @param string $message message to be logged * @param string $level level of the message (e.g. 'Trace', 'Warning', 'Error'). It is case-insensitive. * @param string $category category of the message (e.g. 'system.web'). It is case-insensitive. * @see getLogs */ public function log($message,$level='info',$category='application') { $this->_logs[]=array($message,$level,$category,microtime(true)); $this->_logCount++; // autoFlush的默認值為10000，即只有當日志的條數達到10000（或請求處理結束時），才會flush到輸出，否則一直將日志存放在內存中 if($this->autoFlush>0 && $this->_logCount>=$this->autoFlush && !$this->_processing) { $this->_processing=true; // autoDump默認為false $this->flush($this->autoDump); $this->_processing=false; } }

CLogger類的flush方法實現如下所示：

/** * Removes all recorded messages from the memory. * This method will raise an {@link onFlush} event. * The attached event handlers can process the log messages before they are removed. * @param boolean $dumpLogs whether to process the logs immediately as they are passed to log route * @since 1.1.0 */ public function flush($dumpLogs=false) { // 事件對象中會帶有當前的CLogger對象，作為事件的發送者 // 但在類CLogRouter的方法collectLogs和processLogs中并沒有使用這個CLogger對象， // 而是通過Yii::getLogger()來得到同一個CLogger對象，為什么不直接使用呢？ $this->onFlush(new CEvent($this, array('dumpLogs'=>$dumpLogs))); // 清空重置 $this->_logs=array(); $this->_logCount=0; } /** * Raises an <code>onFlush</code> event. * @param CEvent $event the event parameter * @since 1.1.0 */ public function onFlush($event) { // 拋出onFlush事件 // raiseEvent方法定義在CComponent類中，CLogger類繼承自CComponent類 $this->raiseEvent('onFlush', $event); }

CComponent類的raiseEvent方法實現如下所示：

/** * Raises an event. * This method represents the happening of an event. It invokes * all attached handlers for the event. * @param string $name the event name * @param CEvent $event the event parameter * @throws CException if the event is undefined or an event handler is invalid. */ public function raiseEvent($name,$event) { $name=strtolower($name); if(isset($this->_e[$name])) { // 逐個執行與事件$name綁定的$handler foreach($this->_e[$name] as $handler) { if(is_string($handler)) // 會將事件對象(CEvent對象)傳到$handler中 call_user_func($handler,$event); elseif(is_callable($handler,true)) { if(is_array($handler)) { // an array: 0 - object, 1 - method name list($object,$method)=$handler; if(is_string($object)) // static method call call_user_func($handler,$event); elseif(method_exists($object,$method)) $object->$method($event); else throw new CException(Yii::t('yii','Event "{class}.{event}" is attached with an invalid handler "{handler}".', array('{class}'=>get_class($this), '{event}'=>$name, '{handler}'=>$handler[1]))); } else // PHP 5.3: anonymous function call_user_func($handler,$event); } else throw new CException(Yii::t('yii','Event "{class}.{event}" is attached with an invalid handler "{handler}".', array('{class}'=>get_class($this), '{event}'=>$name, '{handler}'=>gettype($handler)))); // stop further handling if param.handled is set true if(($event instanceof CEvent) && $event->handled) return; } } elseif(YII_DEBUG && !$this->hasEvent($name)) throw new CException(Yii::t('yii','Event "{class}.{event}" is not defined.', array('{class}'=>get_class($this), '{event}'=>$name))); }

看到這里，你可能會很奇怪怎么都沒看到真正記錄日志的代碼呢？在與事件綁定的各個$handler里呢，這也是log組件的routes參數配置成數組的原因，$handle就是該數組中對應類的實例化對象的日志記錄方法。

那么這些$handle是在哪里綁定事件的呢？

既然log組件對應的是CLogRouter類，那么來看看其實現。

類CLogRouter繼承自類CApplicationComponent。根據Yii源碼閱讀筆記 - 組件集成一文，可知組件初始化時實例化對象會調用init方法來完成一些初始化操作，類CLogRouter的init方法實現如下所示：

/** * Initializes this application component. * This method is required by the IApplicationComponent interface. */ public function init() { parent::init(); // 實例化配置的routes參數中指定的日志路由類列表 foreach($this->_routes as $name=>$route) { $route=Yii::createComponent($route); $route->init(); $this->_routes[$name]=$route; } // 將當前對象的collectLogs方法綁定到事件onFlush Yii::getLogger()->attachEventHandler('onFlush',array($this,'collectLogs')); // 將當前對象的processLogs方法綁定到事件onEndRequest（表示請求處理結束？） Yii::app()->attachEventHandler('onEndRequest',array($this,'processLogs')); }

而類CLogRouter的方法collectLogs和processLogs實現如下所示：

/** * Collects log messages from a logger. * This method is an event handler to the {@link CLogger::onFlush} event. * @param CEvent $event event parameter */ public function collectLogs($event) { $logger=Yii::getLogger(); $dumpLogs=isset($event->params['dumpLogs']) && $event->params['dumpLogs']; // 遍歷所有日志路由對象，執行其方法collectLogs foreach($this->_routes as $route) { // 屬性enabled默認值為true if($route->enabled) // $dumpLogs默認為false，由事件對象傳過來 $route->collectLogs($logger,$dumpLogs); } } /** * Collects and processes log messages from a logger. * This method is an event handler to the {@link CApplication::onEndRequest} event. * @param CEvent $event event parameter * @since 1.1.0 */ public function processLogs($event) { $logger=Yii::getLogger(); // 遍歷所有日志路由對象，執行其方法collectLogs foreach($this->_routes as $route) { if($route->enabled) // 注意這里參數$dumpLogs參數值始終為true $route->collectLogs($logger,true); } }

以類CWebLogRoute為例來看看日志路由類的方法collectLogs，該方法定義于類CLogRoute中，實現如下所示：

/** * Retrieves filtered log messages from logger for further processing. * @param CLogger $logger logger instance * @param boolean $processLogs whether to process the logs after they are collected from the logger */ // 事件onFlush觸發時，傳入的$processLogs參數值默認為false，事件onEndRequest觸發時為true public function collectLogs($logger, $processLogs=false) { // 從類CLogger實例化對象的_logs屬性值中過濾得到目標日志記錄 $logs=$logger->getLogs($this->levels,$this->categories,$this->except); $this->logs=empty($this->logs) ? $logs : array_merge($this->logs,$logs); if($processLogs && !empty($this->logs)) { if($this->filter!==null) Yii::createComponent($this->filter)->filter($this->logs); if($this->logs!==array()) // 調用實際route的processLogs方法 $this->processLogs($this->logs); $this->logs=array(); } }

而類CWebLogRoute的processLogs方法實現如下所示：

/** * Displays the log messages. * @param array $logs list of log messages */ public function processLogs($logs) { $this->render('log',$logs); } /** * Renders the view. * @param string $view the view name (file name without extension). The file is assumed to be located under framework/data/views. * @param array $data data to be passed to the view */ protected function render($view,$data) { $app=Yii::app(); $isAjax=$app->getRequest()->getIsAjaxRequest(); $isFlash=$app->getRequest()->getIsFlashRequest(); // 用firebug來顯示日志信息的話？ if($this->showInFireBug) { // do not output anything for ajax and/or flash requests if needed if($isAjax && $this->ignoreAjaxInFireBug || $isFlash && $this->ignoreFlashInFireBug) return; $view.='-firebug'; if(($userAgent=$app->getRequest()->getUserAgent())!==null && preg_match('/msie [5-9]/i',$userAgent)) { echo '<script type="text/javascript">'; echo file_get_contents(dirname(__FILE__).'/../vendors/console-normalizer/normalizeconsole.min.js'); echo "</script>\n"; } } elseif(!($app instanceof CWebApplication) || $isAjax || $isFlash) return; // 渲染yii/framework/views/log.php（log-firebug.php），將結果放在實際請求頁面內容的下面 $viewFile=YII_PATH.DIRECTORY_SEPARATOR.'views'.DIRECTORY_SEPARATOR.$view.'.php'; include($app->findLocalizedFile($viewFile,'en')); }

從上述代碼可以知道日志路由類是將日志信息按照一定格式顯示在實際請求頁面內容的下方。

再來看看方法init中調用的兩個attachEventHandler，它們的定義是同一個，定義在類CComponent中（類CLogger直接繼承自類CComponent），實現如下所示：

public function attachEventHandler($name,$handler) { // 將事件處理器$handler加到處理器列表中，在事件發生時會逐個處理器觸發執行 $this->getEventHandlers($name)->add($handler); }

其中方法EventHandlers的實現如下所示：

/** * Returns the list of attached event handlers for an event. * @param string $name the event name * @return CList list of attached event handlers for the event * @throws CException if the event is not defined */ public function getEventHandlers($name) { if($this->hasEvent($name)) { $name=strtolower($name); if(!isset($this->_e[$name])) $this->_e[$name]=new CList; return $this->_e[$name]; } else throw new CException(Yii::t('yii','Event "{class}.{event}" is not defined.', array('{class}'=>get_class($this), '{event}'=>$name))); }

從上述分析可以知道所謂事件系統，其實就是將處理函數/對象方法放到與事件ID對應的一個列表中，然后在事件觸發時，逐個調用執行這些函數/對象方法。

Yii框架基于事件系統，可以做到同時將日志信息寫到多個目標輸出中。

---

回到之前提到的那個問題：為什么需要對log組件進行preload？

這是因為：對于日志組件的使用并不是通過Yii::app()->db這種形式來調用的（如果基于這種形式，那么就可以在首次調用時再做組件實例化，以實現組件延遲加載），而是通過觸發事件來間接調用，但這就需要在事件觸發之間將相關的處理函數/對象方法綁定到事件，這個綁定操作又是在日志log組件的init方法中執行的，一般組件類實例化時才會調用其init方法，所以需要對log組件進行預加載。

參考

• Yii - topics - Logging

轉載于:https://www.cnblogs.com/sunscheung/p/4864179.html

總結

以上是生活随笔為你收集整理的Yii源码阅读笔记 - 日志组件的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。