背景

我們在應用程序的代碼中添加業務日志的時候，不論是什么級別的日志，除了我們主動傳給 Logger 讓它記錄的信息外，這行日志是由哪個函數打印的、所在的位置也是非常重要的信息，不然排查問題的時候很有可能就猶如大海撈針。

對于在記錄日志時記錄調用 Logger 方法的調用者的函數名、行號這些信息。有的日志庫支持，比如 Zap：

func main() {
  logger, _ := zap.NewProduction(zap.AddCaller())
  defer logger.Sync()

  logger.Info("hello world")
}

輸出：

{"level":"info","ts":1587740198.9508286,"caller":"caller/main.go:9","msg":"hello world"}

不過如果想搞一個健壯的開發框架，不應該讓自己跟某個日志庫強綁定，更好的方法是開發一個日志的門面，程序里直接使用日志門面，再由門面調用日志庫完成日志的記錄。典型的 Java 的 slf4j 就是這個思路，程序里直接使用的是slf4j ，后面的 Logger 可以是 logback 也可以是 log4j 甚至是任何滿足 slf4j 約定的日志庫實現。

如果讓我們用 Go 設計一個Log Facade，就需要我們自己在門面里獲取調用者的函數名、文件位置了，那么在Go里面怎么實現這個功能呢?這就需要借助 runtime 標準庫提供的 Caller 函數了。

本文主要介紹 runtime.Caller 的使用，上面說了那么多只是為了鋪墊一下，學會它，在哪些地方可以應用上。

runtime.Caller

runtime.Caller 的函數簽名如下：

func Caller(skip int) (pc uintptr, file string, line int, ok bool)

Caller 函數會報告當前 Go 程序調用棧所執行的函數的文件和行號信息。參數skip為要上溯的棧幀數，0 表示Caller的調用者(Caller所在的調用棧)，1 表示調用 Caller 調用者的調用者，以此類推。是不是有點暈，這里舉個例子：

func CallerA() {
  //獲取的是 CallerA 這個函數的調用棧
  pc, file, lineNo, ok := runtime.Caller(0)
  //獲取的是 CallerA函數的調用者的調用棧
  pc1, file1, lineNo1, ok1 := runtime.Caller(1)
}

函數的返回值為調用棧標識符、帶路徑的完整文件名、該調用在文件中的行號。如果無法獲得信息，返回值 ok 會被設為 false。

獲取調用者的函數名

runtime.Caller 返回值中第一個返回值是一個調用棧標識，通過它我們能拿到調用棧的函數信息 *runtime.Func，再進一步獲取到調用者的函數名字，這里面會用到的函數和方法如下。

func FuncForPC(pc uintptr) *Func

func (*Func) Name

runtime.FuncForPC 函數返回一個表示調用棧標識符pc對應的調用棧的*Func;如果該調用棧標識符沒有對應的調用棧，函數會返回nil。

Name 方法返回該調用棧所調用的函數的名字，上面說了runtime.FuncForPC 有可能會返回 nil，不過Name方法在實現的時候做了這種情況的判斷，避免出現panic 的可能，所以我們可以放心大膽的使用。

func (f *Func) Name() string {
 if f == nil {
  return ""
 }
 fn := f.raw()
 if fn.isInlined() { // inlined version
  fi := (*funcinl)(unsafe.Pointer(fn))
  return fi.name
 }
 return funcname(f.funcInfo())
}

使用示例

下面看一個使用 runtime.Caller 和 runtime.FuncForPC 一起配合獲取調用者信息的簡單例子：

package main

import (
 "fmt"
 "path"
 "runtime"
)

func getCallerInfo(skip int) (info string) {

 pc, file, lineNo, ok := runtime.Caller(skip)
 if !ok {

  info = "runtime.Caller() failed"
  return
 }
 funcName := runtime.FuncForPC(pc).Name()
 fileName := path.Base(file) // Base函數返回路徑的最后一個元素
 return fmt.Sprintf("FuncName:%s, file:%s, line:%d ", funcName, fileName, lineNo)
}

func main() {

 // 打印出getCallerInfo函數自身的信息
 fmt.Println(getCallerInfo(0))
 // 打印出getCallerInfo函數的調用者的信息
 fmt.Println(getCallerInfo(1))
}

注意：這里我們演示地比較簡單，往上追溯一個調用棧就能拿到調用者的信息。真正要實現日志門面之類的類庫的時候，可能是會有幾層封裝，想在日志里記錄的調用者信息應該是業務代碼中打日志的位置，這時要向上回溯的層數肯定就不是 1 這么簡單了，具體跳過幾層要看實現的日志門面具體的封裝情況。

總結

今天介紹了通過 runtime.Caller 回溯調用棧獲取調用者的信息的方法，雖然強大，不過頻繁獲取這個信息也是會對程序性能有影響。我們的業務代碼不應該依賴于它來實現，它發揮作用的地方更多的是對業務透明的一些類庫在記錄信息的時候才會被用到。