如何優雅得關閉協程呢

来源:https://www.cnblogs.com/chenjiazhan/archive/2023/05/14/17398947.html
-Advertisement-
Play Games

pandas進行數據整理的意義在於，它是數據分析、數據科學和機器學習的前置步驟。 通過數據整理可以提前瞭解數據的概要，缺失值、重覆值等情況，為後續的分析和建模提供更為可靠的數據基礎。 本篇主要介紹利用pandas進行數據整理的各種方法。 1. 數據概要 獲取數據概要信息可以幫助我們瞭解數據的基本情況 ...


1.簡介

本文將介紹首先為什麼需要主動關閉goroutine，並介紹如何在Go語言中關閉goroutine的常見套路,包括傳遞終止信號和協程內部捕捉終止信號。之後，文章列舉了需要主動關閉協程運行的常見場景，如啟動一個協程執行一個不斷重覆的任務。希望通過本文的介紹，讀者能夠掌握如何在適當的時候關閉goroutine，以及瞭解關閉goroutine的常見套路。

2.為什麼需要關閉goroutine

2.1 協程的生命周期

瞭解協程的生命周期是優雅地關閉協程的前提，因為在關閉協程之前需要知道協程的當前狀態，以便採取相應的措施。所以這裡我們需要先瞭解下goroutine的生命周期。

在 Go語言中，協程（goroutine）是一種輕量級的線程，可以在一個程式中同時運行多個協程，提高程式的併發性能。協程的生命周期包括創建、運行和結束三個階段。

首先需要創建一個協程，協程的創建可以通過關鍵字 go 來實現，例如：

go func() {
    // 協程執行的代碼
}()

上面的代碼會啟動一個新的協程，同時在新的協程中執行匿名函數，此時協程便已被創建了。

一旦協程被創建，它就會在新的線程中運行。協程的運行狀態可以由 Go 運行時（goroutine scheduler）來管理，它會自動將協程調度到適當的P中運行，並確保協程的公平調度和平衡負載。

在運行階段，協程會不斷地執行任務，直到任務完成或者遇到終止條件。在終止階段，協程將會被回收，從而完成其整個生命周期。

綜上所述，協程由go關鍵字啟動，在協程中執行其業務邏輯，直到最後遇到終止條件，此時代表著協程的任務已經結束了，將進入終止階段。最終協程將會被回收。

2.2 協程的終止條件

正常來說，都是協程任務執行完成之後，此時協程自動退出，例如:

