?每門開發(fā)語言都會有其特有的風格規(guī)范（亦或指南），開發(fā)者遵循規(guī)范能帶來顯著收益，有效促進團隊協(xié)作、減少 bug 錯誤、降低維護成本等。

Google 開源的 Google Style Guides （?https://google.github.io/styleguide/?）為多種編程語言提供了風格規(guī)范，包括 C++、Java、Python、JavaScript 等。在 2022 年 11 月，Go 語言風格規(guī)范（?https://google.github.io/styleguide/go/index）也終于得到開源。

Google 發(fā)布的 Go 語言風格規(guī)范一共包括四部分內容。

• 概述篇：https://google.github.io/styleguide/go/index
• 指南篇：https://google.github.io/styleguide/go/guide
• 決策篇：https://google.github.io/styleguide/go/decisions
• 最佳實踐篇：https://google.github.io/styleguide/go/best-practices

如果你所在的團體還未形成一套系統(tǒng)的 Go 風格規(guī)范，不妨參考這份指南。

風格原則

這里列舉了一些總體原則，它們總結了思考如何編寫可讀性 Go 代碼。以下是根據(jù)重要性排序的可讀性代碼特性。

• 清晰性：對讀者來說，代碼的目的和基本原理是清楚的。
• 簡單性：代碼以盡可能簡單的方式實現(xiàn)其目標。
• 簡潔性：代碼具有高信噪比。
• 可維護性：編寫的代碼易于維護。
• 一致性：代碼與更廣泛的 Google 代碼庫風格一致。

1. 清晰性

可讀性的核心目標是編寫對讀者而言清晰的代碼。

清晰主要是通過有效的命名、有用的注釋和高效的代碼組織來實現(xiàn)的。

清晰性應該是從讀者的角度來看，而非代碼編寫者。代碼易于閱讀比易于編寫更重要。代碼清晰性有兩個不同的方面：

• 代碼實際上在做什么？
• 為什么代碼會做它所做的事情？

代碼實際上在做什么？

Go 的設計使得它應該相對直接地看到代碼在做什么。在存在不確定或者讀者需要先驗知識才能理解代碼的情況下，這值得花時間讓未來的讀者更清晰地了解代碼的用途。例如，以下措施可能會有助于提供更清晰的代碼：

• 使用更具描述性的變量名
• 添加附加注釋
• 用空格和注釋分解代碼
• 將代碼重構為單獨的函數(shù)/方法，使其更加模塊化

這里沒有放之四海而皆準的方法，但在開發(fā) Go 代碼時優(yōu)先考慮清晰性很重要。

為什么代碼會做它所做的事情？

代碼的基本原理通常通過變量、函數(shù)、方法或包的名稱充分傳達。如果沒有，添加注釋很重要。當代碼包含了讀者可能不熟悉的細微差別時，解釋”為什么“就顯得尤為重要。例如：

• 語言上的細微差別，例如，閉包要獲取一個循環(huán)變量，但是代碼寫在很多行之外。
• 業(yè)務邏輯的細微差別，例如，需要區(qū)分實際用戶和冒充用戶的訪問控制檢查。

某個 API 可能需要額外注意才能正確使用。例如，出于性能原因，一段代碼可能錯綜復雜且難以理解，或者一系列復雜的數(shù)學運算可能以意想不到的方式使用類型轉換。在這些場景以及更多類似的情況下，重要的是要有隨附的注釋和文檔來解釋它們，這樣以后的維護者才不會犯錯誤，這些讀者能夠不用進行逆向工程而理解代碼。

同樣重要的是要注意到，一些為了提供清晰性的嘗試（例如添加額外的注釋）可能會模糊代碼的實際目的，例如增加混亂、重復描述代碼、與代碼自相矛盾的注釋，或者為了保證注釋最新而增加維護負擔。讓代碼自己說話（例如，通過使用可自描述的符號名稱）而不是添加多余的注釋。注釋通常最好是解釋為什么做某事，而不是代碼在做什么。

Google 代碼庫在很大程度上是統(tǒng)一與一致的。通常情況下，與眾不同的代碼（例如，通過使用不熟悉的模式）那樣做是有充分理由的，通常是為了性能考慮。保持這一特性很重要，它可以讓讀者清楚地知道在閱讀一段新代碼時他們應該把注意力集中在什么地方。。

