Heim >Backend-Entwicklung >Golang >Detaillierte Erläuterung des Kontexts in der Go-Sprache

Detaillierte Erläuterung des Kontexts in der Go-Sprache

Guanhui
Guanhuinach vorne
2020-06-18 17:54:173790Durchsuche

Detaillierte Erläuterung des Kontexts in der Go-Sprache

1. Was ist Kontext?

Vor Go 1.7 war der Kontext nicht kompiliert und existierte im Paket golang.org/x/net/context.

Später stellte das Golang-Team fest, dass der Kontext recht einfach zu verwenden war, und integrierte daher den Kontext in die Standardbibliothek in Go 1.7.

Kontext, auch Kontext genannt, seine Schnittstelle ist wie folgt definiert

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

Sie können sehen, dass die Kontextschnittstelle insgesamt 4 Methoden hat

  • Deadline: Der erste zurückgegebene Wert ist Deadline . Zu diesem Zeitpunkt löst der Kontext automatisch die Aktion „Abbrechen“ aus. Der zweite zurückgegebene Wert ist ein boolescher Wert. True bedeutet, dass die Frist festgelegt ist. Wenn die Frist nicht festgelegt ist, muss die Abbruchfunktion manuell aufgerufen werden, um den Kontext abzubrechen.
  • Done: Gibt einen schreibgeschützten Kanal zurück (wird erst nach Abbruch zurückgegeben), Typ ist struct{}. Wenn dieser Kanal lesbar ist, bedeutet dies, dass der übergeordnete Kontext eine Abbruchanforderung initiiert hat. Basierend auf diesem Signal kann der Entwickler einige Bereinigungsaktionen durchführen und die Goroutine beenden.
  • Err: Gibt den Grund zurück, warum der Kontext abgebrochen wurde.
  • Value: Gibt den an den Kontext gebundenen Wert zurück, bei dem es sich um ein Schlüssel-Wert-Paar handelt, sodass der entsprechende Wert über einen Schlüssel abgerufen werden kann. Dieser Wert ist im Allgemeinen threadsicher.

2. Warum ist Kontext erforderlich?

Wenn eine Goroutine geöffnet wird, können wir ihr Schließen nicht erzwingen.

Häufige Gründe für das Schließen von Coroutinen sind wie folgt:

  1. Goroutine beendet die Ausführung und beendet sich von selbst
  2. Der Hauptprozess stürzt ab und wird beendet, und Goroutine muss beendet werden
  3. Senden Sie ein Signal über den Kanal, um den Abschluss der Coroutine zu steuern.

Der erste Typ ist ein normaler Shutdown und fällt nicht in den Rahmen der heutigen Diskussion.

Der zweite Typ ist ein abnormales Herunterfahren und der Code sollte optimiert werden.

Die dritte Methode besteht darin, dass Entwickler die Coroutine manuell steuern können. Das Codebeispiel lautet wie folgt:

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)

}

Im Beispiel definieren wir einen stop-Chan, um ihn zu benachrichtigen, den Hintergrund zu beenden Goroutine. Die Implementierung ist ebenfalls sehr einfach. Verwenden Sie select, um zu bestimmen, ob stop den Wert empfangen kann. Dies bedeutet, dass die Überwachungslogik beendet und gestoppt werden kann default wird ausgeführt. Überwachen Sie weiter, bis Sie eine stop-Benachrichtigung erhalten.

Das Obige ist ein Goroutine-Szenario. Was ist, wenn mehrere Goroutinen vorhanden sind und unter jeder Goroutine mehrere Goroutine-Szenarien geöffnet sind? In Feixue Qingqings Blog über die Verwendung von Context sagte er Folgendes:

Die Chan+Select-Methode ist eine elegantere Möglichkeit, eine Goroutine zu beenden, aber diese Methode weist auch Einschränkungen auf viele Goroutinen, die kontrolliert werden müssen, um zu enden? Was wäre, wenn diese Goroutinen andere Goroutinen hervorbringen würden? Was wäre, wenn es endlose Schichten von Goroutinen gäbe? Das ist sehr kompliziert. Selbst wenn wir viele Kanäle definieren, wird es schwierig sein, dieses Problem zu lösen, da die Beziehungskette von Goroutine dieses Szenario sehr kompliziert macht.

