Yii2 日志處理

　　最近開發一個新的PHP項目，終於脫離了某框架的魔爪（之前被折磨的不輕），選用了江湖中如雷貫耳的Yii2框架。每個項目代碼的運行，日志是必不可少的，在開發中踩了一遍Yii2日志管理的坑，看過很多網上對Yii2日志的配置介紹，今天總結一下Yii2對日志的處理分享給大家。

　　1.首先看一下log配置：

return [
    'traceLevel' => YII_DEBUG ? 3 : 0,
    'targets' => [     //可以配置多個log 
        [
            'class' => 'yii\log\FileTarget',  //Yii2處理日志的類
            'levels' => ['error', 'warning', 'info'], //設置日志記錄的級別
            'categories' => ['user'], //自定義日志分類
            'maxFileSize' => 1024 * 20,  //設置文件大小，以k為單位
            'logFile' => '@runtime/../logs/user'.date('Ymd'), //自定義文件路徑 (一般項目的日志會打到服務器的其他路徑，需要修改相應目錄的權限哦~)
            'logVars' => ['_POST'],  //捕獲請求參數
            'fileMode' => 0775, //設置日志文件權限
            'maxLogFiles' => 100,  //同個文件名最大數量
            'rotateByCopy' => false, //是否以復制的方式rotate
            'prefix' => function() {   //日志格式自定義 回調方法
                if (Yii::$app === null) {
                    return '';
                }
                $request = Yii::$app->getRequest();
                $ip = $request instanceof Request ? $request->getUserIP() : '-';
                $controller = Yii::$app->controller->id;
                $action = Yii::$app->controller->action->id;
                return "[$ip][$controller-$action]";
            },
        ],
];

 　　2.日志記錄

　　　　Yii::trace()：記錄一條消息去跟蹤一段代碼是怎樣運行的。這主要在開發的時候使用。 
　　　　Yii::info()：記錄一條消息來傳達一些有用的信息。 
　　　　Yii::warning()：記錄一個警告消息用來指示一些已經發生的意外。 
　　　　Yii::error()：記錄一個致命的錯誤，這個錯誤應該盡快被檢查。

　　　　eg: Yii::info('the log content', 'user');

　　　　　　第二個參數可以是自定義的日志分類，對應配置文件中categories字段。

　　3.日志組件調用

　　　　log配置通過web.php(基礎模板web.php 高級模板main.php)以component方式加載到應用對象Yii::$app中。

　　4.日志切分

　　　　./vendor/yiisoft/yii2/log/FileTarget.php

class FileTarget extends Target
{
    public $logFile;
    //rotation開關  如果開啟，當日志文件大於maxFileSize設定的文件大小之后，就會自動切分日志
    public $enableRotation = true;    
    public $maxFileSize = 10240; // in KB
    //同一個文件名可以切分多少個文件
    public $maxLogFiles = 5;
    public $fileMode; //日志文件權限
    public $dirMode = 0775; 
    /**
     * @var bool Whether to rotate log files by copy and truncate in contrast to rotation by
     * renaming files. Defaults to `true` to be more compatible with log tailers and is windows
     * systems which do not play well with rename on open files. Rotation by renaming however is
     * a bit faster.
     *
     * The problem with windows systems where the [rename()](http://www.php.net/manual/en/function.rename.php)
     * function does not work with files that are opened by some process is described in a
     * [comment by Martin Pelletier](http://www.php.net/manual/en/function.rename.php#102274) in
     * the PHP documentation. By setting rotateByCopy to `true` you can work
     * around this problem.
     */ 
    public $rotateByCopy = true;

    /**
     * Rotates log files.
     */
    protected function rotateFiles()
    {
        $file = $this->logFile;
        for ($i = $this->maxLogFiles; $i >= 0; --$i) {
            // $i == 0 is the original log file
            $rotateFile = $file . ($i === 0 ? '' : '.' . $i);
            if (is_file($rotateFile)) {
                // suppress errors because it's possible multiple processes enter into this section
                if ($i === $this->maxLogFiles) {
                    @unlink($rotateFile);
                } else {
                    if ($this->rotateByCopy) {
                        @copy($rotateFile, $file . '.' . ($i + 1));
                        if ($fp = @fopen($rotateFile, 'a')) {
                            @ftruncate($fp, 0);
                            @fclose($fp);
                        }
                        if ($this->fileMode !== null) {
                            @chmod($file . '.' . ($i + 1), $this->fileMode);
                        }
                    } else {
                        // linux下用rename方式
                        @rename($rotateFile, $file . '.' . ($i + 1));
                    }
                }
            }
        }
    }
}

　　5.日志前綴

　　　　prefix：如果沒有配置，默認調用./vendor/yiisoft/yii2/log/Target.php

public function getMessagePrefix($message)
{
    if ($this->prefix !== null) {
        return call_user_func($this->prefix, $message);
    }

    if (Yii::$app === null) {
        return '';
    }

    $request = Yii::$app->getRequest();
    $ip = $request instanceof Request ? $request->getUserIP() : '-';

    /* @var $user \yii\web\User */
    $user = Yii::$app->has('user', true) ? Yii::$app->get('user') : null;
    if ($user && ($identity = $user->getIdentity(false))) {
        $userID = $identity->getId();
    } else {
        $userID = '-';
    }

    /* @var $session \yii\web\Session */
    $session = Yii::$app->has('session', true) ? Yii::$app->get('session') : null;
    $sessionID = $session && $session->getIsActive() ? $session->getId() : '-';

    return "[$ip][$userID][$sessionID]";
}

 　　　　如果想要自定義日志格式前綴，可以配置回調函數（note：如果在回調中使用了特定的類需要在文件開頭用“use”關鍵詞 引入該類）