Go 语言基础之 Context 详解

简介: 在 Go 语言中,Context 是一个非常重要的概念,它用于在不同的 goroutine 之间传递请求域的相关数据,并且可以用来控制 goroutine 的生命周期和取消操作。本文将深入探讨 Go 语言中 Context 特性 和 Context 的高级使用方法。

之前有兄弟留言想学习一下 Context,他来了,虽迟但到。

image.png

前言

在 Go 语言中,Context 是一个非常重要的概念,它用于在不同的 goroutine 之间传递请求域的相关数据,并且可以用来控制 goroutine 的生命周期和取消操作。本文将深入探讨 Go 语言中 Context 特性 和 Context 的高级使用方法。

基本用法

在 Go 语言中,Context 被定义为一个接口类型,它包含了三个方法:

# go version 1.18.10
type Context interface {
   
   
    Deadline() (deadline time.Time, ok bool)
    Done() <-chan struct{
   
   }
    Err() error
      Value(key any) any
}
AI 代码解读
  • Deadline() 方法用于获取 Context 的截止时间,
  • Done() 方法用于返回一个只读的 channel,用于通知当前 Context 是否已经被取消,
  • Err() 方法用于获取 Context 取消的原因,
  • Value() 方法用于获取 Context 中保存的键值对数据。

我们日常编写代码时,Context 对象会被被约定作为函数的第一个参数传递,eg:

func users(ctx context.Context, request *Request) {
   
   
    // ... code
}
AI 代码解读

在函数中,可以通过 ctx 参数来获取相关的 Context 数据,举个超时的 eg:

deadline, ok := ctx.Deadline()
if ok && deadline.Before(time.Now()) {
   
   
    // 超时
    return
}
AI 代码解读

Context 控制 goroutine 的生命周期

在 Go 语言中,goroutine 是一种非常常见的并发编程模型,而 Context 可以被用来控制 goroutine 的生命周期,从而避免出现 goroutine 泄漏或者不必要的等待操作。

eg,看一下下方代码:

func users(ctx context.Context, req *Request) {
   
   
    // 启动一个 goroutine 来处理请求
    go func() {
   
   
        // 处理请求...
    }()
}
AI 代码解读

上面的代码中,我们启动了一个 goroutine 来处理请求,但是没有任何方式来控制这个 goroutine 的生命周期,如果这个请求被取消了,那么这个 goroutine 就会一直存在,直到它完成为止。为了避免这种情况的发生,我们可以使用 Context 来控制 goroutine 的生命周期,eg:

func users(ctx context.Context, req *Request) {
    // 启动一个 goroutine 来处理请求
    go func(ctx context.Context) {
        // 处理请求...
    }(ctx)
}
AI 代码解读

在上面的代码中,我们将 Context 对象作为参数传递给了 goroutine 函数,这样在请求被取消时,goroutine 就可以及时退出。

使用 WithValue() 传递数据

除了用于控制 goroutine 的生命周期,Context 还可以被用来在不同的 goroutine 之间传递请求域的相关数据。为了实现这个目的,我们可以使用 Context 的 WithValue() 方法,eg:

type key int

const (
    userKey key = iota
)

func users(ctx context.Context, req *Request) {
   
   
    // 从请求中获取用户信息
    user := req.GetUser
    // 将用户信息保存到 Context 中
    ctx = context.WithValue(ctx, userKey, user)

    // 启动一个 goroutine 来处理请求
    go func(ctx context.Context) {
   
   
        // 从 Context 中获取用户信息
        user := ctx.Value(userKey).(*User)

        // 处理请求...
    }(ctx)

}
AI 代码解读

在上面的代码中,我们定义了一个 key类型的常量 userKey,然后在 users()函数中将用户信息保存到了 Context 中,并将 Context 对象传递给了 goroutine 函数。

在 goroutine 函数中,我们使用 ctx.Value()方法来获取 Context 中保存的用户信息。

注:

Context 中保存的键值对数据应该是线程安全的,因为它们可能会在多个 goroutine 中同时访问。

使用 WithCancel() 取消操作

除了控制 goroutine 的生命周期和传递数据之外,Context 还可以被用来执行取消操作。为了实现这个目的,我们可以使用 Context 的 WithCancel()方法,eg:

