Go语言Context包源码学习

简介: 【10月更文挑战第21天】Go 语言中的 `context` 包用于在函数调用链中传递请求上下文信息,支持请求的取消、超时和截止时间管理。其核心接口 `Context` 定义了 `Deadline`、`Done`、`Err` 和 `Value` 方法,分别用于处理截止时间、取消信号、错误信息和键值对数据。包内提供了 `emptyCtx`、`cancelCtx`、`timerCtx` 和 `valueCtx` 四种实现类型,满足不同场景需求。示例代码展示了如何使用带有超时功能的上下文进行任务管理和取消。

在 Go 语言中,context包是用于在函数调用链中传递请求上下文信息的工具,它可以帮助开发者优雅地处理请求的取消、超时和截止时间等情况。以下是对context包源码的学习分析:


一、Context 的接口定义


context包中定义了Context接口:


type Context interface {
    Deadline() (deadline time.Time, ok bool)
    Done() <-chan struct{}
    Err() error
    Value(key any) any
}


  • Deadline方法用于返回当前上下文的截止时间。如果没有设置截止时间,则返回false。这个方法在需要处理超时的场景中非常有用,比如在网络请求或者数据库查询中,可以根据截止时间来决定是否提前终止操作。
  • Done方法返回一个<-chan struct{}类型的通道。当上下文被取消时,这个通道会被关闭。通过监听这个通道,可以及时收到取消信号,从而停止正在进行的操作,释放资源。
  • Err方法在上下文被取消时返回取消的错误原因。它可以帮助开发者确定上下文是因为超时还是主动取消而被终止。
  • Value方法允许在上下文中存储和获取键值对。这个方法通常用于在函数调用链中传递一些特定的请求相关的信息,比如用户 ID、请求 ID 等。


二、Context 的实现类型


  1. emptyCtx:表示一个空的上下文,它实现了Context接口的所有方法,但都不做任何实际操作。


type emptyCtx int
func (*emptyCtx) Deadline() (deadline time.Time, ok bool) {
    return
}
func (*emptyCtx) Done() <-chan struct{} {
    return nil
}
func (*emptyCtx) Err() error {
    return nil
}
func (*emptyCtx) Value(key any) any {
    return nil
}


  1. cancelCtx:可取消的上下文,它内部包含一个Done通道和一个err变量,用于表示取消的错误原因。当调用取消函数时,会关闭Done通道并设置err变量。


type cancelCtx struct {
    Context
    done chan struct{}
    err  error
}
func (c *cancelCtx) Done() <-chan struct{} {
    return c.done
}
func (c *cancelCtx) Err() error {
    return c.err
}
func (c *cancelCtx) cancel(removeFromParent bool, err error) {
    if err == nil {
       panic("context: internal error: missing cancel error")
    }
    close(c.done)
    c.err = err
}


  1. timerCtx:带有超时功能的上下文,它内部包含一个cancelCtx和一个定时器。当定时器超时或者父上下文被取消时,会触发当前上下文的取消操作。


type timerCtx struct {
    cancelCtx
    timer *time.Timer
}
func (c *timerCtx) Deadline() (deadline time.Time, ok bool) {
    return c.timer.C, true
}
func (c *timerCtx) cancel(removeFromParent bool, err error) {
    c.cancelCtx.cancel(false, err)
    if removeFromParent {
       // Remove this context from its parent.
       removeChild(c.cancelCtx.Context, c)
    }
    c.timer.Stop()
}


  1. valueCtx:用于存储键值对的上下文,它内部包含一个父上下文和一个键值对。Value方法会在当前上下文中查找键对应的值,如果找不到则在父上下文中继续查找。


type valueCtx struct {
    Context
    key, val any
}
func (c *valueCtx) Value(key any) any {
    if c.key == key {
       return c.val
    }
    return c.Context.Value(key)
}


三、使用 Context 的示例


以下是一个使用context包的示例代码,展示了如何创建一个带有超时功能的上下文,并在函数调用链中传递和取消上下文:


package main
import (
    "context"
    "fmt"
    "time"
)
func longRunningTask(ctx context.Context) {
    for i := 0; i < 5; i++ {
       select {
       case <-ctx.Done():
          fmt.Println("Task canceled")
          return
       default:
          fmt.Println("Working...")
          time.Sleep(1 * time.Second)
       }
    }
    fmt.Println("Task completed")
}
func main() {
    ctx, cancel := context.WithTimeout(context.Background(), 3*time.Second)
    defer cancel()
    go longRunningTask(ctx)
    <-ctx.Done()
    fmt.Println("Main function completed")
}


在这个示例中,longRunningTask函数模拟了一个长时间运行的任务。在main函数中,使用context.WithTimeout创建了一个带有超时时间为 3 秒的上下文。然后启动一个 goroutine 执行longRunningTask函数,并在main函数中等待上下文被取消。当超时时间到达或者任务被主动取消时,ctx.Done通道会被关闭,从而导致longRunningTask函数中的select语句选择ctx.Done分支,打印出 “Task canceled” 并返回。


通过学习context包的源码,可以更好地理解如何在 Go 语言中管理请求的上下文信息,以及如何优雅地处理取消、超时和截止时间等情况。这对于编写可靠、高效的并发程序非常重要。

