golang Context應用舉例

来源:https://www.cnblogs.com/zhangchaoyang/archive/2023/09/27/17731952.html
-Advertisement-
Play Games

Context本質 golang標準庫里Context實際上是一個介面（即一種編程規範、 一種約定）。 type Context interface { Deadline() (deadline time.Time, ok bool) Done() <-chan struct{} Err() err ...


 

Context本質

golang標準庫里Context實際上是一個介面（即一種編程規範、 一種約定）。

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

 

通過查看源碼里的註釋，我們得到如下約定：

  1. Done()函數返回一個只讀管道，且管道里不存放任何元素(struct{})，所以用這個管道就是為了實現阻塞
  2. Deadline()用來記錄到期時間，以及是否到期。
  3. Err()用來記錄Done()管道關閉的原因，比如可能是因為超時，也可能是因為被強行Cancel了。
  4. Value()用來返回key對應的value，你可以想像成Context內部維護了一個map。

Context實現

go源碼里提供了Context介面的一個具體實現，遺憾的是它只是一個空的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 any) any {
    return nil
}

 

emptyCtx以小寫開頭，包外不可見，所以golang又提供了Background和TODO這2個函數讓我們能獲取到emptyCtx。

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

 

backgroud和todo明明是一模一樣的東西，就是emptyCtx，為什麼要搞2個呢？真心求教，知道的同學請在評論區告訴我。

emptyCtx有什麼用？創建Context時通常需要傳遞一個父Context，emptyCtx用來充當最初的那個Root Context。

With Value

當業務邏輯比較複雜，函數調用鏈很長時，參數傳遞會很複雜，如下圖：

f1產生的參數b要傳給f2，雖然f2並不需要參數b，但f3需要，所以b還是得往後傳。

如果把每一步產生的新變數都放到Context這個大容器里，函數之間只傳遞Context，需要什麼變數時直接從Context里取，如下圖：

 

f2能從context里取到a和b，f4能從context里取到a、b、c、d。

package main

import (
    "context"
    "fmt"
)

func step1(ctx context.Context) context.Context {
    //根據父context創建子context，創建context時允許設置一個<key,value>對，key和value可以是任意數據類型
    child := context.WithValue(ctx, "name", "大臉貓")
    return child
}

func step2(ctx context.Context) context.Context {
    fmt.Printf("name %s\n", ctx.Value("name"))
    //子context繼承了父context里的所有key value
    child := context.WithValue(ctx, "age", 18)
    return child
}

func step3(ctx context.Context) {
    fmt.Printf("name %s\n", ctx.Value("name")) //取出key對應的value
    fmt.Printf("age %d\n", ctx.Value("age"))
}

func main1() {
    grandpa := context.Background() //空context
    father := step1(grandpa)        //father里有一對<key,value>
    grandson := step2(father)       //grandson里有兩對<key,value>
    step3(grandson)
}

 

Timeout

在視頻 https://www.bilibili.com/video/BV1C14y127sv/ 里介紹了超時實現的核心原理，視頻中演示的done管道可以用Context的Done()來替代，Context的Done()管道什麼時候會被關係呢？2種情況：

1. 通過context.WithCancel創建一個context，調用cancel()時會關閉context.Done()管道。

func f1() {
    ctx, cancel := context.WithCancel(context.Background())
    go func() {
        time.Sleep(100 * time.Millisecond)
        cancel() //調用cancel，觸發Done
    }()
    select {
    case <-time.After(300 * time.Millisecond):
        fmt.Println("未超時")
    case <-ctx.Done(): //ctx.Done()是一個管道，調用了cancel()都會關閉這個管道，然後讀操作就會立即返回
        err := ctx.Err()        //如果發生Done（管道被關閉），Err返回Done的原因，可能是被Cancel了，也可能是超時了
        fmt.Println("超時:", err) //context canceled
    }
}

 

