栏目分类:
子分类:
返回
名师互学网用户登录
快速导航关闭
当前搜索
当前分类
子分类
实用工具
热门搜索
名师互学网 > IT > 软件开发 > 后端开发 > Go语言

详解Golang的context

Go语言 更新时间: 发布时间: IT归档 最新发布 模块sitemap 名妆网 法律咨询 聚返吧 英语巴士网 伯小乐 网商动力

详解Golang的context

下面由golang教程栏目给大家详解Golang的context,希望对需要的朋友有所帮助!

前言

是的,今天本来还想出去玩的。买了动车票,然后又睡过头了。。没办法,可能是天意,只好总结一下golang的context,希望能与context之间做一个了断。

公司里头大家写各种服务,必须需要将Context作为第一个参数,刚开始以为主要用于全链路排查跟踪。但是随着接触多了,原来不止于此。

正文

1.context详解

1.1 产生背景

在go的1.7之前,context还是非编制的(包golang.org/x/net/context中),golang团队发现context这个东西还挺好用的,很多地方也都用到了,就把它收编了,1.7版本正式进入标准库

context常用的使用姿势:
1.web编程中,一个请求对应多个goroutine之间的数据交互
2.超时控制
3.上下文控制

1.2 context的底层结构

type Context interface {    Deadline() (deadline time.Time, ok bool)    Done() <-chan struct{}    Err() error    Value(key interface{}) interface{}}

这个就是Context的底层数据结构,来分析下:

字段含义Deadline返回一个time.Time,表示当前Context应该结束的时间,ok则表示有结束时间Done当Context被取消或者超时时候返回的一个close的channel,告诉给context相关的函数要停止当前工作然后返回了。(这个有点像全局广播)Errcontext被取消的原因Valuecontext实现共享数据存储的地方,是协程安全的(还记得之前有说过map是不安全的?所以遇到map的结构,如果不是sync.Map,需要加锁来进行操作)

同时包中也定义了提供cancel功能需要实现的接口。这个主要是后文会提到的“取消信号、超时信号”需要去实现。

// A canceler is a context type that can be canceled directly. The// implementations are *cancelCtx and *timerCtx.type canceler interface {cancel(removeFromParent bool, err error)Done() <-chan struct{}}

那么库里头提供了4个Context实现,来供大家玩耍

实现结构体作用emptyCtxtype emptyCtx int完全空的Context,实现的函数也都是返回nil,仅仅只是实现了Context的接口cancelCtxtype cancelCtx struct {
Context
mu sync.Mutex
done chan struct{}

children map[canceler]struct{}
err error
}继承自Context,同时也实现了canceler接口timerCtxtype timerCtx struct {
cancelCtx
timer *time.Timer // Under cancelCtx.mu.
deadline time.Time
}
继承自cancelCtx,增加了timeout机制valueCtxtype valueCtx struct {
Context
key, val interface{}
}存储键值对的数据

1.3 context的创建

为了更方便的创建Context,包里头定义了Background来作为所有Context的根,它是一个emptyCtx的实例。

