我們首先來(lái)看一個(gè)報(bào)錯(cuò)
- should not use built-in type string as key for value; define your own type to avoid collisions (SA1029)go-staticcheck
代碼長(zhǎng)這樣
上面這段程序的波浪線(xiàn)報(bào)錯(cuò)不是warnning級(jí)別的，可以說(shuō)是編輯器的提示圈盔，雖說(shuō)不影響程序的打包運(yùn)行戴尸，但作為強(qiáng)迫癥玩家，屬實(shí)難以接受
這里是golang針對(duì)context.Context 類(lèi)型的使用定義的規(guī)范付魔，下面是一些官方話(huà)術(shù)的解釋
- 使用context.Context時(shí)，不應(yīng)該使用內(nèi)置類(lèi)型作為 KV 中 key 的類(lèi)型飞蹂，而應(yīng)該使用自定義的類(lèi)型來(lái)避免沖突几苍。
- 當(dāng)使用 context.Context 類(lèi)型保存 KV 對(duì)時(shí), key 不能使用原生類(lèi)型，而應(yīng)該使用派生類(lèi)型
我們看一些案例
我們?cè)陧?xiàng)目中陈哑，通常利用 context.Context 作為一個(gè)生命周期的上下文傳遞妻坝，貫穿全局，經(jīng)常來(lái)存一些自定義的鍵值對(duì)惊窖，保存新的 context 對(duì)象
ctx = context.WithValue(ctx, someKey, someValue)
WithValue方法標(biāo)準(zhǔn)庫(kù)的定義為
key 和 val 都是any類(lèi)型
func WithValue(parent Context, key, val any) Context {
……
}
該方法的注釋有這么一句context keys often have concrete type struct{}
就是建議 key 的類(lèi)型通常為具體的結(jié)構(gòu)體類(lèi)型
我們的實(shí)際使用中刽宪，大多會(huì)這么樣寫(xiě)
ctx = context.WithValue(ctx, "openid", userOpenID)
潛在問(wèn)題
現(xiàn)在的項(xiàng)目往往涉及多個(gè)包的緊密耦合和團(tuán)隊(duì)成員間的協(xié)作。在一個(gè) ctx 對(duì)象的生命周期中界酒，它需要穿越多個(gè)邏輯層或包圣拄，每個(gè)模塊都有可能利用 ctx 來(lái)存儲(chǔ)相關(guān)信息。
以用戶(hù)模塊為例毁欣，它可能會(huì)使用 ctx 來(lái)緩存用戶(hù)的 openid 字段售担。這種做法本身是合理的。隨后署辉，這個(gè) ctx（以及相應(yīng)的代碼邏輯）繼續(xù)流轉(zhuǎn)，大家默認(rèn)使用這個(gè) "openid" 鍵來(lái)存儲(chǔ)數(shù)據(jù)岩四。
然而哭尝，當(dāng)一個(gè)緊急需求出現(xiàn)，比如需要快速開(kāi)發(fā)一個(gè)群聊功能剖煌，并且盡可能地復(fù)用現(xiàn)有代碼以減少開(kāi)發(fā)工作量時(shí)材鹦，問(wèn)題就出現(xiàn)了逝淹。可能群聊模塊在利用用戶(hù)模塊的代碼時(shí)桶唐，無(wú)意中也使用了 "openid" 這個(gè)鍵栅葡，這次是用來(lái)存儲(chǔ)群主的 openid。結(jié)果尤泽，當(dāng)代碼運(yùn)行時(shí)欣簇，支援的開(kāi)發(fā)人員發(fā)現(xiàn)了一個(gè)奇怪的現(xiàn)象：群主的 openid 似乎在不斷地變化，仿佛群主的身份在不斷輪換坯约。
處理辦法
我們以一種常見(jiàn)的思維方式來(lái)處理熊咽，大家通常會(huì)說(shuō)對(duì)ctx里的 key 里的內(nèi)容統(tǒng)一規(guī)范管理，大家操作ctx時(shí)都遵循一套規(guī)則闹丐， 這的確是一個(gè)很不錯(cuò)的辦法
但是我現(xiàn)在對(duì)統(tǒng)一規(guī)范管理横殴，這6個(gè)字特別厭惡，動(dòng)不動(dòng)就統(tǒng)一管理的卿拴，隨著歲月的流失誰(shuí)還會(huì)想著去看文檔衫仑，干點(diǎn)兒啥都去先看文檔約束，麻煩
這種局部的工作細(xì)節(jié)堕花，分而治之文狱，盡可能避免集中式的管理顯然更加適用，又不是什么大的模塊
我們先來(lái)一個(gè)小小的對(duì)比優(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")))
}
輸出
不是群主
群主
通過(guò)chatGroup航徙，一眼就能看出來(lái)是群聊模塊的東西
我們?cè)賮?lái)簡(jiǎn)寫(xiě)如贷、優(yōu)化一點(diǎn)
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{} 類(lèi)型(準(zhǔn)確來(lái)說(shuō)空結(jié)構(gòu)體是已初始化的值)也可以作為 KV 的 key 類(lèi)型，當(dāng)然了到踏，也應(yīng)該定義為自定義類(lèi)型杠袱。
使用 struct{} 的好處是，這個(gè)類(lèi)型在 Go 中原則上是不占內(nèi)存空間和 gc 開(kāi)銷(xiāo)的窝稿，可以提升性能
進(jìn)階例子
封裝一個(gè)ctx 引入trace ID的案例
// traceid包 用于在 context 中維護(hù) 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
}
