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
  • 移動開發（一）：使用.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.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類