原創(chuàng)作品，允許轉載，轉載時請務必以超鏈接形式標明文章?原始出處?、作者信息和本聲明。否則將追究法律責任。http://gotaly.blog.51cto.com/8861157/1406905

前一篇文章我們看到了Golang標準庫中l(wèi)og模塊的使用，那么它是如何實現(xiàn)的呢？下面我從log.Logger開始逐步分析其實現(xiàn)。 其源碼可以參考官方地址

1.Logger結構

首先來看下類型Logger的定義：

1 2 3 4 5 6 7

type Logger struct { ????mu???? sync.Mutex?// ensures atomic writes; protects the following fields ????prefix string?????// prefix to write at beginning of each line ????flag???int????????// properties ????out??? io.Writer??// destination for output ????buf??? []byte?????// for accumulating text to write }

主要有5個成員，其中3個我們比較熟悉，分別是表示Log前綴的 "prefix"，表示Log頭標簽的 "flag" ，以及Log的輸出目的地out。 buf是一個字節(jié)數(shù)組，主要用來存放即將刷入out的內(nèi)容，相當于一個臨時緩存，在對輸出內(nèi)容進行序列化時作為存儲目的地。 mu是一個mutex主要用來作線程安全的實習，當有多個goroutine同時往一個目的刷內(nèi)容的時候，通過mutex保證每次寫入是一條完整的信息。

2.std及整體結構

在前一篇文章中我們提到了log模塊提供了一套包級別的簡單接口，使用該接口可以直接將日志內(nèi)容打印到標準錯誤。那么該過程是怎么實現(xiàn)的呢？其實就是通過一個內(nèi)置的Logger類型的變量 "std" 來實現(xiàn)的。該變量使用：

1	var?std = New(os.Stderr,?"", LstdFlags)

進行初始化，默認輸出到系統(tǒng)的標準輸出 "os.Stderr" ,前綴為空，使用日期加時間作為Log抬頭。

當我們調(diào)用 log.Print的時候是怎么執(zhí)行的呢？我們看其代碼：

1 2 3

func Print(v ...interface{}) { ????std.Output(2, fmt.Sprint(v...)) }

這里實際就是調(diào)用了Logger對象的 Output方法，將日志內(nèi)容按照fmt包中約定的格式轉義后傳給Output。Output定義如下 :

?

1	func (l *Logger) Output(calldepth?int, s string) error

?

其中s為日志沒有加前綴和Log抬頭的具體內(nèi)容，xxxxx 。該函數(shù)執(zhí)行具體的將日志刷入到對應的位置。

3.核心函數(shù)的實現(xiàn)

Logger.Output是執(zhí)行具體的將日志刷入到對應位置的方法。

該方法首先根據(jù)需要獲得當前時間和調(diào)用該方法的文件及行號信息。然后調(diào)用formatHeader方法將Log的前綴和Log抬頭先格式化好 放入Logger.buf中，然后再將Log的內(nèi)容存入到Logger.buf中，最后調(diào)用Logger.out.Write方法將完整的日志寫入到輸出目的地中。

由于寫入文件以及拼接buf的過程是線程非安全的，因此使用mutex保證每次寫入的原子性。

1 2	l.mu.Lock() defer l.mu.Unlock()

將buf的拼接和文件的寫入放入這個后面，使得在多個goroutine使用同一個Logger對象是，不會弄亂buf，也不會雜糅的寫入。

該方法的第一個參數(shù)最終會傳遞給runtime.Caller的skip，指的是跳過的棧的深度。這里我記住給2就可以了。這樣就會得到我們調(diào)用log 是所處的位置。

在golang的注釋中說鎖住 runtime.Caller的過程比較重，這點我還是不很了解，只是從代碼中看到其在這里把鎖打開了。

1 2 3 4 5 6 7 8 9 10 11

if?l.flag&(Lshortfile|Llongfile) !=?0?{ ????// release lock while getting caller info - it's expensive. ????l.mu.Unlock() ????var?ok bool ????_, file, line, ok = runtime.Caller(calldepth) ????if?!ok { ????????file =?"???" ????????line =?0 ????} ????l.mu.Lock() }

在formatHeader里面首先將前綴直接復制到Logger.buf中,然后根據(jù)flag選擇Log抬頭的內(nèi)容，這里用到了一個log模塊實現(xiàn)的 itoa的方法，作用類似c的itoa,將一個整數(shù)轉換成一個字符串。只是其轉換后將結果直接追加到了buf的尾部。

縱觀整個實現(xiàn)，最值得學習的就是線程安全的部分。在什么位置合適做怎樣的同步操作。

4.對外接口的實現(xiàn)

在了解了核心格式化和輸出結構后，在看其封裝就非常簡單了，幾乎都是首先用Output進行日志的記錄，然后在必要的時候 做os.exit或者panic的操作，這里看下Fatal的實現(xiàn)。

1 2 3 4 5 6 7 8 9 10 11 12 13 14

func (l *Logger) Fatal(v ...interface{}) { ????l.Output(2, fmt.Sprint(v...)) ????os.Exit(1) } // Fatalf is equivalent to l.Printf() followed by a call to os.Exit(1). func (l *Logger) Fatalf(format string, v ...interface{}) { ????l.Output(2, fmt.Sprintf(format, v...)) ????os.Exit(1) } // Fatalln is equivalent to l.Println() followed by a call to os.Exit(1). func (l *Logger) Fatalln(v ...interface{}) { ????l.Output(2, fmt.Sprintln(v...)) ????os.Exit(1) }

這里也驗證了我們之前做的Panic的結果，先做輸出日志操作。再進行panic。

?

5.Golang的log模塊設計

Golang的log模塊主要提供了三類接口 ：

• Print ： 一般的消息輸出

• Fatal : 類似assert一般的強行退出

• Panic ： 相當于OO里面常用的異常捕獲

與其說log模塊提供了三類日志接口，不如說log模塊僅僅是對類C中的 printf、assert、try...catch...的簡單封裝。Golang的log模塊 并沒有對log進行分類、分級、過濾等其他類似log4j、log4c、zlog當中常見的概念。當然在使用中你可以通過添加prefix,來進行簡單的 分級，或者改變Logger.out改變其輸出位置。但這些并沒有在API層面給出直觀的接口。

Golang的log模塊就像是其目前僅專注于為服務器編程一樣，他的log模塊也專注于服務器尤其是基礎組件而服務。就像nginx、redis、lighttpd、keepalived自己為自己寫了一個簡單的日志模塊而沒有實現(xiàn)log4c那樣龐大且復雜的日志模塊一樣。他的日志模塊僅僅需要為 本服務按照需要的格式和方式提供接口將日志輸出到目的地即可。

Golang的log模塊可以進行一般的信息記錄，assert時的信息輸出，以及出現(xiàn)異常時的日志記錄，通過對其Print的包裝可以實現(xiàn)更復雜的 輸出。因此這個log模塊可謂是語言層面上非常基礎的一層庫，反應的是語言本身的特征而不是一個服務應該怎樣怎樣。

本文出自 “Done_in_72_hours” 博客，請務必保留此出處http://gotaly.blog.51cto.com/8861157/1406905

轉載于:https://www.cnblogs.com/lvdongjie/p/6511029.html

總結

以上是生活随笔為你收集整理的Golang 标准库log的实现的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯，歡迎將生活随笔推薦給好友。