標準庫包含許多實踐該原則的示例。例如其中：

• sort 包中的維護者注釋。
• 同樣在 sort 包中有一些很好且可運行的例子，它們同時有利于使用者（例子在[godoc](sort package - sort - Go Packages)顯示）和維護者（作為部分測試用途的例子）。
• strings.Cut 雖然只有四行代碼，但它們提高了對調用者而言，使用時的清晰性和正確性。

2. 簡單性

對于那些使用、閱讀和維護它的人來說，你的 Go 代碼應該是簡單的。

Go 代碼應該以實現(xiàn)其目標的最簡單方式編寫，無論是在行為還是性能方面。在 Google Go 代碼庫中，簡單的代碼意味著：

• 易于從上到下閱讀
• 不假設你已經提前知道它在做什么
• 不假設你可以記住前面的所有代碼
• 沒有不必要的抽象層次
• 沒有引起人們對普通事物的注意的名字
• 使讀者清楚值和決策的傳播情況
• 有注釋解釋為什么而不是什么，以及代碼正在做什么以避免以后的偏差
• 有獨立的文檔
• 有有用的錯誤和有用的失敗測試用例
• 可能經常與“故作聰明”的代碼相互排斥

在代碼簡單性和 API 使用簡單性之間可能會出現(xiàn)權衡。例如，讓代碼更復雜可能是值得的，這樣 API 的終端用戶可以更容易且正確地調用 API。相比之下，為 API 的終端用戶留一些額外的工作也可能是值得的，這樣代碼仍然簡單易懂。

當代碼需要復雜性時，應該刻意地增加復雜性。如果需要額外的性能，或者一個特定的庫或服務有多個不同的用戶，這通常是必要的。復雜性應該是合理的，但它應該隨附文檔，以便用戶和未來的維護者能夠理解和駕馭復雜度。這應該輔以證明其正確用法的測試和示例，尤其是在同時存在“簡單”和“復雜”代碼使用方式的情況下。

我們力求避免代碼庫中不必要的復雜性，以便當復雜性確實出現(xiàn)時，它表明這些相關代碼需要仔細理解和維護。理想情況下，應該附有注釋，它解釋基本原理并確定應注意的事項。在優(yōu)化代碼以提高性能時經常會出現(xiàn)這種情況；這樣做通常需要更復雜的方法，比如預分配緩沖區(qū)并在 goroutine 的整個生命周期中重用它。當維護者看到它時，這應該是一個線索，表明相關代碼是性能的關鍵代碼，未來對該段代碼進行修改時應該持有謹慎態(tài)度。另一方面，如果使用不當，這種復雜性會給那些將來需要閱讀或更改代碼的人帶來負擔。

如果代碼的目的很簡單但最終實現(xiàn)卻很復雜，這通常是應該重新查看實現(xiàn)以確定是否有更簡單的方式來完成相同目的的信號。

最少機制

如果有多種方式可以表達相同的想法，請選擇使用最標準的一種。復雜的機制常在，但不應無故使用。根據(jù)需要而增加代碼的復雜性很容易，而在發(fā)現(xiàn)不必要的復雜性后，消除現(xiàn)有的復雜性要困難得多。

在足以滿足你的用例時，使用核心語言結構（例如 slice、map、循環(huán)或 struct）。

如果沒有，請在標準庫中尋找一種工具（如 HTTP 客戶端或模板引擎）。

最后，在引入新的依賴項或自己造輪子之前，請考慮 Google 代碼庫中是否有對應的核心庫。

例如，考慮包含綁定到具有默認值的變量的標志的生產環(huán)境代碼，該默認值必須在測試中被覆蓋。除非打算測試程序的命令行界面本身（例如，使用 os/exec?），否則直接覆蓋綁定值比使用 flag.Set? 更簡單，也更可取。類似地，如果一段代碼需要對集合成員進行檢查，那么一個布爾值類型的 map（map[string]bool）通常就足夠了。僅當需要更復雜的操作而 map 無法實現(xiàn)或使用起來過于復雜，才應使用提供類集合類型和功能的庫。