func main() {
   var wg sync.WaitGroup
   wg.Add(1)
   go func() {
      defer wg.Done()
      // 協程執行的代碼
      fmt.Println("協程執行完畢")
   }()
   wg.Wait()
   // 等待協程執行完畢
   fmt.Println("主程式結束")

上面的代碼中，我們使用 WaitGroup 等待協程執行完畢。在協程執行完畢後，程式會輸出協程執行完畢和主程式結束兩條信息。

還有一種情況是協程發生panic，它將會自動退出。例如：

func main() {
    var wg sync.WaitGroup
    wg.Add(1)
    go func() {
        defer wg.Done()
        // 協程執行的代碼
        panic("協程發生錯誤")
    }()
    // 等待協程執行完畢
    wg.Wait()
    fmt.Println("主程式結束")
}

在這種情況下，協程也會自動退出，不會再占用系統資源。

綜合看來，協程的終止條件，其實就是協程中的任務執行完成了，或者是執行過程中發生了panic，協程將滿足終止條件，退出執行。

2.3 為什麼需要主動關閉goroutine

從上面協程的終止條件來看，正常情況下，協程只要將任務正常處理完成，協程自動退出，此時並不需要主動關閉goroutine。

這裡先舉一個生產者消費者的例子，在這個例子中，我們創建了一個生產者和一個消費者，它們之間通過一個channel進行通信。生產者生產數據併發送到一個channel中，消費者從這個channel中讀取數據併進行處理。代碼示例如下:

func main() {
    // 生產者代碼
    go func(out chan<- int) {
        for i := 0; ; i++ {
            select {
            case out <- i:
                fmt.Printf("producer: produced %d\n", i)
            time.Sleep(time.Second)
        }
    }
    // 消費者邏輯
    go func(in <-chan int) {
        for {
            select {
            case i := <-in:
                fmt.Printf("consumer: consumed %d\n", i)
            }
        }
    }
    // 讓生產者協程和消費者協程一直執行下去
    time.Sleep(100000000)
}

在這個例子中，我們使用了兩個goroutine：生產者和消費者。生產者向channel中生產數據，消費者從channel中消費數據。

但是，假如生產者出現了問題，此時生產者的協程將會被退出，不再執行。而消費者仍然在等待數據的輸入。此時消費者協程已經沒有存在的必要了，其實是需要退出執行。

因此，對於一些雖然沒有達到終止條件的協程，但是其又沒有再繼續執行下去的必要，此時主動關閉其執行，從而保證程式的健壯性和性能。

3.如何優雅得關閉goroutine

優雅得關閉goroutine的執行，我們可以遵循以下三個步驟。首先是傳遞關閉協程的信號，其次是協程內部需要能夠到關閉信號，最後是協程退出時，能夠正確釋放其所占據的資源。通過以上步驟，可以保在需要時優雅地停止goroutine的執行。下麵對這三個步驟詳細進行講解。

3.1 傳遞關閉終止信號

首先是通過給goroutine傳遞關閉協程的信號，從而讓協程進行退出操作。這裡可以使用context.Context來傳遞信號，具體實現可以通過調用WithCancel,WithDeadline,WithTimeout等方法來創建一個帶有取消功能的Context，併在需要關閉協程時調用Cancel方法來向Context發送取消信號。示例代碼如下：

ctx, cancel := context.WithCancel(context.Background())
go func(ctx context.Context) {
    for {
        select {
        // 調用cancel函數後,這裡將能夠收到通知
        case <-ctx.Done():
            return
        default:
            // do something
        }
    }
}(ctx)
// 在需要關閉協程時調用cancel方法發送取消信號
cancel()

這裡，當我們想要終止協程的執行時，只需要調用可取消context對象的Cancel方法，協程內部將能夠通過context對象接收到終止協程執行的通知。

3.2 協程內部捕捉終止信號

協程內部也需要在取消信號傳遞過來時，能夠正確被捕捉到，才能夠正常終止流程。這裡我們可以使用select語句來監聽取消信號。select語句可以有多個case子句，可以同時監聽多個channel，當select語句執行時，它會一直阻塞，直到有一個case子句可以執行。select語句也可以包含default子句，這個子句在所有的case子句都不能執行時會被執行，通常用於防止select語句的阻塞。如下:

select {
case <-channel:
    // channel有數據到來時執行的代碼
default:
    // 所有channel都沒有數據時執行的代碼
}

而context對象的Done方法剛好也是返回一個channel,取消信號便是通過該channel來進行傳遞的。所以我們可以在協程內部，通過select語句，在其中一個case分支來監聽取消信號；同時使用一個default分支在協程中執行具體的業務邏輯。在終止信號沒有到來時，就執行業務邏輯；在收到協程終止信號後，也能夠及時終止協程的執行。如下:

go func(ctx context.Context) {
    for {
        select {
        // 調用cancel函數後,這裡將能夠收到通知
        case <-ctx.Done():
            return
        default:
            // 執行業務邏輯
        }
    }
}(ctx)

3.3 回收協程資源

最後，當協程被終止執行時，需要釋放占用的資源，包括文件句柄、記憶體等，以便其他程式可以繼續使用這些資源。在Go語言中，可以使用defer語句來確保協程在退出時能夠正確地釋放資源。比如協程中打開了一個文件，此時可以通過defer語句來關閉，避免資源的泄漏。代碼示例如下:

func doWork() {
    file, err := os.Open("test.txt")
    if err != nil {
        log.Fatal(err)
    }
    defer file.Close()

    // Do some work
}

在這個例子中，我們在文件打開之後使用defer語句註冊了一個函數，當協程結束時會自動調用該函數來關閉文件。這樣協程無論在何時退出，我們都可以確保文件被正確關閉，避免資源泄漏和其他問題。

3.4 關閉goroutine示例

下麵展示一個簡單的例子，結合Context對象，select語句以及defer語句這三部分內容，優雅得終止一個協程的運行，具體代碼示例如下:

package main

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

func worker(ctx context.Context) {
    // 最後,在協程退出前,釋放資源.
    defer fmt.Println("worker stopped")

    for {
        // 通過select語句監聽取消信號,取消信號沒到達,則執行業務邏輯,等下次迴圈檢查
        select {
        default:
            fmt.Println("working")
        case <-ctx.Done():
            return
        }
        time.Sleep(time.Second)
    }
}

func main() {
    ctx, cancel := context.WithCancel(context.Background())
    // 啟動一個協程執行任務
    go worker(ctx)
    // 執行5s後,調用cancel函數終止協程
    time.Sleep(5 * time.Second)
    cancel()

    time.Sleep(2 * time.Second)
}

在main函數中，我們使用context.WithCancel函數創建了一個新的context，並將其傳遞給worker函數，同時啟動協程運行worker函數。

當worker函數執行5s後，主協程調用cancel函數來終止worker協程。之後，worker協程中監聽取消信號的select語句，將能夠捕捉到這個信號，執行終止協程操作。

最後，在退出協程時，通過defer語句實現資源的釋放。綜上，我們實現了協程的優雅關閉，同時也正確回收了資源。

4. 需要主動關閉協程運行的常見場景

4.1 協程在執行一個不斷重覆的任務

協程在執行一個不斷重覆的任務時，此時協程是不會主動終止運行的。但是在某個時刻之後，不需要再繼續執行該任務了，需要主動關閉goroutine的執行，釋放協程的資源。

這裡以etcd為例來進行說明。etcd主要用於在分散式系統中存儲配置信息、元數據和一些小規模的共用數據。也就是說，我們可以在etcd當中存儲一些鍵值對。那麼，如果我們想要設置鍵值對的有效期，那該如何實現呢?

etcd中存在一個租約的概念，租約可以看作是一個時間段，該時間段內某個鍵值對的存在是有意義的，而在租約到期後，該鍵值對的存在便沒有意義，可以被刪除，同時一個租約可以作用於多個鍵值對。下麵先展示如何將一個租約和一個key進行關聯的示例：

// client 為 etcd客戶端的連接,基於此建立一個Lease實例
// Lease示例提供一些api,能過創建租約，取消租約,續約租約
lease := clientv3.NewLease(client)

// 創建一個租約,同時租約時間為10秒
grantResp, err := lease.Grant(context.Background(), 10)
if err != nil {
    log.Fatal(err)
}
// 租約ID,每一個租約都有一個唯一的ID
leaseID := grantResp.ID

// 將租約與key進行關聯,此時該key的有效期,也就是該租約的有效期
_, err = kv.Put(context.Background(), "key1", "value1", clientv3.WithLease(leaseID))
if err != nil {
    log.Fatal(err)
}

以上代碼演示瞭如何在etcd中創建一個租約並將其與一個鍵值對進行關聯。首先，通過etcd客戶端的連接創建了一個Lease實例，該實例提供了一些api，可以創建租約、取消租約和續約租約。然後使用Grant函數創建了一個租約並指定了租約的有效期為10秒。接下來，獲取租約ID，每個租約都有一個唯一的ID。最後，使用Put函數將租約與key進行關聯，從而將該key的有效期設定為該租約的有效期。

所以，我們如果想要操作etcd中鍵值對的有效期，只需要操作租約的有效期即可。

而剛好，etcd其實定義了一個Lease介面，該介面定義了對租約的一些操作，能過創建租約，取消租約，同時也支持續約租約，獲取過期時間等內容，具體如下:

type Lease interface {
   // 1. 創建一個新的租約
   Grant(ctx context.Context, ttl int64) (*LeaseGrantResponse, error)
   // 2. 取消租約
   Revoke(ctx context.Context, id LeaseID) (*LeaseRevokeResponse, error)
   // 3. 獲取租約的剩餘有效期
   TimeToLive(ctx context.Context, id LeaseID, opts ...LeaseOption) (*LeaseTimeToLiveResponse, error)
   // 4. 獲取所有的租約
   Leases(ctx context.Context) (*LeaseLeasesResponse, error)
   // 5. 不斷對租約進行續約，這裡假設10s後過期，此時大概的含義為每隔10s續約一次租約,調用該方法後,租約將永遠不會過期  
   KeepAlive(ctx context.Context, id LeaseID) (<-chan *LeaseKeepAliveResponse, error)
   // 6. 續約一次租約
   KeepAliveOnce(ctx context.Context, id LeaseID) (*LeaseKeepAliveResponse, error)
   // 7. 關閉Lease實例 
   Close() error
}

到此為止，我們引出了Lease介面，而其中KeepAlive方法便是我們今日的主角，從該方法定義可以看出，當調用KeepAlive方法對某個租約進行續約後，其每隔一段時間都會執行對目標租約的續約操作。這個時候一般都是啟動一個協程，由協程來完成對租約的續約操作。

此時協程其實就是在執行一個不斷重覆的任務，那如果Lease介面的實例調用了Close方法，想要回收掉Lease實例，不會再通過該實例對租約進行操作，回收掉Lease所有占據的資源，那麼KeepAlive方法創建的協程，此時也應該被主動關閉，不應該再繼續執行下去。

事實上，當前etcd中Lease介面中KeepAlive方法的預設實現也是如此。並且對主動關閉協程運行的實現，也是通過context傳遞對象，select獲取取消信號，最後通過defer 來回收資源這三者組合起來實現的。

下麵來看看執行續約操作的函數，會啟動一個協程在後臺不斷執行，具體實現如下:

func (l *lessor) sendKeepAliveLoop(stream pb.Lease_LeaseKeepAliveClient) {
   for {
      var tosend []LeaseID
      
      now := time.Now()
      l.mu.Lock()
      // keepAlives 是保存了所有待續約的 租約ID
      for id, ka := range l.keepAlives {
         // 然後nextKeepAlive為下次續約的時間,如果超過該時間,則執行續約操作
         if ka.nextKeepAlive.Before(now) {
            tosend = append(tosend, id)
         }
      }
      l.mu.Unlock()
      // 發送續約請求
      for _, id := range tosend {
         r := &pb.LeaseKeepAliveRequest{ID: int64(id)}
         // 向etcd集群發送續約請求
         if err := stream.Send(r); err != nil {
            return
         }
      }

      select {
      // 每隔500ms執行一次
      case <-time.After(500 * time.Millisecond):
      // 如果接收到終止信號,則直接終止
      case <-l.stopCtx.Done():
         return
      }
   }
}

可以看到，其會不斷迴圈，首先會檢查當前時間是否超過了所有租約的下次續約時間，如果超過了，則會將這些租約的 ID 放入 tosend 數組中，併在迴圈的下一步中向 etcd集群發送續約請求。接著會等待 500 毫秒，然後再次執行上述操作。正常情況下，其不會退出迴圈，會一直向etcd集群發送續約請求。除非收到了終止信號，其才會退出，從而正常結束協程。

而stopCtx則是lessor實例的變數，用於傳遞取消信號。在創建 lessor 實例時，stopCtx 是由 context.WithCancel() 函數創建的。這個函數會返回兩個對象：一個帶有取消方法的 context.Context 對象（即 stopCtx），以及一個函數對象 stopCancel，調用這個函數會取消上下文對象。具體如下:

// 創建Lease實例
func NewLeaseFromLeaseClient(remote pb.LeaseClient, c *Client, keepAliveTimeout time.Duration) Lease {
   // ...省略一些無關內容
   reqLeaderCtx := WithRequireLeader(context.Background())
   // 通過withCancel函數創建cancelCtx對象
   l.stopCtx, l.stopCancel = context.WithCancel(reqLeaderCtx)
   return l
}

在 lessor.Close() 函數中，我們調用 stopCancel() 函數來發送取消信號。

func (l *lessor) Close() error {
   l.stopCancel()
   // close for synchronous teardown if stream goroutines never launched
   // 省略無關內容
   return nil
}

因為 sendKeepAliveLoop() 協程會在 stopCtx 上等待信號，所以一旦調用了 stopCancel()，協程會收到信號並退出。這個機制非常靈活，因為stopCtx是實例的成員變數，所以lessor實例創建的所有協程，都可以通過監聽stopCtx來決定是否要退出執行。

5.總結

這篇文章主要介紹了為什麼需要主動關閉goroutine，以及在Go語言中關閉goroutine的常見套路。

文章首先介紹了為什麼需要主動關閉goroutine。接下來，文章詳細介紹了Go語言中關閉goroutine的常見套路，包括傳遞終止信號和協程內部捕捉終止信號。在傳遞終止信號的方案中，文章介紹瞭如何使用context對象傳遞信號，並使用select語句等待信號。在協程內部捕捉終止信號的方案中，文章介紹瞭如何使用defer語句來回收資源。

最後，文章列舉了需要主動關閉協程運行的常見場景，如協程在執行一個不斷重覆的任務，在不再需要繼續執行下去的話，就需要主動關閉協程的執行。希望通過本文的介紹，讀者能夠掌握如何在適當的時候關閉goroutine，從而避免資源浪費的問題。


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 一文揭秘DDD到底解決了什麼問題
    DDD作為架構設計思想幫助微服務控制規模複雜度，那它是怎麼做到的呢？ 一、架構設計是為瞭解決系統複雜度 談到架構，相信每個技術人員都是耳熟能詳，但如果深入探討一下，“為何要做架構設計？”或者“架構設計目的是什麼？”類似的問題，大部分人可能從來沒有思考過，或者即使有思考，也沒有太明確可信的答案。 1. ...
  • 軟考軟體設計師下午題技巧總結
    本文主要講解了京東百億級商品車型適配數據存儲結構設計以及怎樣實現適配介面的高性能查詢。通過京東百億級數據緩存架構設計實踐案例，簡單剖析了jimdb的點陣圖(bitmap)函數和lua腳本應用在高性能場景。希望通過本文，讀者可以對緩存的內部結構知識有一定瞭解，並且能夠以最小的記憶體使用代價將點陣圖(bitm... ...
  • 【C++】requires關鍵字簡介
    requires 是 C++20 中引入的一個新關鍵字，用於在函數模板或類模板中聲明所需的一組語義要求，它可以用來限制模板參數，類似於 typename 和 class 關鍵字。 requires關鍵字常與type_traits頭文件下類型檢查函數匹配使用，當requires後的表達式值為true時 ...
  • Spring Boot 配置文件總結
    1. 配置文件的兩種寫法：properties 和 yml 2. 項目中存在多個配置文件，可以使用 spring.profiles.active 屬性來切換使用哪個配置文件。 3. 自定義的一些配置屬性（配置項），如何讀取呢？可以在程式中通過 @Value 或者 @ConfigurationPr... ...
  • ＜Python全景系列-1＞ Hello World，1分鐘配置好你的python環境
    歡迎來到我們的系列博客《Python360全景》！在這個系列中，我們將帶領你從Python的基礎知識開始，一步步深入到高級話題，幫助你掌握這門強大而靈活的編程語法。無論你是編程新手，還是有一定基礎的開發者，這個系列都將提供你需要的知識和技能。這是我們的第一篇文章，讓我們從最基礎的開始：如何在你的電腦... ...
  • 一天吃透SpringCloud面試八股文
    1、什麼是Spring Cloud ？ Spring cloud 流應用程式啟動器是基於 Spring Boot 的 Spring 集成應用程式，提供與外部系統的集成。Spring cloud Task，一個生命周期短暫的微服務框架，用於快速構建執行有限數據處理的應用程式。 Spring Cloud ...
  • defer有什麼用呢
    線程阻塞概述 在生活中，最常見的阻塞現象是公路上汽車的堵塞。汽車在公路上快速行駛，如果前方交通受阻，就只好停下來等待，等到公路順暢，才能恢復行駛。 線程在運行中也會因為某些原因而阻塞。所有處於阻塞狀態的線程的共同特征：放棄 CPU，暫停運行，只有等到導致阻塞的原因消除，才能恢復運行，或者被其他線程中 ...
  • Java的線程
    介紹線程 線程是系統調度的最小單元，一個進程可以包含多個線程，線程是負責執行二進位指令的。 每個線程有自己的程式計數器、棧（Stack）、寄存器（Register）、本地存儲（Thread Local）等，但是會和進程內其他線程共用文件描述符、虛擬地址空間等。 對於任何一個進程來講，即便我們沒有主動 ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 QuestPDF 是一個開源 .NET 庫，用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫，它徹底改變了我們生成 PDF 文檔的方 ...
  • 彈幕樹洞項目功能新增篇
    項目地址 項目後端地址： https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址： ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址： http://tree ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類