Go语言之Context

控制并发有两种经典的方式,一种是WaitGroup,另外一种就是Context,今天我就谈谈Context。

什么是WaitGroup

WaitGroup以前我们在并发的时候介绍过,它是一种控制并发的方式,它的这种方式是控制多个goroutine同时完成。

func main() {

var wg sync.WaitGroup

wg.Add(2)

go func() {

time.Sleep(2*time.Second)

fmt.Println("1号完成")

wg.Done()

}()

go func() {

time.Sleep(2*time.Second)

fmt.Println("2号完成")

wg.Done()

}()

wg.Wait()

fmt.Println("好了,大家都干完了,放工")
}

一个很简单的例子,一定要例子中的两个goroutine同时做完,才算是完成,先做好的就要等着其他未完成的,所有的goroutine要都全部完成才可以。

这是一种控制并发的方式,这种尤其适用于,好多个goroutine协同做一件事情的时候,因为每个goroutine做的都是这件事情的一部分,只有全部的goroutine都完成,这件事情才算是完成,这是等待的方式。

在实际的业务种,我们可能会有这么一种场景:需要我们主动的通知某一个goroutine结束。比如我们开启一个后台goroutine一直做事情,比如监控,现在不需要了,就需要通知这个监控goroutine结束,不然它会一直跑,就泄漏了。

chan通知

我们都知道一个goroutine启动后,我们是无法控制他的,大部分情况是等待它自己结束,那么如果这个goroutine是一个不会自己结束的后台goroutine呢?比如监控等,会一直运行的。

这种情况化,一直傻瓜式的办法是全局变量,其他地方通过修改这个变量完成结束通知,然后后台goroutine不停的检查这个变量,如果发现被通知关闭了,就自我结束。

这种方式也可以,但是首先我们要保证这个变量在多线程下的安全,基于此,有一种更好的方式:chan + select。

func main() {

stop := make(chan bool)

go func() {

for {

select {

case <-stop:

fmt.Println("监控退出,停止了...")                                            return

default:

fmt.Println("goroutine监控中...")

time.Sleep(2 * time.Second)

}

}

}()

time.Sleep(10 * time.Second)

fmt.Println("可以了,通知监控停止")

stop<- true

//为了检测监控过是否停止,如果没有监控输出,就表示停止了

time.Sleep(5 * time.Second)
}

例子中我们定义一个stop的chan,通知他结束后台goroutine。实现也非常简单,在后台goroutine中,使用select判断stop是否可以接收到值,如果可以接收到,就表示可以退出停止了;如果没有接收到,就会执行default里的监控逻辑,继续监控,只到收到stop的通知。

有了以上的逻辑,我们就可以在其他goroutine种,给stop chan发送值了,例子中是在maingoroutine中发送的,控制让这个监控的goroutine结束。

发送了stop<- true结束的指令后,我这里使用time.Sleep(5 * time.Second)故意停顿 5 秒来检测我们结束监控goroutine是否成功。如果成功的话,不会再有goroutine监控中...的输出了;如果没有成功,监控goroutine就会继续打印goroutine监控中...输出。

这种chan+select的方式,是比较优雅的结束一个goroutine的方式,不过这种方式也有局限性,如果有很多goroutine都需要控制结束怎么办呢?如果这些goroutine又衍生了其他更多的goroutine怎么办呢?如果一层层的无穷尽的goroutine呢?这就非常复杂了,即使我们定义很多chan也很难解决这个问题,因为goroutine的关系链就导致了这种场景非常复杂。

初识Context

上面说的这种场景是存在的,比如一个网络请求Request,每个Request都需要开启一个goroutine做一些事情,这些goroutine又可能会开启其他的goroutine。所以我们需要一种可以跟踪goroutine的方案,才可以达到控制他们的目的,这就是Go语言为我们提供的Context,称之为上下文非常贴切,它就是goroutine的上下文。

下面我们就使用Go Context重写上面的示例。

func main() {

ctx, cancel := context.WithCancel(context.Background())

go func(ctx context.Context) {

for {

select {

case <-ctx.Done():

fmt.Println("监控退出,停止了...")

return

default:

fmt.Println("goroutine监控中...")

time.Sleep(2 * time.Second)

}

}

}(ctx)

time.Sleep(10 * time.Second)

fmt.Println("可以了,通知监控停止")

cancel()

//为了检测监控过是否停止,如果没有监控输出,就表示停止了

time.Sleep(5 * time.Second)
}

