Golang使用context控制请求超时示例

使用Context控制请求超时可避免资源浪费和系统阻塞。通过context.WithTimeout创建带超时的Context，传递给HTTP请求，若超时则自动取消，释放资源并提升系统稳定性。

使用context控制请求超时，核心在于利用

context.WithTimeout

context.WithDeadline

package main

import (
    "context"
    "fmt"
    "net/http"
    "time"
)

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

    req, err := http.NewRequestWithContext(ctx, "GET", "https://www.example.com", nil)
    if err != nil {
        fmt.Println("Error creating request:", err)
        return
    }

    client := &http.Client{}
    resp, err := client.Do(req)

    if err != nil {
        fmt.Println("Error making request:", err)
        return
    }
    defer resp.Body.Close()

    fmt.Println("Response Status:", resp.Status)
}

为什么需要使用Context控制请求超时？

资源浪费！如果一个请求因为网络问题或者服务器压力过大而长时间得不到响应，那么程序会一直等待，消耗系统资源。使用超时控制可以避免这种情况，及时释放资源。另外，超时机制可以提高系统的稳定性和用户体验，避免因为个别请求的阻塞而影响整体性能。

如何在不同的Golang HTTP客户端中使用Context超时控制？

LangChain

一个开源框架，用于构建基于大型语言模型（LLM）的应用程序。

下载

立即学习“go语言免费学习笔记（深入）”；

除了标准库的

net/http

• net/http

  (标准库): 像上面的示例一样，使用

  http.NewRequestWithContext

  创建请求，然后使用

  client.Do

  发起请求。

• go-resty

  :

  go-resty

  库提供了更友好的API，可以使用

  R().SetContext(ctx).Get(url)

  方法来设置context。

• fasthttp

  :

  fasthttp

  需要手动检查context的

  Done()

  channel 来判断是否超时，稍微复杂一些。

// go-resty 示例
package main

import (
    "context"
    "fmt"
    "time"

    "github.com/go-resty/resty/v2"
)

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

    client := resty.New()

    resp, err := client.R().
        SetContext(ctx).
        Get("https://www.example.com")

    if err != nil {
        fmt.Println("Error making request:", err)
        return
    }

    fmt.Println("Response Status:", resp.Status())
}

Context超时控制的常见错误和陷阱有哪些？

• 忘记调用

  cancel()

  : 使用

  context.WithTimeout

  或

  context.WithDeadline

  创建的context，必须调用

  cancel()

  函数来释放资源，否则可能会造成资源泄漏。
• 超时时间设置过短: 如果超时时间设置得太短，可能会导致正常的请求也被中断。需要根据实际情况合理设置超时时间。
• 没有正确处理超时错误: 当context超时时，

  client.Do

  会返回一个错误。需要检查这个错误，并进行相应的处理，例如重试或者返回错误给用户。 常见的错误类型是

  context.DeadlineExceeded

  。
• 在goroutine中使用context，但未正确传递或取消: 如果在goroutine中使用context，确保将context正确传递给goroutine，并且在不再需要时取消它。

// 示例：正确处理超时错误
package main

import (
    "context"
    "fmt"
    "net/http"
    "time"
)

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

    req, err := http.NewRequestWithContext(ctx, "GET", "https://www.example.com", nil)
    if err != nil {
        fmt.Println("Error creating request:", err)
        return
    }

    client := &http.Client{}
    resp, err := client.Do(req)

    if err != nil {
        if err == context.DeadlineExceeded {
            fmt.Println("Request timed out!")
        } else {
            fmt.Println("Error making request:", err)
        }
        return
    }
    defer resp.Body.Close()

    fmt.Println("Response Status:", resp.Status)
}