2. 通過context.WithTimeout創建一個context，當超過指定的時間或者調用cancel()時會關閉context.Done()管道。

func f2() {
    ctx, cancel := context.WithTimeout(context.Background(), time.Millisecond*100) //超時後會自動調用context的Deadline，Deadline會，觸發Done
    defer cancel()
    select {
    case <-time.After(300 * time.Millisecond):
        fmt.Println("未超時")
    case <-ctx.Done(): //ctx.Done()是一個管道，context超時或者調用了cancel()都會關閉這個管道，然後讀操作就會立即返回
        err := ctx.Err()        //如果發生Done（管道被關閉），Err返回Done的原因，可能是被Cancel了，也可能是超時了
        fmt.Println("超時:", err) //context deadline exceeded
    }
}

 

Timeout的繼承問題

通過context.WithTimeout創建的Context，其壽命不會超過父Context的壽命。比如：

  1. 父Context設置了10號到期，5號誕生了子Context，子Context設置了100天後到期，則實際上10號的時候子Context也會到期。
  2. 父Context設置了10號到期，5號誕生了子Context，子Context設置了1天後到期，則實際上6號的時候子Context就會到期。
func inherit_timeout() {
    parent, cancel1 := context.WithTimeout(context.Background(), time.Millisecond*1000) //parent設置100ms超時
    t0 := time.Now()
    defer cancel1()

    time.Sleep(500 * time.Millisecond) //消耗掉500ms

    // child, cancel2 := context.WithTimeout(parent, time.Millisecond*1000) //parent還剩500ms，child設置了1000ms之後到期，child.Done()管道的關閉時刻以較早的為準，即500ms後到期
    child, cancel2 := context.WithTimeout(parent, time.Millisecond*100) //parent還剩500ms，child設置了100ms之後到期，child.Done()管道的關閉時刻以較早的為準，即100ms後到期
    t1 := time.Now()
    defer cancel2()

    select {
    case <-child.Done():
        t2 := time.Now()
        fmt.Println(t2.Sub(t0).Milliseconds(), t2.Sub(t1).Milliseconds())
        fmt.Println(child.Err()) //context deadline exceeded
    }
}

 

context超時在http請求中的實際應用

定心丸來了，最後說一遍：”context在實踐中真的很有用“

客戶端發起http請求時設置了一個2秒的超時時間：

package main
import (
    "fmt"
    "io/ioutil"
    "net/http"
    "time"
)

func main() {
    client := http.Client{
        Timeout: 2 * time.Second, //小於10秒，導致請求超時，會觸發Server端的http.Request.Context的Done
    }
    if resp, err := client.Get("http://127.0.0.1:5678/"); err == nil {
        defer resp.Body.Close()
        fmt.Println(resp.StatusCode)
        if bs, err := ioutil.ReadAll(resp.Body); err == nil {
            fmt.Println(string(bs))
        }
    } else {
        fmt.Println(err) //Get "http://127.0.0.1:5678/": context deadline exceeded (Client.Timeout exceeded while awaiting headers)
    }
}

 

服務端從Request里取提context，故意休息10秒鐘，同時監聽context.Done()管道有沒有關閉。由於Request的context是2秒超時，所以服務端還沒休息夠context.Done()管道就關閉了。

package main
import (
    "fmt"
    "net/http"
    "time"
)

func welcome(w http.ResponseWriter, req *http.Request) {
    ctx := req.Context() //取得request的context
    select {
    case <-time.After(10 * time.Second): //故意慢一點，10秒後才返回結果
        fmt.Fprintf(w, "welcome")
    case <-ctx.Done(): //超時後client會撤銷請求，觸發ctx.cancel()，從而關閉Done()管道
        err := ctx.Err()            //如果發生Done（管道被關閉），Err返回Done的原因，可能是被Cancel了，也可能是超時了
        fmt.Println("server:", err) //context canceled
    }
}