重写比较简单,就是把原来的chan stop换成Context,使用Context跟踪goroutine,以便进行控制,比如结束等。

context.Background()返回一个空的Context,这个空的Context一般用于整个Context树的根节点。然后我们使用context.WithCancel(parent)函数,创建一个可取消的子Context,然后当作参数传给goroutine使用,这样就可以使用这个子Context跟踪这个goroutine。

在goroutine中,使用select调用<-ctx.Done()判断是否要结束,如果接受到值的话,就可以返回结束goroutine了;如果接收不到,就会继续进行监控。

那么是如何发送结束指令的呢?这就是示例中的cancel函数啦,它是我们调用context.WithCancel(parent)函数生成子Context的时候返回的,第二个返回值就是这个取消函数,它是CancelFunc类型的。我们调用它就可以发出取消指令,然后我们的监控goroutine就会收到信号,就会返回结束。

Context控制多个goroutine

使用Context控制一个goroutine的例子如上,非常简单,下面我们看看控制多个goroutine的例子,其实也比较简单。

func main() {

ctx, cancel := context.WithCancel(context.Background())

go watch(ctx,"【监控1】")

go watch(ctx,"【监控2】")

go watch(ctx,"【监控3】")

time.Sleep(10 * time.Second)

fmt.Println("可以了,通知监控停止")

cancel()

//为了检测监控过是否停止,如果没有监控输出,就表示停止了

time.Sleep(5 * time.Second)}func watch(ctx context.Context, name string) {

for {

select {

case <-ctx.Done():

fmt.Println(name,"监控退出,停止了...")

return

default:

fmt.Println(name,"goroutine监控中...")

time.Sleep(2 * time.Second)

}

}
}

示例中启动了 3 个监控goroutine进行不断的监控,每一个都使用了Context进行跟踪,当我们使用cancel函数通知取消时,这 3 个goroutine都会被结束。这就是Context的控制能力,它就像一个控制器一样,按下开关后,所有基于这个Context或者衍生的子Context都会收到通知,这时就可以进行清理操作了,最终释放goroutine,这就优雅的解决了goroutine启动后不可控的问题。

Context接口

Context的接口定义的比较简洁,我们看下这个接口的方法。

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

Valu (key interface{}) interface{}
}

这个接口共有 4 个方法,了解这些方法的意思非常重要,这样我们才可以更好的使用他们。

Deadline方法是获取设置的截止时间的意思,第一个返回式是截止时间,到了这个时间点,Context会自动发起取消请求;第二个返回值ok==false时表示没有设置截止时间,如果需要取消的话,需要调用取消函数进行取消。

Done方法返回一个只读的chan,类型为struct{},我们在goroutine中,如果该方法返回的chan可以读取,则意味着parent context已经发起了取消请求,我们通过Done方法收到这个信号后,就应该做清理操作,然后退出goroutine,释放资源。

Err方法返回取消的错误原因,因为什么Context被取消。

Value方法获取该Context上绑定的值,是一个键值对,所以要通过一个Key才可以获取对应的值,这个值一般是线程安全的。

以上四个方法中常用的就是Done了,如果Context取消的时候,我们就可以得到一个关闭的chan,关闭的chan是可以读取的,所以只要可以读取的时候,就意味着收到Context取消的信号了,以下是这个方法的经典用法。

func Stream(ctx context.Context, out chan<-Value) error {
        for {
             v, err := DoSomething(ctx)        
            if err != nil {              
                return err             }          
             select {          
                 case <-ctx.Done():             
                     return ctx.Err()         
                 case out <- v:
          }
      }
  }

Context接口并不需要我们实现,Go内置已经帮我们实现了2个,我们代码中最开始都是以这两个内置的作为最顶层的partent context,衍生出更多的子Context。

var (

background = new(emptyCtx)

todo       = new(emptyCtx)
)
func Background() Context {

return background
}
func TODO() Context {

return todo
}

一个是Background,主要用于main函数、初始化以及测试代码中,作为Context这个树结构的最顶层的Context,也就是根Context。

一个是TODO,它目前还不知道具体的使用场景,如果我们不知道该使用什么Context的时候,可以使用这个。

他们两个本质上都是emptyCtx结构体类型,是一个不可取消,没有设置截止时间,没有携带任何值的Context。

