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

相关文章
|
6月前
|
Java 编译器 Go
【Golang】(1)Go的运行流程步骤与包的概念
初次上手Go语言!先来了解它的运行流程吧! 在Go中对包的概念又有怎样不同的见解呢?
328 4
|
6月前
|
存储 安全 Java
【Golang】(4)Go里面的指针如何?函数与方法怎么不一样?带你了解Go不同于其他高级语言的语法
结构体可以存储一组不同类型的数据,是一种符合类型。Go抛弃了类与继承,同时也抛弃了构造方法,刻意弱化了面向对象的功能,Go并非是一个传统OOP的语言,但是Go依旧有着OOP的影子,通过结构体和方法也可以模拟出一个类。
336 2
|
8月前
|
Cloud Native 安全 Java
Go:为云原生而生的高效语言
Go:为云原生而生的高效语言
514 1
|
8月前
|
Cloud Native Go API
Go:为云原生而生的高效语言
Go:为云原生而生的高效语言
541 0
|
8月前
|
Cloud Native Java Go
Go:为云原生而生的高效语言
Go:为云原生而生的高效语言
366 0
|
8月前
|
Cloud Native Java 中间件
Go:为云原生而生的高效语言
Go:为云原生而生的高效语言
419 0
|
8月前
|
Cloud Native Java Go
Go:为云原生而生的高效语言
Go:为云原生而生的高效语言
451 0
|
8月前
|
数据采集 Go API
Go语言实战案例:多协程并发下载网页内容
本文是《Go语言100个实战案例 · 网络与并发篇》第6篇,讲解如何使用 Goroutine 和 Channel 实现多协程并发抓取网页内容,提升网络请求效率。通过实战掌握高并发编程技巧,构建爬虫、内容聚合器等工具,涵盖 WaitGroup、超时控制、错误处理等核心知识点。
|
8月前
|
缓存 监控 安全
告别缓存击穿!Go 语言中的防并发神器:singleflight 包深度解析
在高并发场景中,多个请求同时访问同一资源易导致缓存击穿、数据库压力过大。Go 语言提供的 `singleflight` 包可将相同 key 的请求合并,仅执行一次实际操作,其余请求共享结果,有效降低系统负载。本文详解其原理、实现及典型应用场景,并附示例代码,助你掌握高并发优化技巧。
556 0
|
8月前
|
数据采集 JSON Go
Go语言实战案例:实现HTTP客户端请求并解析响应
本文是 Go 网络与并发实战系列的第 2 篇,详细介绍如何使用 Go 构建 HTTP 客户端,涵盖请求发送、响应解析、错误处理、Header 与 Body 提取等流程,并通过实战代码演示如何并发请求多个 URL,适合希望掌握 Go 网络编程基础的开发者。

热门文章

最新文章