3. 簡潔性

簡潔的 Go 代碼具有很高的信噪比。應該很容易地辨別相關細節(jié)，它通過命名和代碼結構引導讀者去詳細了解。

在任何時候，都會有很多東西阻礙代碼呈現(xiàn)最主要的細節(jié)：

• 重復代碼
• 外來語法
• 晦澀難懂的名字
• 不必要的抽象
• 空格

重復的代碼模糊了每個幾乎相同部分之間的差異，它需要讀者通過視覺比較相似的代碼行已找到變化的地方。表格驅動測試室一個很好的機制示例，它可以從每次重復的重要細節(jié)中簡明地提取出通用代碼，但是選擇將哪些部分包含在表格中將影響表格的易懂程度。

在考慮多種方式組織代碼時，需要考慮哪種方式能讓重要的細節(jié)最明顯。

理解和使用常見的代碼結構和正宗用法對于保持高信噪比也很重要。例如下面的代碼塊在錯誤處理中很常見，讀者可以很快理解這塊的用途。

// Good:
if err := doSomething(); err != nil {
    // ...
}

如果代碼看起來與此非常相似但略有不同，讀者可能不會注意到變化。在這種情況下，值得通過添加注釋以引起注意，來有意“增強”錯誤檢查的信號。

// Good:
if err := doSomething(); err == nil { // if NO error
    // ...
}

4. 可維護性

代碼被編輯的次數(shù)比它編寫的次數(shù)多得多。具有可讀性的代碼不僅對試圖理解其工作原理的讀者有意義，而且對需要更改它的程序員也有意義。清晰性是關鍵。

• 可維護性的代碼：
• 易于被未來的程序員正確地修改
• 具有結構化的 API，以便它們可以優(yōu)雅地增長
• 清楚代碼所做的假設，它選擇對應到問題結構的抽象，而不是對應到代碼結構
• 避免不必要的耦合，不包含未使用的功能
• 有一個全面的測試套件，以確保承諾的行為得到維護，重要的邏輯是正確的，并且測試用例失敗時能提供清晰、可操作的診斷。

當使用像接口和類型這樣的抽象時，根據(jù)定義從它們使用的上下文中刪除信息，重要的是要確保它們提供了足夠的好處。編輯器和 IDE 可以直接連接到方法定義并在使用具體類型時顯示相應的文檔，但在其他情況下只能參考對應的接口定義。接口是一個強大的工具，但使用它也有代價，因為維護者可能需要了解底層實現(xiàn)的細節(jié)才能正確使用接口，這必須在接口文檔或調用處進行解釋。

可維護的代碼也避免了將重要的細節(jié)隱藏在容易被忽視的地方。例如，在以下的代碼例子中，一個字符的存在都會對理解代碼產生重大的影響。

// Bad:
// The use of = instead of := can change this line completely.
if user, err = db.UserByID(userID); err != nil {
    // ...
}

// Bad:
// The ! in the middle of this line is very easy to miss.
leap := (year%4 == 0) && (!(year%100 == 0) || (year%400 == 0))

這些都并非不正確，但都可以以更明確的方式編寫，或者可以附帶注釋以引起對重要行為的注意。

// Good:
u, err := db.UserByID(userID)
if err != nil {
    return fmt.Errorf("invalid origin user: %s", err)
}
user = u

// Good:
// Gregorian leap years aren't just year%4 == 0.
// See https://en.wikipedia.org/wiki/Leap_year#Algorithm.
var (
    leap4   = year%4 == 0
    leap100 = year%100 == 0
    leap400 = year%400 == 0
)
leap := leap4 && (!leap100 || leap400)

同樣的，一個隱藏了關鍵邏輯或者重要邊緣情況的輔助函數(shù)會很容易地使得之后的更改中可能沒有合適地考慮到它。

可預測的命名是可維護代碼的另一個特征。包的用戶或一段代碼的維護者應該能夠預測給定上下文中的變量、方法或函數(shù)的名稱。相同概念的函數(shù)參數(shù)和接收者通常應該共享相同的名稱，這既可以使文檔易于理解，也可以以最小的開銷促進代碼重構。