var (    background = new(emptyCtx)    todo       = new(emptyCtx) // )func Background() Context {    return background}

你可以认为所有的Context是树的结构,Background是树的根,当任一Context被取消的时候,那么继承它的Context 都将被回收。

2.context实战应用

2.1 WithCancel

实现源码:

func WithCancel(parent Context) (ctx Context, cancel CancelFunc) {c := newCancelCtx(parent)propagateCancel(parent, &c)return &c, func() { c.cancel(true, Canceled) }}

实战场景:
执行一段代码,控制执行到某个度的时候,整个程序结束。

吃汉堡比赛,奥特曼每秒吃0-5个,计算吃到10的用时
实战代码:

func main() {ctx, cancel := context.WithCancel(context.Background())eatNum := chiHanBao(ctx)for n := range eatNum {if n >= 10 {cancel()break}}fmt.Println("正在统计结果。。。")time.Sleep(1 * time.Second)}func chiHanBao(ctx context.Context) <-chan int {c := make(chan int)// 个数n := 0// 时间t := 0go func() {for {//time.Sleep(time.Second)select {case <-ctx.Done():fmt.Printf("耗时 %d 秒,吃了 %d 个汉堡 n", t, n)returncase c <- n:incr := rand.Intn(5)n += incrif n >= 10 {n = 10}t++fmt.Printf("我吃了 %d 个汉堡n", n)}}}()return c}

输出:

我吃了 1 个汉堡我吃了 3 个汉堡我吃了 5 个汉堡我吃了 9 个汉堡我吃了 10 个汉堡正在统计结果。。。耗时 6 秒,吃了 10 个汉堡

2.2 WithDeadline & WithTimeout

实现源码:

func WithDeadline(parent Context, d time.Time) (Context, CancelFunc) {if cur, ok := parent.Deadline(); ok && cur.Before(d) {// The current deadline is already sooner than the new one.return WithCancel(parent)}c := &timerCtx{cancelCtx: newCancelCtx(parent),deadline:  d,}propagateCancel(parent, c)dur := time.Until(d)if dur <= 0 {c.cancel(true, DeadlineExceeded) // deadline has already passedreturn c, func() { c.cancel(true, Canceled) }}c.mu.Lock()defer c.mu.Unlock()if c.err == nil {c.timer = time.AfterFunc(dur, func() {c.cancel(true, DeadlineExceeded)})}return c, func() { c.cancel(true, Canceled) }}func WithTimeout(parent Context, timeout time.Duration) (Context, CancelFunc) {return WithDeadline(parent, time.Now().Add(timeout))}

实战场景:
执行一段代码,控制执行到某个时间的时候,整个程序结束。

吃汉堡比赛,奥特曼每秒吃0-5个,用时10秒,可以吃多少个
实战代码:

func main() {    // ctx, cancel := context.WithDeadline(context.Background(), time.Now().Add(10))ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)chiHanBao(ctx)defer cancel()}func chiHanBao(ctx context.Context) {n := 0for {select {case <-ctx.Done():fmt.Println("stop n")returndefault:incr := rand.Intn(5)n += incrfmt.Printf("我吃了 %d 个汉堡n", n)}time.Sleep(time.Second)}}

输出:

我吃了 1 个汉堡我吃了 3 个汉堡我吃了 5 个汉堡我吃了 9 个汉堡我吃了 10 个汉堡我吃了 13 个汉堡我吃了 13 个汉堡我吃了 13 个汉堡我吃了 14 个汉堡我吃了 14 个汉堡stop

2.3 WithValue

实现源码:

func WithValue(parent Context, key, val interface{}) Context {if key == nil {panic("nil key")}if !reflect.TypeOf(key).Comparable() {panic("key is not comparable")}return &valueCtx{parent, key, val}}

实战场景:
携带关键信息,为全链路提供线索,比如接入elk等系统,需要来一个trace_id,那WithValue就非常适合做这个事。
实战代码:

func main() {ctx := context.WithValue(context.Background(), "trace_id", "88888888")// 携带session到后面的程序中去ctx = context.WithValue(ctx, "session", 1)process(ctx)}func process(ctx context.Context) {session, ok := ctx.Value("session").(int)fmt.Println(ok)if !ok {fmt.Println("something wrong")return}if session != 1 {fmt.Println("session 未通过")return}traceID := ctx.Value("trace_id").(string)fmt.Println("traceID:", traceID, "-session:", session)}

输出:

traceID: 88888888 -session: 1

3.context建议

不多就一个。

Context要是全链路函数的第一个参数

func myTest(ctx context.Context)  {    ...}

(写好了竟然忘记发送了。。。汗)

以上就是详解Golang的context的详细内容,更多请关注考高分网其它相关文章!

转载请注明:文章转载自 www.mshxw.com
本文地址:https://www.mshxw.com/it/793970.html
我们一直用心在做
关于我们 文章归档 网站地图 联系我们

版权所有 (c)2021-2022 MSHXW.COM

ICP备案号:晋ICP备2021003244-6号