func users(ctx context.Context, req *Request) {
   
   
    // 创建一个可以取消的 Context 对象
    ctx, cancel := context.WithCancel(ctx)

    // 启动一个 goroutine 来处理请求
    go func(ctx context.Context) {
   
   
        // 等待请求完成或者被取消
        select {
   
   
        case <-time.After(time.Second):
            // 请求完成
            fmt.Println("Request finish")
        case <-ctx.Done():
            // 请求被取消
            fmt.Println("Request canceled")
        }
    }(ctx)

    // 等待一段时间后取消请求
    time.Sleep(time.Millisecond * 800)
    cancel()
}
AI 代码解读

在上面的代码中,我们使用 WithCancel() 方法创建了一个可以取消的 Context 对象,并将取消操作封装在了一个 cancel() 函数中。然后我们启动了一个 goroutine 函数,使用 select 语句等待请求完成或者被取消,最后在主函数中等待一段时间后调用 cancel() 函数来取消请求。

使用 WithDeadline() 设置截止时间

除了使用 WithCancel() 方法进行取消操作之外,Context 还可以被用来设置截止时间,以便在超时的情况下取消请求。为了实现这个目的,我们可以使用 Context 的 WithDeadline() 方法,eg:

func users(ctx context.Context, req *Request) {
   
   
    // 设置请求的截止时间为当前时间加上 1 秒钟
    ctx, cancel := context.WithDeadline(ctx, time.Now().Add(time.Second))

    // 启动一个 goroutine 来处理请求
    go func(ctx context.Context) {
   
   
        // 等待请求完成或者超时
        select {
   
   
            case <-time.After(time.Millisecond * 500):
            // 请求完成
            fmt.Println("Request finish")
            case <-ctx.Done():
            // 请求超时或者被取消
            fmt.Println("Request canceled or timed out")
        }
    }(ctx)

    // 等待一段时间后取消请求
    time.Sleep(time.Millisecond * 1500)
    cancel()
}
AI 代码解读

在上面的代码中,我们使用 WithDeadline() 方法设置了一个截止时间为当前时间加上 1 秒钟的 Context 对象,并将超时操作封装在了一个 cancel() 函数中。然后我们启动了一个 goroutine 函数,使用 select 语句等待请求完成或者超时,最后在主函数中等待一段时间后调用 cancel() 函数来取消请求。

注:

在使用 WithDeadline() 方法设置截止时间的时候,如果截止时间已经过期,则 Context 对象将被立即取消。

使用 WithTimeout() 设置超时时间

除了使用 WithDeadline() 方法进行截止时间设置之外,Context 还可以被用来设置超时时间。为了实现这个目的,我们可以使用 Context 的 WithTimeout() 方法,eg:

func users(ctx context.Context, req *Request) {
   
   
    // 设置请求的超时时间为 1 秒钟
    ctx, cancel := context.WithTimeout(ctx, time.Second)

    // 启动一个 goroutine 来处理请求
    go func(ctx context.Context) {
   
   
        // 等待请求完成或者超时
        select {
   
   
        case <-time.After(time.Millisecond * 500):
            // 请求完成
            fmt.Println("Request completed")
        case <-ctx.Done():
            // 请求超时或者被取消
            fmt.Println("Request canceled or timed out")
        }
    }(ctx)

    // 等待一段时间后取消请求
    time.Sleep(time.Millisecond * 1500)
    cancel()
}
AI 代码解读

在上面的代码中,我们使用 WithTimeout() 方法设置了一个超时时间为 1 秒钟的 Context 对象,并将超时操作封装在了一个 cancel() 函数中。然后我们启动了一个 goroutine 函数,使用 select 语句等待请求完成或者超时,最后在主函数中等待一段时间后调用 cancel() 函数来取消请求。

注:

需要注意的是,在使用 WithTimeout() 方法设置超时时间的时候,如果超时时间已经过期,则 Context 对象将被立即取消。

Context 的传递

在一个应用程序中,不同的 goroutine 可能需要共享同一个 Context 对象。为了实现这个目的,Context 对象可以通过函数调用或者网络传输等方式进行传递。

