linux shell程式設計學習--日志工具

在使用進階語言如java，C++的時候，有專門的日志庫，比如log4j，log4cxx等一些專門的日志庫，進行日志列印，可以進行日志等級配置，日志的檔案名，行号等資訊的自動添加。但是在shell裡，好像沒有類似的日志庫（也許是有，但我不知道，如果有知道的，請指點一下）。大部分時候，我們都是使用echo進行輸出。本文的介紹了一種可以不依賴任何第三方庫的前提下，shell日志自動添加日志列印的檔案，行号，日期等資訊的簡便方法，友善shell腳本可以使用簡單的echo指令進行日志輸出調試。

下面就一步步介紹，我的日志工具的進化史。

一、樹上的猴子

這個時候，作為一個猴子，除了摘樹上的香蕉，那就是摘樹上的蘋果啦。這個時候，隻能使用最簡單的echo進行日志列印，并且使用重定向，進行标準輸出stdout和标準錯誤輸出strerr。對日志進行兩種形式的輸出。

echo "Print log to stdout."
echo "Print log to stderr." >&
           

二、山頂洞人

作為人猿，除了吃。最簡單的禦寒，也是需要的啦。日志雖然已經分類了，但我們肯定希望在日志裡，看到一些更詳細的基本資訊，如列印日志發生日期，日志發生的腳本名稱，日志輸出所在的行号等資訊，可以友善調試。

日期資訊，可以使用shell的date指令，可以自動列印出目前日期

日志檔案，shell腳本的$0就是日志檔案

日志行号，像C/C++一樣，shell有個内置的變量叫LINENO，可以取到echo所在行号.

echo "[`date` $0 $LINENO] Print  log to stdout."
echo "[`date` $0 $LINENO] Print  log to stderr." >&
           

三、春秋奴隸社會

人類進化到了文明，那就有了分工。一部分人幹體力，如奴隸，一部分幹腦力，如貴族。日志也是一樣道理的。像日期，行号等這種基本資訊，就沒有必要在每個列印日志的地方都加上，那樣太麻煩了。在一個地方，統一處理下，就可以了，好比log4j那樣。調用處，隻需要給出日志内容就ok了。這個時候，就想到進階語言裡的函數了，shell裡，也是可以定義函數的。那就定義個函數

log_out(){
     echo "[`date` $0 $1] $2"
}
log_err(){
     echo "[`date` $0 $1] $2" >&
}
           

定義好函數,就可以在每個需要輸出日志的地方進行列印了。

log_out(){
     echo "[`date` $0 $1] $2"
}
log_err(){
     echo "[`date` $0 $1] $2" >&
}

log_out  "$LINENO" "Print log to stdout"
log_err "$LINENO" "Print log to stderr"
           

上面函數雖然可以解決問題，但這種函數有2個問題，1.行号需要在調用處傳入，2.函數需要寫在每個檔案裡定義。

關于問題1,可以使用shell提供的關鍵字alisa，alisa可以提供别名。

關于問題2,可以把函數定義在一個公共檔案裡，在每個使用的檔案裡source檔案。

定義一個檔案com_util.sh如下：

log_out_impl(){
     echo "[`date` $0 $1] $2"
}
log_err_impl(){
     echo "[`date` $0 $1] $2" >&
}
shopt -s expand_aliases
alias log_out='log_out_impl $LINENO'
alias log_err='log_err_impl $LINENO'
           

在使用的地方，進行檔案引入，就可以了

[email protected]:tmp$ cat ./test_log.sh 
#!/bin/bash
source com_util.sh

log_out "Print log to stdout"
log_err "Print log to stderr"

[email protected]:tmp$ ./test_log.sh 
[年 月 日 星期六 :: CST ./test_log.sh ] Print log to stdout
[年 月 日 星期六 :: CST ./test_log.sh ] Print log to stderr