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 语言中管理请求的上下文信息,以及如何优雅地处理取消、超时和截止时间等情况。这对于编写可靠、高效的并发程序非常重要。

相关文章
|
1天前
|
存储 Go 索引
go语言使用for循环遍历
go语言使用for循环遍历
15 7
|
4天前
|
存储 Go
go语言 遍历映射(map)
go语言 遍历映射(map)
18 2
|
5天前
|
Go 调度 开发者
Go语言中的并发编程:深入理解goroutines和channels####
本文旨在探讨Go语言中并发编程的核心概念——goroutines和channels。通过分析它们的工作原理、使用场景以及最佳实践,帮助开发者更好地理解和运用这两种强大的工具来构建高效、可扩展的应用程序。文章还将涵盖一些常见的陷阱和解决方案,以确保在实际应用中能够避免潜在的问题。 ####
|
5天前
|
测试技术 Go 索引
go语言使用 range 关键字遍历
go语言使用 range 关键字遍历
14 3
|
5天前
|
测试技术 Go 索引
go语言通过 for 循环遍历
go语言通过 for 循环遍历
15 3
|
7天前
|
安全 Go 数据处理
Go语言中的并发编程:掌握goroutine和channel的艺术####
本文深入探讨了Go语言在并发编程领域的核心概念——goroutine与channel。不同于传统的单线程执行模式,Go通过轻量级的goroutine实现了高效的并发处理,而channel作为goroutines之间通信的桥梁,确保了数据传递的安全性与高效性。文章首先简述了goroutine的基本特性及其创建方法,随后详细解析了channel的类型、操作以及它们如何协同工作以构建健壮的并发应用。此外,还介绍了select语句在多路复用中的应用,以及如何利用WaitGroup等待一组goroutine完成。最后,通过一个实际案例展示了如何在Go中设计并实现一个简单的并发程序,旨在帮助读者理解并掌
|
6天前
|
Go 索引
go语言按字符(Rune)遍历
go语言按字符(Rune)遍历
21 3
|
10天前
|
Go API 数据库
Go 语言中常用的 ORM 框架,如 GORM、XORM 和 BeeORM,分析了它们的特点、优势及不足,并从功能特性、性能表现、易用性和社区活跃度等方面进行了比较,旨在帮助开发者根据项目需求选择合适的 ORM 框架。
本文介绍了 Go 语言中常用的 ORM 框架,如 GORM、XORM 和 BeeORM,分析了它们的特点、优势及不足,并从功能特性、性能表现、易用性和社区活跃度等方面进行了比较,旨在帮助开发者根据项目需求选择合适的 ORM 框架。
34 4
|
10天前
|
缓存 监控 前端开发
在 Go 语言中实现 WebSocket 实时通信的应用,包括 WebSocket 的简介、Go 语言的优势、基本实现步骤、应用案例、注意事项及性能优化策略,旨在帮助开发者构建高效稳定的实时通信系统
本文深入探讨了在 Go 语言中实现 WebSocket 实时通信的应用,包括 WebSocket 的简介、Go 语言的优势、基本实现步骤、应用案例、注意事项及性能优化策略,旨在帮助开发者构建高效稳定的实时通信系统。
45 1
|
8天前
|
存储 Go PHP
Go语言中的加解密利器:go-crypto库全解析
在软件开发中,数据安全和隐私保护至关重要。`go-crypto` 是一个专为 Golang 设计的加密解密工具库,支持 AES 和 RSA 等加密算法,帮助开发者轻松实现数据的加密和解密,保障数据传输和存储的安全性。本文将详细介绍 `go-crypto` 的安装、特性及应用实例。
26 0