目录
打赏
0
0
0
0
255
分享
相关文章
监控局域网其他电脑:Go 语言迪杰斯特拉算法的高效应用
在信息化时代,监控局域网成为网络管理与安全防护的关键需求。本文探讨了迪杰斯特拉(Dijkstra)算法在监控局域网中的应用,通过计算最短路径优化数据传输和故障检测。文中提供了使用Go语言实现的代码例程,展示了如何高效地进行网络监控,确保局域网的稳定运行和数据安全。迪杰斯特拉算法能减少传输延迟和带宽消耗,及时发现并处理网络故障,适用于复杂网络环境下的管理和维护。
揭秘 Go 语言中空结构体的强大用法
Go 语言中的空结构体 `struct{}` 不包含任何字段,不占用内存空间。它在实际编程中有多种典型用法:1) 结合 map 实现集合(set)类型;2) 与 channel 搭配用于信号通知;3) 申请超大容量的 Slice 和 Array 以节省内存;4) 作为接口实现时明确表示不关注值。此外,需要注意的是,空结构体作为字段时可能会因内存对齐原因占用额外空间。建议将空结构体放在外层结构体的第一个字段以优化内存使用。
|
2月前
|
Go 语言入门指南:切片
Golang中的切片(Slice)是基于数组的动态序列,支持变长操作。它由指针、长度和容量三部分组成,底层引用一个连续的数组片段。切片提供灵活的增减元素功能,语法形式为`[]T`,其中T为元素类型。相比固定长度的数组,切片更常用,允许动态调整大小,并且多个切片可以共享同一底层数组。通过内置的`make`函数可创建指定长度和容量的切片。需要注意的是,切片不能直接比较,只能与`nil`比较,且空切片的长度为0。
Go 语言入门指南:切片
eino — 基于go语言的大模型应用开发框架(二)
本文介绍了如何使用Eino框架实现一个基本的LLM(大语言模型)应用。Eino中的`ChatModel`接口提供了与不同大模型服务(如OpenAI、Ollama等)交互的统一方式,支持生成完整响应、流式响应和绑定工具等功能。`Generate`方法用于生成完整的模型响应,`Stream`方法以流式方式返回结果,`BindTools`方法为模型绑定工具。此外,还介绍了通过`Option`模式配置模型参数及模板功能,支持基于前端和用户自定义的角色及Prompt。目前主要聚焦于`ChatModel`的`Generate`方法,后续将继续深入学习。
362 7
企业监控软件中 Go 语言哈希表算法的应用研究与分析
在数字化时代,企业监控软件对企业的稳定运营至关重要。哈希表(散列表)作为高效的数据结构,广泛应用于企业监控中,如设备状态管理、数据分类和缓存机制。Go 语言中的 map 实现了哈希表,能快速处理海量监控数据,确保实时准确反映设备状态,提升系统性能,助力企业实现智能化管理。
38 3
eino — 基于go语言的大模型应用开发框架(一)
Eino 是一个受开源社区优秀LLM应用开发框架(如LangChain和LlamaIndex)启发的Go语言框架,强调简洁性、可扩展性和可靠性。它提供了易于复用的组件、强大的编排框架、简洁明了的API、最佳实践集合及实用的DevOps工具,支持快速构建和部署LLM应用。Eino不仅兼容多种模型库(如OpenAI、Ollama、Ark),还提供详细的官方文档和活跃的社区支持,便于开发者上手使用。
324 8
Go 语言中的 Sync.Map 详解:并发安全的 Map 实现
`sync.Map` 是 Go 语言中用于并发安全操作的 Map 实现,适用于读多写少的场景。它通过两个底层 Map(`read` 和 `dirty`)实现读写分离,提供高效的读性能。主要方法包括 `Store`、`Load`、`Delete` 等。在大量写入时性能可能下降,需谨慎选择使用场景。
Go语言实战:错误处理和panic_recover之自定义错误类型
本文深入探讨了Go语言中的错误处理和panic/recover机制,涵盖错误处理的基本概念、自定义错误类型的定义、panic和recover的工作原理及应用场景。通过具体代码示例介绍了如何定义自定义错误类型、检查和处理错误值,并使用panic和recover处理运行时错误。文章还讨论了错误处理在实际开发中的应用,如网络编程、文件操作和并发编程,并推荐了一些学习资源。最后展望了未来Go语言在错误处理方面的优化方向。
阿里双十一背后的Go语言实践:百万QPS网关的设计与实现
解析阿里核心网关如何利用Go协程池、RingBuffer、零拷贝技术支撑亿级流量。 重点分享: ① 如何用gRPC拦截器实现熔断限流; ② Sync.Map在高并发读写中的取舍。
基于 Go 语言的公司内网管理软件哈希表算法深度解析与研究
在数字化办公中,公司内网管理软件通过哈希表算法保障信息安全与高效管理。哈希表基于键值对存储和查找,如用户登录验证、设备信息管理和文件权限控制等场景,Go语言实现的哈希表能快速验证用户信息,提升管理效率,确保网络稳定运行。
34 0

热门文章

最新文章