例如,我们可以在一个处理 HTTP 请求的函数中创建一个 Context 对象,并将它作为参数传递给一个数据库查询函数,以便在查询过程中使用这个 Context 对象进行取消操作。代码 eg:

func users(ctx context.Context, req *Request) {
   
   
    // 在处理 HTTP 请求的函数中创建 Context 对象
    ctx, cancel := context.WithTimeout(ctx, time.Second)
    defer cancel()

    // 调用数据库查询函数并传递 Context 对象
    result, err := findUserByName(ctx, req)
    if err != nil {
   
   
        // 处理查询错误...
    }

    // 处理查询结果...
}

func findUserByName(ctx context.Context, req *Request) (*Result, error) {
   
   
    // 在数据库查询函数中使用传递的 Context 对象
    rows, err := db.QueryContext(ctx, "SELECT * FROM users WHERE name = ?", req.Name)
    if err != nil {
   
   
        // 处理查询错误...
      }
      defer rows.Close()
      // 处理查询结果...
}
AI 代码解读

在上面的代码中,我们在处理 HTTP 请求的函数中创建了一个 Context 对象,并将它作为参数传递给了一个数据库查询函数 findUserByName()。在 findUserByName() 函数中,我们使用传递的 Context 对象来调用 db.QueryContext() 方法进行查询操作。由于传递的 Context 对象可能会在查询过程中被取消,因此我们需要在查询完成后检查查询操作的错误,以便进行相应的处理。

注:

在进行 Context 的传递时,我们需要保证传递的 Context 对象是原始 Context 对象的子 Context,以便在需要取消操作时能够同时取消所有相关的 goroutine。如果传递的 Context 对象不是原始 Context 对象的子 Context,则取消操作只会影响到当前 goroutine,而无法取消其他相关的 goroutine。

总结

在 Go 语言中,Context 是一个非常重要的特性,包括其基本用法和一些高级用法。Context 可以用于管理 goroutine 的生命周期和取消操作,避免出现资源泄漏和死锁等问题,同时也可以提高应用程序的性能和可维护性。

在使用 Context 的时候,需要注意以下几点:

  • 在创建 goroutine 时,需要将原始 Context 对象作为参数传递给它。
  • 在 goroutine 中,需要使用传递的 Context 对象来进行取消操作,以便能够及时释放相关的资源。
  • Context 的传递时,需要保证传递的 Context 对象是原始 Context 对象的子 Context,以便在需要取消操作时能够同时取消所有相关的 goroutine。
  • 在使用 WithCancel 和 WithTimeout 方法创建 Context 对象时,需要及时调用 cancel 函数,以便能够及时释放资源。
  • 在一些场景下,可以使用 WithValue 方法将数据存储到 Context 中,以便在不同的 goroutine 之间共享数据。