Ich bin mit dem, was er hier gesagt hat, nicht ganz einverstanden, weil ich denke, dass selbst die Verwendung nur eines Kanals den Zweck der Steuerung (Abbruch) mehrerer Goroutinen erreichen kann. Lassen Sie uns dies anhand eines Beispiels überprüfen.

Das Prinzip dieses Beispiels lautet: Wenn der Kanal nach der Verwendung von close zum Schließen des Kanals ungepuffert ist, ändert er sich von der ursprünglichen Blockierung in die Nichtblockierung, dh er ist lesbar, aber der Lesevorgang wird ausgeführt immer Null, sodass Sie anhand dieser Funktion bestimmen können, ob die Goroutine, die den Kanal besitzt, geschlossen werden soll.

package main

import (
    "fmt"
    "time"
)

func monitor(ch chan bool, number int)  {
    for {
        select {
        case v := <-ch:
            // 仅当 ch 通道被 close,或者有数据发过来(无论是true还是false)才会走到这个分支
            fmt.Printf("监控器%v,接收到通道值为:%v,监控结束。\n", number,v)
            return
        default:
            fmt.Printf("监控器%v,正在监控中...\n", number)
            time.Sleep(2 * time.Second)
        }
    }
}

func main() {
    stopSingal := make(chan bool)

    for i :=1 ; i <= 5; i++ {
        go monitor(stopSingal, i)
    }

    time.Sleep( 1 * time.Second)
    // 关闭所有 goroutine
    close(stopSingal)

    // 等待5s,若此时屏幕没有输出 <正在监控中> 就说明所有的goroutine都已经关闭
    time.Sleep( 5 * time.Second)

    fmt.Println("主程序退出!!")

}

Die Ausgabe ist wie folgt

监控器4,正在监控中...
监控器1,正在监控中...
监控器2,正在监控中...
监控器3,正在监控中...
监控器5,正在监控中...
监控器2,接收到通道值为:false,监控结束。
监控器3,接收到通道值为:false,监控结束。
监控器5,接收到通道值为:false,监控结束。
监控器1,接收到通道值为:false,监控结束。
监控器4,接收到通道值为:false,监控结束。
主程序退出!!

