本文介绍了如何在 Go 语言中便捷地测量函数的执行时间，并以毫秒为单位返回运行时间。通过利用 defer 关键字和 time 包，我们可以轻松地实现对函数执行时间的精确监控，并提供可复用的代码片段，帮助开发者快速集成到自己的项目中。
在 Go 语言中，测量函数的执行时间是一个常见的需求，尤其是在性能优化和调试过程中。利用 Go 语言的 defer 关键字和 time 包，可以非常简洁地实现这个功能。
使用 defer 和 time 包测量函数执行时间
defer 关键字允许我们将一个函数调用推迟到包含该 defer 语句的函数即将返回之前执行。结合 time 包，我们可以记录函数开始执行的时间，并在函数返回时计算执行时间差。
以下是一个示例代码：
package main
import (
"log"
"time"
)
func trace(s string) (string, time.Time) {
log.Println("START:", s)
return s, time.Now()
}
func un(s string, startTime time.Time) {
endTime := time.Now()
duration := endTime.Sub(startTime)
log.Printf(" END: %s, Elapsed Time: %v\n", s, duration)
log.Printf(" END: %s, Elapsed Time in milliseconds: %vms\n", s, duration.Milliseconds()) // 输出毫秒数
}
func someFunction() {
defer un(trace("someFunction")) // 关键：defer 语句
// 模拟一些耗时操作
time.Sleep(1 * time.Second)
}
func main() {
someFunction()
}代码解释：
- trace(s string) (string, time.Time) 函数： 接收一个字符串 s 作为函数名称，记录函数开始执行的日志，并返回函数名称和当前时间 time.Now()。
- un(s string, startTime time.Time) 函数： 接收函数名称 s 和开始时间 startTime，计算函数执行的结束时间 endTime，然后计算时间差 duration。最后，将函数名称和执行时间打印到日志中，同时输出了毫秒数。
- someFunction() 函数： 这是我们要测量执行时间的函数。关键在于 defer un(trace("someFunction")) 语句。trace("someFunction") 会在 someFunction 函数开始执行时立即调用，记录开始时间。而 defer un(...) 则会将 un 函数的调用推迟到 someFunction 函数返回之前执行，此时可以计算执行时间差。time.Sleep(1 * time.Second) 模拟了一些耗时操作。
- main() 函数： 调用 someFunction() 来执行测量。
运行结果示例：
2023/10/27 10:00:00 START: someFunction 2023/10/27 10:00:01 END: someFunction, Elapsed Time: 1.000123456s 2023/10/27 10:00:01 END: someFunction, Elapsed Time in milliseconds: 1000ms
注意事项：
- log.Println 函数本身也会消耗少量时间，如果需要非常精确的测量，可以考虑使用更底层的计时方法，避免 I/O 操作的干扰。
- 上述代码使用了 log 包进行日志输出，可以根据实际需求替换为其他日志库或自定义的输出方式。
- duration.Milliseconds() 方法将时间差转换为毫秒数。
总结：
通过结合 defer 关键字和 time 包，我们可以轻松地在 Go 语言中测量函数的执行时间，并以毫秒为单位返回运行时间。这种方法简洁易用，适用于大多数性能分析和调试场景。 这种模式可以轻松地应用到任何函数，只需在函数体的开头添加 defer un(trace("FunctionName")) 即可。
