首页 > 其他分享 >Go 语言 context 都能做什么？

Go 语言 context 都能做什么？

时间：2023-07-02 12:44:57浏览次数：40  
标签：context Context ctx func Go 上下文 语言

原文链接： Go 语言 context 都能做什么？

很多 Go 项目的源码，在读的过程中会发现一个很常见的参数 ctx，而且基本都是作为函数的第一个参数。

为什么要这么写呢？这个参数到底有什么用呢？带着这样的疑问，我研究了这个参数背后的故事。

开局一张图：

核心是 Context 接口：

// A Context carries a deadline, cancelation signal, and request-scoped values
// across API boundaries. Its methods are safe for simultaneous use by multiple
// goroutines.
type Context interface {
    // Done returns a channel that is closed when this Context is canceled
    // or times out.
    Done() <-chan struct{}

    // Err indicates why this context was canceled, after the Done channel
    // is closed.
    Err() error

    // Deadline returns the time when this Context will be canceled, if any.
    Deadline() (deadline time.Time, ok bool)

    // Value returns the value associated with key or nil if none.
    Value(key interface{}) interface{}
}

包含四个方法：

  • Done()：返回一个 channel，当 times out 或者调用 cancel 方法时。
  • Err()：返回一个错误，表示取消 ctx 的原因。
  • Deadline()：返回截止时间和一个 bool 值。
  • Value()：返回 key 对应的值。

有四个结构体实现了这个接口，分别是：emptyCtx, cancelCtx, timerCtx 和 valueCtx。

其中 emptyCtx 是空类型，暴露了两个方法：

func Background() Context
func TODO() Context

一般情况下，会使用 Background() 作为根 ctx，然后在其基础上再派生出子 ctx。要是不确定使用哪个 ctx，就使用 TODO()。

另外三个也分别暴露了对应的方法：

func WithCancel(parent Context) (ctx Context, cancel CancelFunc)
func WithDeadline(parent Context, deadline time.Time) (Context, CancelFunc)
func WithTimeout(parent Context, timeout time.Duration) (Context, CancelFunc)
func WithValue(parent Context, key, val interface{}) Context

遵循规则

在使用 Context 时，要遵循以下四点规则：

  1. 不要将 Context 放入结构体，而是应该作为第一个参数传入，命名为 ctx。
  2. 即使函数允许，也不要传入 nil 的 Context。如果不知道用哪种 Context，可以使用 context.TODO()。
  3. 使用 Context 的 Value 相关方法只应该用于在程序和接口中传递和请求相关的元数据，不要用它来传递一些可选的参数。
  4. 相同的 Context 可以传递给不同的 goroutine；Context 是并发安全的。

WithCancel

func WithCancel(parent Context) (ctx Context, cancel CancelFunc)

WithCancel 返回带有新 Done 通道的父级副本。当调用返回的 cancel 函数或关闭父上下文的 Done 通道时，返回的 ctx 的 Done 通道将关闭。

取消此上下文会释放与其关联的资源，因此在此上下文中运行的操作完成后，代码应立即调用 cancel。

举个例子：

这段代码演示了如何使用可取消上下文来防止 goroutine 泄漏。在函数结束时，由 gen 启动的 goroutine 将返回而不会泄漏。

package main

import (
    "context"
    "fmt"
)

func main() {
    // gen generates integers in a separate goroutine and
    // sends them to the returned channel.
    // The callers of gen need to cancel the context once
    // they are done consuming generated integers not to leak
    // the internal goroutine started by gen.
    gen := func(ctx context.Context) <-chan int {
        dst := make(chan int)
        n := 1
        go func() {
            for {
                select {
                case <-ctx.Done():
                    return // returning not to leak the goroutine
                case dst <- n:
                    n++
                }
            }
        }()
        return dst
    }

    ctx, cancel := context.WithCancel(context.Background())
    defer cancel() // cancel when we are finished consuming integers

    for n := range gen(ctx) {
        fmt.Println(n)
        if n == 5 {
            break
        }
    }
}