可維護代碼應最小化其依賴性（隱式和顯式）。依賴更少的包意味著可以影響行為的代碼行更少。避免對內部或者沒有文檔記錄的行為的依賴，在將來這些行為發(fā)生改變時，這些代碼就不太可能會成為維護負擔。

在考慮如何組織或編寫代碼時，值得花時間去思考代碼可能隨時間的推移而演進的方式。如果給定的方法更有利于未來更簡單、更安全的更改，那通常是一個很好的權衡，即使這意味著設計稍微復雜一些。

5. 一致性

一致的代碼是在更廣泛的代碼庫中、在團隊或包的上下文中，甚至在同一個文件中，看起來、感覺和行為都類似的代碼。

一致性問題不會凌駕于上述任何原則，但如果必須打破平衡，那么打破平衡以保持一致性通常是有益的。

包內的一致性通常是最直接重要的一致性級別。如果同一個問題在包中以多種方式處理，或者如果相同概念在一個文件中有多個名稱，則可能會非常不協(xié)調。但是，即使這樣也不應該凌駕于文檔化的風格原則或全局一致性之上。

核心指南

這些指南收集了所有 Go 代碼都應遵循的 Go 風格最重要的方面。我們希望在編寫可讀性代碼的時候學習并遵循這些準則。這些準則預計不會被經常更改，并且新添加的內容必須被高標準審核。

下面的指南擴展了 Effective Go 中的建議，這些建議為整個社區(qū)的 Go 代碼提供了一個共同的基線。

格式化

所有 Go 源文件必須符合 gofmt 工具輸出的格式。此格式由 Google 代碼庫中的提交前檢查強制執(zhí)行。生成的代碼通常也應該格式化（例如，通過使用 format.Source），因為它也可以在代碼搜索中瀏覽。

駝峰命名

Go 源代碼在編寫多詞名稱時使用 MixedCaps 或mixedCaps (駝峰命名) 而不是下劃線 (蛇式)。

即使它打破了其他語言的約定，這也適用。例如，常量如果是可導出的，則為 MaxLength（而非 MAX_LENGTH），如果為未導出的，則為 maxLength（而非 max_length）。

為了首字母大寫為可導出的目的，局部變量被視為未導出的。

代碼行長度

Go 源代碼沒有固定的代碼行長度。如果一行感覺太長，應該考慮重構而不是折斷。如果它已經盡可能短，那么應該允許該代碼行保持變長。

不要分割代碼行的情況：

• 在縮進更改之前（例如，函數(shù)聲明、條件）
• 使某個長字符串（例如 URL）適合多個較短的行

命名

命名與其說是科學，不如說是一門藝術。在 Go 中，名稱往往比許多其他語言短一些，但適用相同的一般準則。命名時應該注意：

• 使用時不會感到重復
• 考慮上下文
• 不再重復已經清楚的概念

你可以在【決策篇】中找到更多關于命名的具體指導。

局部一致性

在風格指南沒有提及特定風格點的地方，作者可以自由選擇他們喜歡的風格，除非代碼非常接近的地方（通常在同一個文件或包中，但有時在團隊或項目目錄中） 在該問題上采取了一致的風格。

有效的局部風格考量的例子：

• 使用 %s 或 %v 格式化打印錯誤
• 使用緩存 channel 代替互斥鎖

無效的局部風格考量的例子：

• 代碼行長度限制
• 使用基于斷言的測試庫

如果局部風格與風格指南不一致，但可讀性影響僅限于一個文件，它通常會在代碼審查中浮出水面，一致的修復將超出相關 CL（change list，變更清單） 的范圍。那時，提交一個 bug 以追蹤該修復是合適的。

如果一個更改會讓現(xiàn)有的風格偏差惡化，在更多的 API 層面被暴露出來，擴大存在偏差的文件數(shù)量，或引入了一個實際的 bug，那么對于新代碼而言，局部一致性不再是違反風格指南的有效理由。在這些情況下，作者應該在同一個 CL 下清理現(xiàn)有的代碼庫，在當前 CL 之前進行代碼重構，或者找到一個至少不會使得局部問題變得更糟的替代方案。?