php利用單例模式實現日志處理類庫

對於現在的應用程序來說，日志的重要性是不言而喻的。很難想象沒有任何日志記錄功能的應用程序運行在生產環境中。日志所能提供的功能是多種多樣的，包括記錄程序運行時產生的錯誤信息、狀態信息、調試信息和執行時間信息等。在生產環境中，日志是查找問題來源的重要依據。應用程序運行時的產生的各種信息，都應該通過日志類庫來進行記錄。

復制代碼 代碼如下:
/**
 * 日志處理類
 *
 * @since alpha 0.0.1
 * @date 2014.03.04
 * @author genialx
 *
 */

class Log{

    //單例模式
    private static $instance    = NULL;
    //文件句柄
    private static $handle      = NULL;
    //日志開關
    private $log_switch     = NULL;
    //日志相對目錄
    private $log_file_path      = NULL;
    //日志文件最大長度，超出長度重新建立文件
    private $log_max_len        = NULL;
    //日志文件前綴,入 log_0
    private $log_file_pre       = 'log_';

        
    /**
     * 構造函數
     *
     * @since alpha 0.0.1
     * @date 2014.02.04
     * @author genialx
     */
    protected function __construct(){//注意：以下是配置文件中的常量，請讀者自行更改

        $this->log_file_path     = LOG_FILE_PATH;

        $this->log_switch     = LOG_SWITCH; 

        $this->log_max_len    = LOG_MAX_LEN;

    }

    /**
     * 單利模式
     *
     * @since alpha 0.0.1
     * @date 2014.02.04
     * @author genialx
     */
    public static function get_instance(){
        if(!self::$instance instanceof self){
            self::$instance = new self;
        }
        return self::$instance;
    }

    /**
     *
     * 日志記錄
     *
     * @param int $type  0 -> 記錄(THING LOG) / 1 -> 錯誤(ERROR LOG)
     * @param string $desc
     * @param string $time
     *
     * @since alpha 0.0.1
     * @date 2014.02.04
     * @author genialx
     *
     */
    public function log($type,$desc,$time){
        if($this->log_switch){

            if(self::$handle == NULL){
                $filename = $this->log_file_pre . $this->get_max_log_file_suf();
                self::$handle = fopen($this->log_file_path . $filename, 'a');
            }
            switch($type){
                case 0:
                    fwrite(self::$handle, 'THING LOG:' . ' ' . $desc . ' ' . $time . chr(13));
                    break;
                case 1:
                    fwrite(self::$handle, 'ERROR LOG:' . ' ' . $desc . ' ' . $time . chr(13));
                    break;
                default:
                    fwrite(self::$handle, 'THING LOG:' . ' ' . $desc . ' ' . $time . chr(13));
                    break;
            }

        }
    }

    /**
     * 獲取當前日志的最新文檔的後綴
     *
     * @since alpha 0.0.1
     * @date 2014.02.04
     * @author genialx
     */
    private function get_max_log_file_suf(){
        $log_file_suf = null;
        if(is_dir($this->log_file_path)){
            if($dh = opendir($this->log_file_path)){
                while(($file = readdir($dh)) != FALSE){
                    if($file != '.' && $file != '..'){
                        if(filetype( $this->log_file_path . $file) == 'file'){
                            $rs = split('_', $file);
                            if($log_file_suf < $rs[1]){
                                $log_file_suf = $rs[1];
                            }
                        }
                    }
                }

                if($log_file_suf == NULL){
                    $log_file_suf = 0;
                }
                //截斷文件
                if( file_exists($this->log_file_path . $this->log_file_pre . $log_file_suf) && filesize($this->log_file_path . $this->log_file_pre . $log_file_suf) >= $this->log_max_len){
                    $log_file_suf = intval($log_file_suf) + 1;
                }

                return $log_file_suf;
            }  
        }

        return 0;

    }

    /**
     * 關閉文件句柄
     *
     * @since alpha 0.0.1
     * @date 2014.02.04
     * @author genialx
     */
    public function close(){
        fclose(self::$handle);
    }
}

功能說明：
該日志類利用單例模式，節省資源。自行判斷文件大小，超出指定大小則按序自行創建文件。如：文件log_0大於指定大小，則重新創建log_1文件（注意：創建文件是安裝文件名後綴的數字的，請勿隨意更改日志文件名）。

有待優化：沒有指定文件的最大個數，所以定期要手動刪除過多的日志文件。

調用示例：

復制代碼 代碼如下:
//LOG
$L = Log::get_instance();
//第一個參數 int 0代表事件記錄（THING LOG:)，1代表錯誤記錄（ERROR LOG:）
//第二個參數 string 描述文字
//第三個參數 string 時間
$L->log(1,'日志描述', date('Y-n-j H:m:s'));
$L->close();