输出：

1
2
3
4
5

WithDeadline

func WithDeadline(parent Context, d time.Time) (Context, CancelFunc)

WithDeadline 返回父上下文的副本，并将截止日期调整为不晚于 d。如果父级的截止日期已经早于 d，则 WithDeadline(parent, d) 在语义上等同于 parent。

当截止时间到期、调用返回的取消函数时或当父上下文的 Done 通道关闭时，返回的上下文的 Done 通道将关闭。

取消此上下文会释放与其关联的资源，因此在此上下文中运行的操作完成后，代码应立即调用取消。

举个例子：

这段代码传递具有截止时间的上下文，来告诉阻塞函数，它应该在到达截止时间时立刻退出。

package main

import (
    "context"
    "fmt"
    "time"
)

const shortDuration = 1 * time.Millisecond

func main() {
    d := time.Now().Add(shortDuration)
    ctx, cancel := context.WithDeadline(context.Background(), d)

    // Even though ctx will be expired, it is good practice to call its
    // cancellation function in any case. Failure to do so may keep the
    // context and its parent alive longer than necessary.
    defer cancel()

    select {
    case <-time.After(1 * time.Second):
        fmt.Println("overslept")
    case <-ctx.Done():
        fmt.Println(ctx.Err())
    }
}

输出：

context deadline exceeded

WithTimeout

func WithTimeout(parent Context, timeout time.Duration) (Context, CancelFunc)

WithTimeout 返回 WithDeadline(parent, time.Now().Add(timeout))。

取消此上下文会释放与其关联的资源，因此在此上下文中运行的操作完成后，代码应立即调用取消。

举个例子：

这段代码传递带有超时的上下文，以告诉阻塞函数应在超时后退出。

package main

import (
    "context"
    "fmt"
    "time"
)

const shortDuration = 1 * time.Millisecond

func main() {
    // Pass a context with a timeout to tell a blocking function that it
    // should abandon its work after the timeout elapses.
    ctx, cancel := context.WithTimeout(context.Background(), shortDuration)
    defer cancel()

    select {
    case <-time.After(1 * time.Second):
        fmt.Println("overslept")
    case <-ctx.Done():
        fmt.Println(ctx.Err()) // prints "context deadline exceeded"
    }

}

输出：

context deadline exceeded

WithValue

func WithValue(parent Context, key, val any) Context

WithValue 返回父级的副本，其中与 key 关联的值为 val。

其中键必须是可比较的，并且不应是字符串类型或任何其他内置类型，以避免使用上下文的包之间发生冲突。 WithValue 的用户应该定义自己的键类型。

为了避免分配给 interface{}，上下文键通常具有具体的 struct{} 类型。或者，导出的上下文键变量的静态类型应该是指针或接口。

举个例子：

这段代码演示了如何将值传递到上下文以及如何检索它（如果存在）。

package main

import (
    "context"
    "fmt"
)

func main() {
    type favContextKey string

    f := func(ctx context.Context, k favContextKey) {
        if v := ctx.Value(k); v != nil {
            fmt.Println("found value:", v)
            return
        }
        fmt.Println("key not found:", k)
    }

    k := favContextKey("language")
    ctx := context.WithValue(context.Background(), k, "Go")

    f(ctx, k)
    f(ctx, favContextKey("color"))
}

输出：

found value: Go
key not found: color

本文的大部分内容，包括代码示例都是翻译自官方文档，代码都是经过验证可以执行的。如果有不是特别清晰的地方，可以直接去读官方文档。

以上就是本文的全部内容，如果觉得还不错的话欢迎点赞，转发和关注，感谢支持。

官方文档：

源码分析：

推荐阅读：

标签：context,Context,ctx,func,Go,上下文,语言
From： https://www.cnblogs.com/alwaysbeta/p/17520650.html