func main() {
    http.HandleFunc("/", welcome)
    http.ListenAndServe(":5678", nil)
}

 

 

本文來自博客園，作者：張朝陽，轉載請註明原文鏈接：https://www.cnblogs.com/zhangchaoyang/p/17731952.html


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

-Advertisement-
Play Games
更多相關文章
  • Spring-Boot-Starter 學習筆記（1）
    Spring-Boot-Starter 1. 準備配置類和 Bean 對象 Spring Boot 提供了兩個註解： @Configuration：Spring 提供的配置類註解，作用在類上，代表整個類是個 Spring 配置類，對照傳統的 Spring XML 配置文件。 @Bean：作用於方法上 ...
  • The importance of value passing and reference passing
    不管哪個語言都有值傳遞，引用傳遞兩種方式，在C語言裡面引用傳遞用指針搞定。在Java裡面沒有指針，所以Java就規定（之前的設計）了某些類型是值傳遞，某些類型是引用傳遞，當然完全沒必要去全部類型分析一遍，比如int是什麼XX傳遞，String是什麼XX傳遞...，浪費時間，因為現在查AI那麼方便快捷 ...
  • 我們公司用了 3 年多的多賬號統一登錄方案，萬能通用，穩的一批！
    作者：VanFan 來源：juejin.cn/post/6844904053411938311 現在幾乎大部分的 App 都支持使用多個第三方賬號進行登錄，如：微信、QQ、微博等，我們把此稱為多賬號統一登陸。而這些賬號的表設計，流程設計至關重要，不然後續擴展性賊差。 本文不提供任何代碼實操，但是梳理 ...
  • CLion中配置gtest
    環境：Windows,cmake,gcc,g++,CLion 一、下載源碼 二、解壓並構建(我是怎麼知道的?) 進入處於解壓目錄的cmd視窗 輸入以下命令cmake以下 使用以下命令構建 100%即構建成功 找到這些東西，複製到CLion項目中，文件結構在後面 我這裡是先創建一個gtest目錄,在g ...
  • 一款免費的響應式界面調試工具
    不知道大家平時開發響應式前端代碼是如何調試的？是不是也跟我一樣，通過瀏覽器的開發者工具來切換不同的界面尺寸來看驗證效果呢？ 可能是因為習慣了，平時就不停的切換不同尺寸來看效果。直到TJ君看到今天要推薦的這個免費工具，我才發現之前的調試方式好傻... 使用體驗 下麵，我們還一起來看看今天要推薦的這款名 ...
  • 3、SpringMVC之RequestMapping註解
    3.1、環境搭建 創建名為spring_mvc_demo的新module，過程參考2.1節 3.1.1、創建SpringMVC的配置文件 <?xml version="1.0" encoding="UTF-8"?> <beans xmlns="http://www.springframework.o ...
  • Python爬蟲-爬取百度搜索結果頁的網頁標題及其真實網址
    共兩個依賴的需提前安裝的第三方庫：requests和bs4庫 cmd命令行輸入安裝requests庫：pip3 install -i https://pypi.douban.com/simple requests 安裝bs4庫：pip3 install -i https://pypi.douban. ...
  • 【matplotlib 基礎】--目錄（完結）
    Matplotlib 庫是一個用於數據可視化和繪圖的 Python 庫。 它提供了大量的函數和類，可以幫助用戶輕鬆地創建各種類型的圖表，包括直方圖、箱形圖、散點圖、餅圖、條形圖和密度圖等。 本系列具體內容包括： 畫布 畫布是其他所有的元素的載體，可以說是最重要，也是最容易被忽視的元素。 繪製圖形之前 ...