type emptyCtx int

func (*emptyCtx) Deadline() (deadline time.Time, ok bool) {

return
}
func (*emptyCtx) Done() <-chan struct{} {

returnnil
}
func (*emptyCtx) Err() error {

returnnil
}
func (*emptyCtx) Value(key interface{}) interface{} {

returnnil
}

这就是emptyCtx实现Context接口的方法,可以看到,这些方法什么都没做,返回的都是nil或者零值。

Context的继承衍生

有了如上的根Context,那么是如何衍生更多的子Context的呢?这就要靠context包为我们提供的With系列的函数了。

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

这四个With函数,接收的都有一个partent参数,就是父Context,我们要基于这个父Context创建出子Context的意思,这种方式可以理解为子Context对父Context的继承,也可以理解为基于父Context的衍生。

通过这些函数,就创建了一颗Context树,树的每个节点都可以有任意多个子节点,节点层级可以有任意多个。

WithCancel函数,传递一个父Context作为参数,返回子Context,以及一个取消函数用来取消Context。

WithDeadline函数,和WithCancel差不多,它会多传递一个截止时间参数,意味着到了这个时间点,会自动取消Context,当然我们也可以不等到这个时候,可以提前通过取消函数进行取消。

WithTimeout和WithDeadline基本上一样,这个表示是超时自动取消,是多少时间后自动取消Context的意思。

WithValue函数和取消Context无关,它是为了生成一个绑定了一个键值对数据的Context,这个绑定的数据可以通过Context.Value方法访问到,后面我们会专门讲。

大家可能留意到,前三个函数都返回一个取消函数CancelFunc,这是一个函数类型,它的定义非常简单。

type CancelFunc func()

这就是取消函数的类型,该函数可以取消一个Context,以及这个节点Context下所有的所有的Context,不管有多少层级。

WithValue传递元数据

通过Context我们也可以传递一些必须的元数据,这些数据会附加在Context上以供使用。

var key string="name"func main() {

ctx, cancel := context.WithCancel(context.Background())    //附加值

valueCtx:=context.WithValue(ctx,key,"【监控1】")

go watch(valueCtx)

time.Sleep(10 * time.Second)

fmt.Println("可以了,通知监控停止")

cancel()

//为了检测监控过是否停止,如果没有监控输出,就表示停止了

time.Sleep(5 * time.Second)}func watch(ctx context.Context) {

for {

select {

case <-ctx.Done():

//取出值

fmt.Println(ctx.Value(key),"监控退出,停止了...")

return

default:

//取出值

fmt.Println(ctx.Value(key),"goroutine监控中...")

time.Sleep(2 * time.Second)

}

}
}

在前面的例子,我们通过传递参数的方式,把name的值传递给监控函数。在这个例子里,我们实现一样的效果,但是通过的是Context的Value的方式。

我们可以使用context.WithValue方法附加一对K-V的键值对,这里Key必须是等价性的,也就是具有可比性;Value值要是线程安全的。

这样我们就生成了一个新的Context,这个新的Context带有这个键值对,在使用的时候,可以通过Value方法读取ctx.Value(key)。

记住,使用WithValue传值,一般是必须的值,不要什么值都传递。

Context 使用原则

·        不要把Context放在结构体中,要以参数的方式传递。

·        以Context作为参数的函数方法,应该把Context作为第一个参数,放在第一位。

·        给一个函数方法传递Context的时候,不要传递nil,如果不知道传递什么,就使用context.TODO。

·        Context的Value相关方法应该传递必须的数据,不要什么数据都使用这个传递。

·        Context是县城安全的,可以放心的在多个goroutine中传递。

时间: 2024-08-27 22:28:33

Go语言之Context的相关文章

Go语言-Context上下文实践

使用 Context 的程序包需要遵循如下的原则来满足接口的一致性以及便于静态分析 1.不要把 Context 存在一个结构体当中,显式地传入函数.Context 变量需要作为第一个参数使用,一般命名为ctx 2.即使方法允许,也不要传入一个 nil 的 Context ,如果你不确定你要用什么 Context 的时候传一个 context.TODO 3.使用 context 的 Value 相关方法只应该用于在程序和接口中传递的和请求相关的元数据,不要用它来传递一些可选的参数 4.同样的 Co

Android 应用内多语言切换