相关文章

  • MCU嵌入式开发-硬件和开发语言选择
    引入RTOS的考虑因素主要考虑以下方面来决定是否需要RTOS支持:需要实现高响应时的多任务处理能力需要实现实时性能要求高的任务需要完成多个复杂的并发任务NanoFramework具备满足工控系统实时性要求的各项功能特性。通过它提供的硬件库、线程支持、中断支持等,可以完全控......
  • Google 将为高端 Chromebook 推出独立品牌
    导读说起Chromebook，一般大家的第一印象就是价格便宜、配置不高、做工普通，所选的材料也都是以塑料为主，产品主打的市场也是学生和教育群体。在不少人看来，Chromebook就是一个配备了功能齐全的浏览器，外加一定的文件管理和办公软件的电脑。在疫情的影响下，过去几年Chromebook......
  • Django 网站允许外部访问的设置方法
    ​ Django学习过程中一般都是在本机上使用manage.pyrunserver命令启动开发用HTTP服务器，使用本机浏览器访问此服务器。那么如果需要在联网的其他电脑上访问这个Django服务器，则需要额外做一些设置，否则会显示无法连接或连接失败等错误。1.确认Django的开发服务器正在监听公共IP地......
  • go语言快速入门指北
    0前言本文是个人自用的go语言指南学习笔记，主要是方便我个人复习。通过上面那个指南，对于有编程基础的同学，可以在三天内速成go语言（我只花了两天）0.1推荐学习资料基于VSCODE的go环境搭建go语言指南--------适合快速入门topgoer-----我个人比较推荐这个指南go语言圣经--比......
  • GO语言调用外部函数失败总结
    目录GO练习的项目结构Q1导入的是空路径Q2导入的路径不全Q3找不到路径A3Q4函数不可调用A4Q5报错UseasvalueA5GO练习的项目结构@:~/goProject/test.cn$tree.├──go.mod├──main.go└──model  └──mysql.go1directory,3filesQ1导入的是空路径......
  • Django：单表查询之神奇的双下划线
    一、单表查询中双下划线运用案例models.Tb1.objects.filter(id__lt=10,id__gt=1)、#获取id大于1且小于10的值models.Tb1.objects.filter(id__in=[11,22,33])#获取id等于11、22、33的数据models.Tb1.objects.exclude(id__in=[11,22,33])#notinmodels.Tb1.objec......
  • ImportError：无法从“django.utils.encoding”导入名称“force text”[Python错误已解
    在软件开发过程中遇到错误是很常见的，在使用Python和Django时，这样的错误之一就是ImportError:cannotimportname'forcetext'from'django.utils.encoding'.forcetext此特定错误表明从模块导入方法时出现问题django.utils.encoding。缺少的方法用于将输入数据转换为一致......
  • go src - sync.Map
    前言在并发编程中，我们经常会遇到多个goroutine同时操作一个map的情况。如果在这种情况下直接使用普通的map，那么就可能会引发竞态条件，造成数据不一致或者更严重的问题。sync.Map是Go语言中内置的一种并发安全的map，但是他的实现和用法与普通的map完全不同，这篇文章将详细介绍这些区......
  • go反射使用及proto协议字段随机动态赋值
    1.基本概念Go语言的反射是一种在运行时动态访问程序元数据的能力。反射可以让我们在运行时检查类型和变量，例如它的大小、方法和动态的值等。这种机制让我们可以编写更加通用的函数和类型，而不需要关心具体的类型。在Go语言中，反射的实现主要依赖于两种类型：Type和Value。这......
  • Golang实现图片与视频的缩略图生成
    图片与视频的缩略图是一个十分常见的需求，比如即时消息。这里摘取了Golang项目中的相关代码，分享图片与视频相关处理的开发经验。图片缩略图缩略图的尺寸分为两种规则：1）边长模式，生成正方形缩略图；2）宽高模式，又分三种：指定宽高、指定宽（高等比缩放）、指定高（宽等比缩放）。如果原图为png或gif，缩......

赞助商

阅读排行

网站主页关于我们联系我们网站地图

本网站内容转载自其他媒体，侵权联系[admin##ips99.com]。

Copyright © 2020-2023 IPS99 版权所有 IPS99