目录
打赏
0
0
0
0
8
分享
相关文章
揭秘 Go 语言中空结构体的强大用法
Go 语言中的空结构体 `struct{}` 不包含任何字段,不占用内存空间。它在实际编程中有多种典型用法:1) 结合 map 实现集合(set)类型;2) 与 channel 搭配用于信号通知;3) 申请超大容量的 Slice 和 Array 以节省内存;4) 作为接口实现时明确表示不关注值。此外,需要注意的是,空结构体作为字段时可能会因内存对齐原因占用额外空间。建议将空结构体放在外层结构体的第一个字段以优化内存使用。
监控局域网其他电脑:Go 语言迪杰斯特拉算法的高效应用
在信息化时代,监控局域网成为网络管理与安全防护的关键需求。本文探讨了迪杰斯特拉(Dijkstra)算法在监控局域网中的应用,通过计算最短路径优化数据传输和故障检测。文中提供了使用Go语言实现的代码例程,展示了如何高效地进行网络监控,确保局域网的稳定运行和数据安全。迪杰斯特拉算法能减少传输延迟和带宽消耗,及时发现并处理网络故障,适用于复杂网络环境下的管理和维护。
Go语言网络编程:使用 net/http 构建 RESTful API
本章介绍如何使用 Go 语言的 `net/http` 标准库构建 RESTful API。内容涵盖 RESTful API 的基本概念及规范,包括 GET、POST、PUT 和 DELETE 方法的实现。通过定义用户数据结构和模拟数据库,逐步实现获取用户列表、创建用户、更新用户、删除用户的 HTTP 路由处理函数。同时提供辅助函数用于路径参数解析,并展示如何设置路由器启动服务。最后通过 curl 或 Postman 测试接口功能。章节总结了路由分发、JSON 编解码、方法区分、并发安全管理和路径参数解析等关键点,为更复杂需求推荐第三方框架如 Gin、Echo 和 Chi。
初探Go语言RPC编程手法
总的来说,Go语言的RPC编程是一种强大的工具,让分布式计算变得简单如同本地计算。如果你还没有试过,不妨挑战一下这个新的编程领域,你可能会发现新的世界。
61 10
|
5月前
|
Go 语言入门指南:切片
Golang中的切片(Slice)是基于数组的动态序列,支持变长操作。它由指针、长度和容量三部分组成,底层引用一个连续的数组片段。切片提供灵活的增减元素功能,语法形式为`[]T`,其中T为元素类型。相比固定长度的数组,切片更常用,允许动态调整大小,并且多个切片可以共享同一底层数组。通过内置的`make`函数可创建指定长度和容量的切片。需要注意的是,切片不能直接比较,只能与`nil`比较,且空切片的长度为0。
125 3
Go 语言入门指南:切片
|
5月前
|
公司局域网管理系统里的 Go 语言 Bloom Filter 算法,太值得深挖了
本文探讨了如何利用 Go 语言中的 Bloom Filter 算法提升公司局域网管理系统的性能。Bloom Filter 是一种高效的空间节省型数据结构,适用于快速判断元素是否存在于集合中。文中通过具体代码示例展示了如何在 Go 中实现 Bloom Filter,并应用于局域网的 IP 访问控制,显著提高系统响应速度和安全性。随着网络规模扩大和技术进步,持续优化算法和结合其他安全技术将是企业维持网络竞争力的关键。
105 2
公司局域网管理系统里的 Go 语言 Bloom Filter 算法,太值得深挖了
|
5月前
|
【02】客户端服务端C语言-go语言-web端PHP语言整合内容发布-优雅草网络设备监控系统-2月12日优雅草简化Centos stream8安装zabbix7教程-本搭建教程非docker搭建教程-优雅草solution
【02】客户端服务端C语言-go语言-web端PHP语言整合内容发布-优雅草网络设备监控系统-2月12日优雅草简化Centos stream8安装zabbix7教程-本搭建教程非docker搭建教程-优雅草solution
141 20
eino — 基于go语言的大模型应用开发框架(二)
本文介绍了如何使用Eino框架实现一个基本的LLM(大语言模型)应用。Eino中的`ChatModel`接口提供了与不同大模型服务(如OpenAI、Ollama等)交互的统一方式,支持生成完整响应、流式响应和绑定工具等功能。`Generate`方法用于生成完整的模型响应,`Stream`方法以流式方式返回结果,`BindTools`方法为模型绑定工具。此外,还介绍了通过`Option`模式配置模型参数及模板功能,支持基于前端和用户自定义的角色及Prompt。目前主要聚焦于`ChatModel`的`Generate`方法,后续将继续深入学习。
722 7
eino — 基于go语言的大模型应用开发框架(一)
Eino 是一个受开源社区优秀LLM应用开发框架(如LangChain和LlamaIndex)启发的Go语言框架,强调简洁性、可扩展性和可靠性。它提供了易于复用的组件、强大的编排框架、简洁明了的API、最佳实践集合及实用的DevOps工具,支持快速构建和部署LLM应用。Eino不仅兼容多种模型库(如OpenAI、Ollama、Ark),还提供详细的官方文档和活跃的社区支持,便于开发者上手使用。
1080 8
企业监控软件中 Go 语言哈希表算法的应用研究与分析
在数字化时代,企业监控软件对企业的稳定运营至关重要。哈希表(散列表)作为高效的数据结构,广泛应用于企业监控中,如设备状态管理、数据分类和缓存机制。Go 语言中的 map 实现了哈希表,能快速处理海量监控数据,确保实时准确反映设备状态,提升系统性能,助力企业实现智能化管理。
80 3
AI助理

你好,我是AI助理

可以解答问题、推荐解决方案等