Golang

关注公众号 jb51net

关闭
首页 > 脚本专栏 > Golang > Go Context

重学Go语言之如何使用Context

作者：程序员读书

Context，中文也叫做上下文，Go语言在1.7版本中新增的context包中定义了Context，下面我们就来一起看看如何在Go语言中使用Context吧

我们知道在开发Go应用程序时，尤其是网络应用程序，需要启动大量的Goroutine来处理请求：

不过Goroutine被创建之后，除非执行后正常退出或者触发panic退出，Go并没有提供在一个Goroutine中关闭另一个Goroutine的机制。

有没有一种方法，可以从一个Goroutine中通知另一个Goroutine退出执行呢？这时候就该Context登场了！

什么是Context

Context，中文叫做上下文，Go语言在1.7版本中新增的context包中定义了Context，Context本质是一个接口，这个接口一共定义了四个方法：

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

为什么要使用Context

为什么要使用Context？或者说设计Context的目的是什么？

想像一下这样的场景，当用户开启浏览器访问我们的Web服务时，我们可能会开启多个Goroutine来处理用户的请求，这些Goroutine需要读取不同的资源，最终返回给用户，但如果用户在我们的Web服务还没处理完成就关闭浏览器，断开连接，而此时Web不知道用户已经关闭请求，仍然在处理并返回最终并不会被接收的数据。

Context设计的目的就是可以从上游的Goroutine发送信息给下游的Goroutine，回到处理用户请求的场景，当处理请求的Goroutine发现用户断开连接时，通过Context发送停止执行的信息，而下游的Goroutine得到停止信号时就返回，避免资源的浪费。

概括起来，Context的作用主要体现在两个方面：

Context的使用

下面我们来讲讲Context的基本使用。

创建Context

任何上下文都是从一个空白的Context开始的，创建一个空白的Context有两种方式：

使用context.Background()：

ctx := context.Backgroud()

使用contenxt.TODO():

ctx := context.TODO()

当然大部分时候，我们不需要自己创建一个空白的Context，比如在处理HTTP请求时：

http.HandleFunc("/hello", func(w http.ResponseWriter, r *http.Request) {
 ctx := r.Context()
})

上面的代码中，可以从http.Request中获取Context实例，而http.Request的实际上也是调用context.Backgroud():

//net/http/request.go
func (r *Request) Context() context.Context {
 if r.ctx != nil {
  return r.ctx
 }
 return context.Background()
}

实例讲解

为了讲解Context是如何在Goroutine之间传递信号与数据，我们通过下面的案例进行说明：

func ReadFile(ctx context.Context, fileName string, result chan<- []byte) {
 file, err := os.Open(fileName)
 if err != nil {
  return
 }
 totalResult := make([]byte, 0)
 for {
  select {
  case <-ctx.Done():
   result <- []byte{}
   return
  default:
  }
  b := make([]byte, 1024)
  _, err := file.Read(b)
  if err == io.EOF {
   totalResult = append(totalResult, b...)
   break
  }
  totalResult = append(totalResult, b...)
 }
 result <- totalResult
}

在上面的程序中，我们调用Context的Done()方法，该方法会返回一个Channel，而使用select语句则可以让我们在处理业务的同时，监听上游Goroutine是否有传递取消执行的信息。

利用Context传递停止信号

空白的Context并不能发挥什么作用，要达到手动取消执行的目的，需要调用context包下的WithCancel函数进行封装，封装返回一个新的context以及一个取消的句柄cancel函数：

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

下面是完整的使用方法：

package main
import (
 "context"
 "fmt"
 "io"
 "os"
 "time"
)
func main() {
 ctx := context.Background()
 ctx, cancel := context.WithCancel(ctx)
 result := make(chan []byte)
 go ReadFile(ctx, "./test.tar", result)
 time.Sleep(100 * time.Millisecond)
 cancel()
 fmt.Println(<-result)
}

在上面的程序中，我们创建一个Context之后，传给了ReadFile函数，并且在暂停100毫秒后调用cancel()函数，达到手动取消另一个Goroutine的目的。

给Context设置一个截止时间

除了手动取消，也可以调用context包下的WithDeadline()函数给Context加一个截止时间，这样在某个时间点，Context会自动发出取消信号：

afterTime := time.Now().Add(30 * time.Millisecond)
ctx, cancel := context.WithDeadline(context.Background(), afterTime)

下面是完整的示例：

package main
import (
 "context"
 "fmt"
 "io"
 "os"
 "time"
)
func main() {
 afterTime := time.Now().Add(30 * time.Millisecond)
 ctx, cancel := context.WithDeadline(context.Background(), afterTime)
 defer cancel()
 result := make(chan []byte)
 go ReadFile(ctx, "./test.tar", result)
 fmt.Println(<-result)
}

给Context一个超时限制

调用context包下的WithTimeout()函数可以为Context加一个超时限制，这对于我们编写超时控制程序非常有帮助：

ctx, cancel := context.WithTimeout(context.Background(), 10*time.Millisecond)

下面是完整的调用程序：

package main
import (
 "context"
 "fmt"
 "io"
 "os"
 "time"
)
func main() {
 ctx, cancel := context.WithTimeout(context.Background(), 10*time.Millisecond)
 defer cancel()
 result := make(chan []byte)
 go ReadFile(ctx, "./test.tar", result)
 fmt.Println(<-result)
}

使用Context传递数据

调用context包下的WithValue()函数可以生成一个携带数据的Context，这个机制方便我们跟踪一个处理流程中的Goroutine：

 ctx, cancel := context.WithValue(context.Background(), "testKey","testValue")

下游的Goroutine就可以通过Context的Value()函数来获取上游传递下来的值了。

func MyGoroutine(ctx context.Context){
 ctx.Value("testKey")
}

使用Context的几点建议

Context不要放在结构体中，需要以参数方式传递。

Context作为函数参数时，一般放在第一位，作为函数的第一个参数。

使用 context.Background函数生成根节点的Context。

Context 要传值必要的值，不要什么都传。

Context 是多协程安全的，可以在多个协程中使用。

小结

好了，至此，你应该对Context有所了解了吧，总的来说，通过Context可以做到：

到此这篇关于重学Go语言之如何使用Context的文章就介绍到这了,更多相关Go Context内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:
阅读全文