golang 函数超时时间|极客笔记

golang 函数超时时间

在编程中经常会遇到需要设置函数的超时时间的情况，以防止函数执行时间过长而导致程序阻塞或性能下降。在Go语言中，我们可以利用context包和time包来实现函数的超时处理。

context 包

context包提供了取消操作和超时处理的功能，由于Go语言从1.7版本开始，标准库中正式引入context包，是一种用来简化处理Go程序中多个Goroutine通信和控制的工具。

context包提供了WithCancel、WithDeadline、WithTimeout和WithValue等函数，我们可以使用这些函数来创建各种上下文对象，以在程序中进行超时处理。

具体的使用方法是：在调用函数时，我们可以传入一个context.Context对象，在函数内部使用这个Context对象的Done()方法来接收是否传递了取消指令或者超时指令。

下面通过一个简单的示例来演示如何在Go语言中设置函数的超时时间。

package main

import (
    "context"
    "fmt"
    "time"
)

func longRunningTask(ctx context.Context) {
    select {
    case <-ctx.Done():
        fmt.Println("Task was canceled or timed out")
    case <-time.After(2 * time.Second):
        fmt.Println("Task completed successfully")
    }
}

func main() {
    ctx, cancel := context.WithTimeout(context.Background(), 1*time.Second)
    defer cancel()

    longRunningTask(ctx)
}

在上面的示例中，我们定义了一个longRunningTask函数，该函数接收一个context.Context对象作为参数。在函数内部我们使用了select语句，对ctx.Done()和time.After(2 * time.Second)两个channel进行了监听，以便在取消或者超时时退出函数。

在main函数中，我们通过context.WithTimeout函数创建了一个超时时间为1秒的上下文对象，并将其传递给longRunningTask函数。最后我们通过defer cancel()语句来确保在函数执行完毕后及时释放资源。

接下来我们来运行上面的代码，查看输出：

Task was canceled or timed out

从输出可以看出，由于设置的超时时间为1秒，而longRunningTask中的操作需要2秒才能完成，所以在1秒超时之后，程序输出了Task was canceled or timed out。

time 包

除了使用context包来设置函数的超时时间，我们还可以直接使用time包中的After函数来实现超时处理。After函数会在指定的时间后向返回的channel中发送一个值，我们可以使用这个特性来实现函数的超时处理。

下面我们通过改写上面的示例，使用time.After函数来设置函数的超时时间。

package main

import (
    "fmt"
    "time"
)

func longRunningTask(done chan bool) {
    select {
    case <-done:
        fmt.Println("Task was canceled or timed out")
    case <-time.After(2 * time.Second):
        fmt.Println("Task completed successfully")
    }
}

func main() {
    done := make(chan bool, 1)

    go func() {
        longRunningTask(done)
    }()

    time.Sleep(1 * time.Second)
    done <- true
    time.Sleep(1 * time.Second)
}

在上面的示例中，我们将longRunningTask函数的参数改为一个chan bool类型的channel，用来传递取消指令。我们在main函数中创建了一个buffer为1的channel，并在一个Goroutine中调用了longRunningTask函数。

在主Goroutine中，我们让程序休眠1秒后向donechannel发送取消指令，然后再休眠1秒等待longRunningTask函数的完成。

接下来我们来运行上面的代码，查看输出：