Das obige Beispiel zeigt, dass wir, wenn wir einen ungepufferten Kanal definieren und alle Goroutinen schließen möchten, close verwenden können, um den Kanal zu schließen, und dann in allen Goroutinen Überprüfen Sie kontinuierlich, ob der Kanal geschlossen ist (Voraussetzung ist, dass Sie eine Vereinbarung treffen müssen, nur den Kanal zu schließen und keine anderen Daten zu senden. Andernfalls wird durch einmaliges Senden von Daten eine Goroutine geschlossen, was unseren Erwartungen nicht entspricht Am besten entscheiden Sie, ob Sie die Goroutine beenden möchten. Dieser Kanal ist gekapselt und eingeschränkt.

Wie Sie hier sehen, habe ich als Anfänger immer noch keinen bestimmten Grund gefunden, Kontext zu verwenden. Ich kann nur sagen, dass die Verwendung von Kontext für uns einfacher ist Es gibt einige Probleme beim Umgang mit Parallelität, aber es ist nicht unverzichtbar.

Mit anderen Worten, es löst nicht das Problem, ob verwendet werden kann, sondern das Problem, ob besser zu verwenden ist.

3. Verwenden Sie einfach den Kontext

Wenn Sie die oben beschriebene Methode zum Schließen des Kanals nicht verwenden, gibt es eine andere elegantere Möglichkeit, dies zu erreichen?

Ja, darum geht es in diesem Artikel. Context

Ich habe Context verwendet, um das obige Beispiel zu modifizieren.

package main

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

func monitor(ctx context.Context, number int)  {
    for {
        select {
        // 其实可以写成 case <- ctx.Done()
        // 这里仅是为了让你看到 Done 返回的内容
        case v :=<- ctx.Done():
            fmt.Printf("监控器%v,接收到通道值为:%v,监控结束。\n", number,v)
            return
        default:
            fmt.Printf("监控器%v,正在监控中...\n", number)
            time.Sleep(2 * time.Second)
        }
    }
}

func main() {
    ctx, cancel := context.WithCancel(context.Background())

    for i :=1 ; i <= 5; i++ {
        go monitor(ctx, i)
    }

    time.Sleep( 1 * time.Second)
    // 关闭所有 goroutine
    cancel()

    // 等待5s,若此时屏幕没有输出 <正在监控中> 就说明所有的goroutine都已经关闭
    time.Sleep( 5 * time.Second)

    fmt.Println("主程序退出!!")

}

Der Schlüsselcode besteht hier nur aus drei Zeilen

第一行:以 context.Background() 为 parent context 定义一个可取消的 context

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

第二行:然后你可以在所有的goroutine 里利用 for + select 搭配来不断检查 ctx.Done() 是否可读,可读就说明该 context 已经取消,你可以清理 goroutine 并退出了。

case <- ctx.Done():

第三行:当你想到取消 context 的时候,只要调用一下 cancel 方法即可。这个 cancel 就是我们在创建 ctx 的时候返回的第二个值。

cancel()

运行结果输出如下。可以发现我们实现了和 close 通道一样的效果。

监控器3,正在监控中...
监控器4,正在监控中...
监控器1,正在监控中...
监控器2,正在监控中...
监控器2,接收到通道值为:{},监控结束。
监控器5,接收到通道值为:{},监控结束。
监控器4,接收到通道值为:{},监控结束。
监控器1,接收到通道值为:{},监控结束。
监控器3,接收到通道值为:{},监控结束。
主程序退出!!

4. 根Context 是什么?

创建 Context 必须要指定一个 父 Context,当我们要创建第一个Context时该怎么办呢?

不用担心,Go 已经帮我们实现了2个,我们代码中最开始都是以这两个内置的context作为最顶层的parent 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的时候,可以使用这个,但是实际应用中,暂时还没有使用过这个TODO。

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

type emptyCtx int

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

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

func (*emptyCtx) Err() error {
    return nil
}

func (*emptyCtx) Value(key interface{}) interface{} {
    return nil
}

5. Context 的继承衍生

上面在定义我们自己的 Context 时,我们使用的是 WithCancel 这个方法。

除它之外,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

这四个函数有一个共同的特点,就是第一个参数,都是接收一个 父context。

通过一次继承,就多实现了一个功能,比如使用 WithCancel 函数传入 根context ,就创建出了一个子 context,该子context 相比 父context,就多了一个 cancel context 的功能。

如果此时,我们再以上面的子context(context01)做为父context,并将它做为第一个参数传入WithDeadline函数,获得的子子context(context02),相比子context(context01)而言,又多出了一个超过 deadline 时间后,自动 cancel context 的功能。

接下来我会举例介绍一下这几种 context,其中 WithCancel 在上面已经讲过了,下面就不再举例了

例子 1:WithDeadline

package main

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

func monitor(ctx context.Context, number int)  {
    for {
        select {
        case <- ctx.Done():
            fmt.Printf("监控器%v,监控结束。\n", number)
            return
        default:
            fmt.Printf("监控器%v,正在监控中...\n", number)
            time.Sleep(2 * time.Second)
        }
    }
}

func main() {
    ctx01, cancel := context.WithCancel(context.Background())
    ctx02, cancel := context.WithDeadline(ctx01, time.Now().Add(1 * time.Second))

    defer cancel()

    for i :=1 ; i <= 5; i++ {
        go monitor(ctx02, i)
    }

    time.Sleep(5  * time.Second)
    if ctx02.Err() != nil {
        fmt.Println("监控器取消的原因: ", ctx02.Err())
    }

    fmt.Println("主程序退出!!")
}

输出如下

监控器5,正在监控中...
监控器1,正在监控中...
监控器2,正在监控中...
监控器3,正在监控中...
监控器4,正在监控中...
监控器3,监控结束。
监控器4,监控结束。
监控器2,监控结束。
监控器1,监控结束。
监控器5,监控结束。
监控器取消的原因:  context deadline exceeded
主程序退出!!

例子 2:WithTimeout

WithTimeout 和 WithDeadline 使用方法及功能基本一致,都是表示超过一定的时间会自动 cancel context。

唯一不同的地方,我们可以从函数的定义看出

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

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

WithDeadline 传入的第二个参数是 time.Time 类型,它是一个绝对的时间,意思是在什么时间点超时取消。

而 WithTimeout 传入的第二个参数是 time.Duration 类型,它是一个相对的时间,意思是多长时间后超时取消。

package main

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

func monitor(ctx context.Context, number int)  {
    for {
        select {
        case <- ctx.Done():
            fmt.Printf("监控器%v,监控结束。\n", number)
            return
        default:
            fmt.Printf("监控器%v,正在监控中...\n", number)
            time.Sleep(2 * time.Second)
        }
    }
}

func main() {
    ctx01, cancel := context.WithCancel(context.Background())

      // 相比例子1,仅有这一行改动
    ctx02, cancel := context.WithTimeout(ctx01, 1* time.Second)

    defer cancel()

    for i :=1 ; i <= 5; i++ {
        go monitor(ctx02, i)
    }

    time.Sleep(5  * time.Second)
    if ctx02.Err() != nil {
        fmt.Println("监控器取消的原因: ", ctx02.Err())
    }

    fmt.Println("主程序退出!!")
}

输出的结果和上面一样

监控器1,正在监控中...
监控器5,正在监控中...
监控器3,正在监控中...
监控器2,正在监控中...
监控器4,正在监控中...
监控器4,监控结束。
监控器2,监控结束。
监控器5,监控结束。
监控器1,监控结束。
监控器3,监控结束。
监控器取消的原因:  context deadline exceeded
主程序退出!!

例子 3:WithValue

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

元数据以 Key-Value 的方式传入,Key 必须有可比性,Value 必须是线程安全的。

还是用上面的例子,以 ctx02 为父 context,再创建一个能携带 value 的ctx03,由于他的父context 是 ctx02,所以 ctx03 也具备超时自动取消的功能。

package main

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

func monitor(ctx context.Context, number int)  {
    for {
        select {
        case <- ctx.Done():
            fmt.Printf("监控器%v,监控结束。\n", number)
            return
        default:
              // 获取 item 的值
            value := ctx.Value("item")
            fmt.Printf("监控器%v,正在监控 %v \n", number, value)
            time.Sleep(2 * time.Second)
        }
    }
}

func main() {
    ctx01, cancel := context.WithCancel(context.Background())
    ctx02, cancel := context.WithTimeout(ctx01, 1* time.Second)
    ctx03 := context.WithValue(ctx02, "item", "CPU")

    defer cancel()

    for i :=1 ; i <= 5; i++ {
        go monitor(ctx03, i)
    }

    time.Sleep(5  * time.Second)
    if ctx02.Err() != nil {
        fmt.Println("监控器取消的原因: ", ctx02.Err())
    }

    fmt.Println("主程序退出!!")
}

输出如下

监控器4,正在监控 CPU 
监控器5,正在监控 CPU 
监控器1,正在监控 CPU 
监控器3,正在监控 CPU 
监控器2,正在监控 CPU 
监控器2,监控结束。
监控器5,监控结束。
监控器3,监控结束。
监控器1,监控结束。
监控器4,监控结束。
监控器取消的原因:  context deadline exceeded
主程序退出!!

6. Context 使用注意事项

  1. 通常 Context 都是做为函数的第一个参数进行传递(规范性做法),并且变量名建议统一叫 ctx
  2. Context 是线程安全的,可以放心地在多个 goroutine 中使用。
  3. 当你把 Context 传递给多个 goroutine 使用时,只要执行一次 cancel 操作,所有的 goroutine 就可以收到 取消的信号
  4. 不要把原本可以由函数参数来传递的变量,交给 Context 的 Value 来传递。
  5. 当一个函数需要接收一个 Context 时,但是此时你还不知道要传递什么 Context 时,可以先用 context.TODO 来代替,而不要选择传递一个 nil。
  6. 当一个 Context 被 cancel 时,继承自该 Context 的所有 子 Context 都会被 cancel。

推荐教程:《Go教程

Das obige ist der detaillierte Inhalt vonDetaillierte Erläuterung des Kontexts in der Go-Sprache. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!

Stellungnahme:
Dieser Artikel ist reproduziert unter:juejin.im. Bei Verstößen wenden Sie sich bitte an admin@php.cn löschen