一周排行
    -Advertisement-
    Play Games
  • WPF 已知問題 監聽 WMI 事件導致觸摸失效
    示例項目結構 在 Visual Studio 中創建一個 WinForms 應用程式後，項目結構如下所示： MyWinFormsApp/ │ ├───Properties/ │ └───Settings.settings │ ├───bin/ │ ├───Debug/ │ └───Release/ ...
  • [STAThread]特性
    [STAThread] 特性用於需要與 COM 組件交互的應用程式，尤其是依賴單線程模型（如 Windows Forms 應用程式）的組件。在 STA 模式下，線程擁有自己的消息迴圈，這對於處理用戶界面和某些 COM 組件是必要的。 [STAThread] static void Main(stri ...
  • UWP WinUI3 傳入 AddHandler 的 RoutedEventHandler 類型與事件所需不匹配將拋出參數異常
    在WinForm中使用全局異常捕獲處理 在WinForm應用程式中，全局異常捕獲是確保程式穩定性的關鍵。通過在Program類的Main方法中設置全局異常處理，可以有效地捕獲並處理未預見的異常，從而避免程式崩潰。 註冊全局異常事件 [STAThread] static void Main() { / ...
  • .NET 多版本 WinForm 開源控制項庫 SunnyUI
    前言 給大家推薦一款開源的 Winform 控制項庫，可以幫助我們開發更加美觀、漂亮的 WinForm 界面。 項目介紹 SunnyUI.NET 是一個基於 .NET Framework 4.0+、.NET 6、.NET 7 和 .NET 8 的 WinForm 開源控制項庫，同時也提供了工具類庫、擴展 ...
  • .net core8 使用Swagger（附當前源碼）
    說明 該文章是屬於OverallAuth2.0系列文章，每周更新一篇該系列文章（從0到1完成系統開發）。 該系統文章，我會儘量說的非常詳細，做到不管新手、老手都能看懂。 說明：OverallAuth2.0 是一個簡單、易懂、功能強大的許可權+可視化流程管理系統。 有興趣的朋友，請關註我吧(*^▽^*) ...
  • WPF 什麼時候 VisualTreeHelper.GetDescendantBounds 將返回無窮大
    一、下載安裝 1.下載git 必須先下載並安裝git，再TortoiseGit下載安裝 git安裝參考教程：https://blog.csdn.net/mukes/article/details/115693833 2.TortoiseGit下載與安裝 TortoiseGit，Git客戶端，32/6 ...
  • C# 開源教程帶你輕鬆掌握數據結構與演算法
    前言 在項目開發過程中，理解數據結構和演算法如同掌握蓋房子的秘訣。演算法不僅能幫助我們編寫高效、優質的代碼，還能解決項目中遇到的各種難題。 給大家推薦一個支持C#的開源免費、新手友好的數據結構與演算法入門教程：Hello演算法。 項目介紹 《Hello Algo》是一本開源免費、新手友好的數據結構與演算法入門 ...
  • 第22篇 生成proto文件bat腳本
    1.生成單個Proto.bat內容 @rem Copyright 2016, Google Inc. @rem All rights reserved. @rem @rem Redistribution and use in source and binary forms, with or with ...
  • 記一次 .NET某上位機視覺程式 卡死分析
    一：背景 1. 講故事 前段時間有位朋友找到我，說他的窗體程式在客戶這邊出現了卡死，讓我幫忙看下怎麼回事？dump也生成了，既然有dump了那就上 windbg 分析吧。 二：WinDbg 分析 1. 為什麼會卡死 窗體程式的卡死，入口門檻很低，後續往下分析就不一定了，不管怎麼說先用 !clrsta ...
  • 醫學DICOM文件與PACS系統進行數據傳輸
    前言 人工智慧時代，人臉識別技術已成為安全驗證、身份識別和用戶交互的關鍵工具。 給大家推薦一款.NET 開源提供了強大的人臉識別 API，工具不僅易於集成，還具備高效處理能力。 本文將介紹一款如何利用這些API，為我們的項目添加智能識別的亮點。 項目介紹 GitHub 上擁有 1.2k 星標的 C# ...
所有分類