p.p1 { margin: 0.0px 0.0px 12.0px 0.0px; line-height: 18.0px; font: 12.0px ".PingFang SC"; color: #000000 } p.p3 { margin: 0.0px 0.0px 13.9px 0.0px; line-height: 18.0px; font: 16.8px "PT Sans"; color: #000000 } p.p4 { margin: 0.0px 0.0

Windows Store App 全球化 设置指定页面的语言

上一小节介绍了通过在应用程序中添加语言设置选项来改变整个应用显示信息的语言,而有时用户只想对应用中某一页面信息的语言进行调整,这时就不能使用上一小节所讲述的知识来对应用进行设置.下面将通过一个示例介绍如何在指定页面上添加语言可选项,选择语言选项后单击"显示信息"按钮来显示相应语言的信息. 新建一个Windows应用商店的空白应用程序项目,并命名为OverrideLanguage.在项目中添加如18.2.3小节示例中相同的语言文件夹.资源文件以及资源. 双击打开MainPage.xaml

Android实现多语言so easy

微信公众号:CodingAndroid CSDN:http://blog.csdn.net/xinpengfei521声明:本文由CodingAndroid原创,未经授权,不可随意转载! 最近,我们公司的业务已经拓展到了香港,我们都知道香港使用的是繁体中文,因此,我们的APP要可以设置繁体语言,这不我们要紧跟国际的步伐,实现多语言,产品定给我们的需求主要以实现简体中文.繁体中文.英文三种语言切换即可,具体的业务逻辑是:当用户第一次进入APP时,App的语言跟随当前系统语言,当用户设置了某种语言之

什么是架构

什么是软件架构 前言:软体设计师中有一些技术水平较高.经验较为丰富的人,他们需要承担软件系统的架构设计,也就是需要设计系统的元件如何划分.元件之间如何发生相互作用,以及系统中逻辑的.物理的.系统的重要决定的作出.在很多公司中,架构师不是一个专门的和正式的职务.通常在一个开发小组中,最有经验的程序员会负责一些架构方面的工作.在一个部门中,最有经验的项目经理会负责一些架构方面的工作.但是,越来越多的公司体认到架构工作的重要性. 什么是软件系统的架构(Architecture)?一般而言,架构有两个要

iOS学习笔记08-Quartz2D绘图

一.Quartz2D简单介绍 在iOS中常用的绘图框架就是Quartz2D,Quartz2D是Core Graphics框架的一部分,我们日常开发使用的所有UIKit组件都是由Core Graphics进行绘制的 在iOS中Quartz2D绘图的一般步骤: 获取绘制上下文 创建并设置路径 将路径添加进绘制上下文中 设置上下文状态 绘制路径 释放路径 UIKit默认为我们提供了一个图形上下文,在UI控件的drawRect:方法中调用UIGraphicsGetCurrentContext()获取图形

Recovery启动流程(1)--- 应用层到开机进入recovery详解

进入recovery有两种方式,一种是通过组合键进入recovery,另一种是上层应用设置中执行安装/重置/清除缓存等操作进行recovery.这篇文档主要讲解上层应用是如何进入到recovery的.本文以高通平台为例. 1.app执行安装/重置/清楚缓存操作调用代码文件frameworks/base/core/java/android/os/RecoverySystem.java 不同的操作使用不同的方法: 安装升级包  --------  installPackage 清除用户数据-----

Python学习之旅—Django基础

前言  前段时间业务比较繁忙,没时间更新博客,从这周开始将继续为各位更新博客.本次分享的主题是Django的基础部分,涵盖Django MTV三部分,并通过一个简单的班级管理系统来说明如何使用Django进行开发,好啦,开始今天的主题吧! 一.浅谈MVC.MTV和MVVM 要学习Django,我们很有必要了解下MVC,MTV和MVVM三种模式. [001]MVC MVC(Model View Controller 模型-视图-控制器)是一种Web架构的模式(本文不讨论桌面应用的MVC),它把业务

Django的基本使用

小生博客:http://xsboke.blog.51cto.com 小生 Q Q:1770058260 -------谢谢您的参考,如有疑问,欢迎交流 一.静态文件二.路由映射三.视图函数四.template(模板)基础 关于静态文件 1.1 首先需要在配置文件settings.py中指定静态目录STATICFILES_DIRS = (os.path.join(BASE_DIR,"statics"),) 1.2 然后在html中使用django模板语言指定静态文件{% load sta