go语言的context怎么用

官方文档

背景

context直译就是上下文的意思,这样翻译自然是不知道它是用来做什么的。我看先来看看它的官方文档:


context

go服务的每个请求都是使用goroutine来处理,有时候还会产生额外的goroutine。当这些goroutine处理完请求后,需要立即退出,这样才能释放goroutine的资源。
所以官方开发了context包来帮助我们管理/释放goroutine资源。

说明

这是 Context 定义

// Context 携带截止日期、取消信号和请求范围的值 跨越 API 边界。
// 多个 goroutine同时使用它的方法是安全的。
type Context interface {
    // Done 返回一个在取消此上下文时关闭的通道或超时。
    Done() <-chan struct{}

    // Err 指示为什么在 Done 通道关闭后取消此上下文。
    Err() error

    // Deadline 返回取消此 Context 的时间(如果有)。
    Deadline() (deadline time.Time, ok bool)

    // Value 返回与 key 关联的值,如果没有则返回 nil。
    Value(key interface{}) interface{}
}

使用方法

WithCancel

定义一个函数,在goroutine时调用,可以写业务代码,异步处理业务数据

func do(ctx context.Context) {
    // 一直循环,知道 ctx.Done() 收到信号
    for {
        select {
        case v := <-ctx.Done():
            // cancel 被调用时,会接收到channel信号,然后退出
            fmt.Println("goroutine exit", v)
            return
        default:
            // 延时一下
            time.Sleep(time.Millisecond * 500)
            fmt.Println(time.Now())
        }
    }
}

context.WithCancel会返回一个新的contextcancel,将ctx传递给goroutine去监听,如果cancel被调用,Done()就会收到信号,然后退出goroutine。
context.Background()是一个空的context,它作为根context是必须的。这里要注意的是context.WithCancelcancel需要手动调用。

func main() {
    parentCtx := context.Background()

    // 创建一个 cancel context
    ctx, cancel := context.WithCancel(parentCtx)
    defer cancel()

    go func() {
        do(ctx)
    }()

    //  等一会,调用cancel() 释放 goroutine
    time.Sleep(time.Second * 5)
    cancel()
    time.Sleep(time.Second * 1)
}

WithTimeout

context.WithTimeout 可以指定超时时间,并在超时后自动调用cancel(),这样可以可以向do()函数里面的ctx.Done()发送结束消息,然后return。这样使用方法,可以防止goroutine被阻塞,而导致内存泄露或阻塞了外部的业务(wg.Wait()阻塞)。

func main() {
    parentCtx := context.Background()

    // 创建一个 WithTimeout context,超时后会自动调动cancel()
    ctx, cancel := context.WithTimeout(parentCtx, time.Second*5)
    defer cancel()

    var wg sync.WaitGroup
    wg.Add(1)
    go func() {
        defer wg.Done()
        do(ctx)
    }()

    // WithTimeout 超时后,会自动调动cancel() 退出goroutine
    wg.Wait()
}

WithDeadline

context.WithTimeout相似,context.WithDeadline可以指定在某一个具体的时间点调用cancel函数

func main() {
    parentCtx := context.Background()

    after := time.Now().Add(time.Second * 5)
    // 创建一个 WithDeadline context, 指定时间调用cancel
    ctx, cancel := context.WithDeadline(parentCtx, after)
    defer cancel()

    var wg sync.WaitGroup
    wg.Add(1)
    go func() {
        defer wg.Done()
        do(ctx)
    }()

    // 等待goroutine退出
    wg.Wait()
}

WithValue

context.WithValue与上述的三个函数不同,该函数返回值只有context,是没有cancel的。但它能存储一个kv值,提供给用户传递上下文参数信息。注意:这里的kv不是让用户存储业务数据。

func main() {
    parentCtx := context.Background()

    key := "contextKey"
    var s any = "1"
    // 创建一个 WithDeadline context, 指定时间调用cancel
    valueCtx := context.WithValue(parentCtx, key, s)


    fmt.Println(ctx.Value(key), valueCtx.Value(key))
}

`context.WithValue`只会返回`context`,不会返回`cancel`,但它可以结合`WithTimeout`、`WithDeadline`、`WithCancel`使用。
``` go
func main() {
    parentCtx := context.Background()

    key := "contextKey"
    var s any = "1"
    // 创建一个 WithDeadline context, 指定时间调用cancel
    valueCtx := context.WithValue(parentCtx, key, s)

    ctx, cancel := context.WithTimeout(valueCtx, time.Second*5)
    defer cancel()

    var wg sync.WaitGroup
    for i := 0; i < 10; i++ {
        wg.Add(1)
        go func() {
            defer wg.Done()
            do(ctx)
        }()
    }

    fmt.Println(ctx.Value(key), valueCtx.Value(key))
    // 等待goroutine退出
    wg.Wait()
}

应用场景

1. 控制或管理goroutine的释放,多goroutine管理;
2. 传递请求的上下文的参数(不是指业务参数),例如,做链路追踪日志时,可以存放traceId.
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 218,122评论 6 505
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,070评论 3 395
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 164,491评论 0 354
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,636评论 1 293
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,676评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,541评论 1 305
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,292评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,211评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,655评论 1 314
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,846评论 3 336
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,965评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,684评论 5 347
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,295评论 3 329
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,894评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,012评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,126评论 3 370
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,914评论 2 355

推荐阅读更多精彩内容