我們首先來看一個報錯

should not use built-in type string as key for value; define your own type to avoid collisions (SA1029)go-staticcheck

代碼長這樣

上面這段程序的波浪線報錯不是warnning級別的，可以說是編輯器的提示，雖說不影響程序的打包運行，但作為強迫癥玩家，屬實難以接受

這里是golang針對context.Context 類型的使用定義的規(guī)范，下面是一些官方話術(shù)的解釋

• 使用context.Context時，不應(yīng)該使用內(nèi)置類型作為 KV 中 key 的類型，而應(yīng)該使用自定義的類型來避免沖突。
• 當使用 context.Context 類型保存 KV 對時, key 不能使用原生類型，而應(yīng)該使用派生類型

我們看一些案例

我們在項目中，通常利用 context.Context 作為一個生命周期的上下文傳遞，貫穿全局，經(jīng)常來存一些自定義的鍵值對，保存新的 context 對象

ctx = context.WithValue(ctx, someKey, someValue)

WithValue方法標準庫的定義為
key 和 val 都是any類型

func WithValue(parent Context, key, val any) Context {
	……

}

該方法的注釋有這么一句context keys often have concrete type struct{}就是建議 key 的類型通常為具體的結(jié)構(gòu)體類型

我們的實際使用中，大多會這么樣寫

ctx = context.WithValue(ctx, "openid", userOpenID)

潛在問題

現(xiàn)在的項目往往涉及多個包的緊密耦合和團隊成員間的協(xié)作。在一個 ctx 對象的生命周期中，它需要穿越多個邏輯層或包，每個模塊都有可能利用 ctx 來存儲相關(guān)信息。

以用戶模塊為例，它可能會使用 ctx 來緩存用戶的 openid 字段。這種做法本身是合理的。隨后，這個 ctx（以及相應(yīng)的代碼邏輯）繼續(xù)流轉(zhuǎn)，大家默認使用這個 “openid” 鍵來存儲數(shù)據(jù)。

然而，當一個緊急需求出現(xiàn)，比如需要快速開發(fā)一個群聊功能，并且盡可能地復用現(xiàn)有代碼以減少開發(fā)工作量時，問題就出現(xiàn)了?？赡苋毫哪K在利用用戶模塊的代碼時，無意中也使用了 “openid” 這個鍵，這次是用來存儲群主的 openid。結(jié)果，當代碼運行時，支援的開發(fā)人員發(fā)現(xiàn)了一個奇怪的現(xiàn)象：群主的 openid 似乎在不斷地變化，仿佛群主的身份在不斷輪換。

處理辦法

我們以一種常見的思維方式來處理，大家通常會說對ctx里的 key 里的內(nèi)容統(tǒng)一規(guī)范管理，大家操作ctx時都遵循一套規(guī)則， 這的確是一個很不錯的辦法

但是我現(xiàn)在對統(tǒng)一規(guī)范管理，這6個字特別厭惡，動不動就統(tǒng)一管理的，隨著歲月的流失誰還會想著去看文檔，干點兒啥都去先看文檔約束，麻煩

這種局部的工作細節(jié)，分而治之，盡可能避免集中式的管理顯然更加適用，又不是什么大的模塊

我們先來一個小小的對比優(yōu)化代碼

type chatGroup string

func main() {
    ctx := context.Background()
    ctx = context.WithValue(ctx, "openid", "不是群主")
    ctx = context.WithValue(ctx, chatGroup("openid"), "群主")

    fmt.Println(ctx.Value("openid"))
    fmt.Println(ctx.Value(chatGroup("openid")))
}

輸出

不是群主
群主

通過chatGroup，一眼就能看出來是群聊模塊的東西

我們再來簡寫、優(yōu)化一點

type chatGroup struct{}

func main() {
    ctx := context.Background()
    ctx = context.WithValue(ctx, "openid", "不是群主")
    ctx = context.WithValue(ctx, chatGroup{}, "群主")

    fmt.Println(ctx.Value("openid"))
    fmt.Println(ctx.Value(chatGroup{}))
}

struct{} 類型(準確來說空結(jié)構(gòu)體是已初始化的值)也可以作為 KV 的 key 類型，當然了，也應(yīng)該定義為自定義類型。

使用 struct{} 的好處是，這個類型在 Go 中原則上是不占內(nèi)存空間和 gc 開銷的，可以提升性能

進階例子

封裝一個ctx 引入trace ID的案例

// traceid包 用于在 context 中維護 trace ID
package traceid

import "context"

type traceIDKey struct{}

// WithTraceID 往 context 中存入 trace ID
func WithTraceID(ctx context.Context, traceID string) context.Context {
    return context.WithValue(ctx, traceIDKey{}, traceID)
}

// TraceID 從 context 中提取 trace ID
func TraceID(ctx context.Context) string {
    v := context.Value(ctx, traceIDKey{})
    id, _ := v.(string)
    return id
}

到此這篇關(guān)于golang中context.WithValue的使用規(guī)范問題小結(jié)的文章就介紹到這了,更多相關(guān)golang context.WithValue內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

最新評論