快捷導(dǎo)航

Go語(yǔ)言開(kāi)發(fā)編程規(guī)范命令風(fēng)格代碼格式

更新時(shí)間：2022年06月14日 11:32:06 作者：王中陽(yáng)Go

這篇文章主要為大家介紹了Go語(yǔ)言開(kāi)發(fā)編程規(guī)范命令風(fēng)格代碼格式，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進(jìn)步，早日升職加薪

前言

今天這篇文章是站在巨人的肩膀上，匯總了目前主流的開(kāi)發(fā)規(guī)范，同時(shí)結(jié)合Go語(yǔ)言的特點(diǎn)，以及自己的項(xiàng)目經(jīng)驗(yàn)總結(jié)出來(lái)的：爆肝分享兩千字Go編程規(guī)范。

后續(xù)還會(huì)更新更多優(yōu)雅的規(guī)范。

命名風(fēng)格

1. 【強(qiáng)制】代碼中的命名均不能以下劃線或美元符號(hào)開(kāi)始，也不能以下劃線或美元符號(hào)結(jié)束。

反例：

_name / __name / $name / name_ / name$ / name__

2. 【強(qiáng)制】代碼中的命名嚴(yán)禁使用拼音與英文混合的方式，更不允許直接使用中文的方式。

說(shuō)明：正確的英文拼寫(xiě)和語(yǔ)法可以讓閱讀者易于理解，避免歧義。

注意，純拼音命名方式更要避免采用。

正例：

renminbi / alibaba / taobao / youku / hangzhou

等國(guó)際通用的名稱(chēng)，可視同英文。

反例：

DaZhePromotion [ 打折 ] / getPingfenByName() [評(píng)分] / int某變量 = 3

3. 【強(qiáng)制】公用的變量、類(lèi)型、接口、結(jié)構(gòu)、函數(shù)以及結(jié)構(gòu)體的成員變量等命名使用UpperCamelCase風(fēng)格。

正例：

GolangStruct / UserDO / XmlService / TcpUdpDeal / TaPromotion

反例：

Golangstruct / UserDo / XMLService / TCPUDPDeal / TAPromotion

4. 【強(qiáng)制】私有的變量、類(lèi)型、接口、結(jié)構(gòu)、函數(shù) 以及參數(shù) 名、局部變量都統(tǒng) 一使用 lowerCamelCase 風(fēng)格，必須遵從駝峰形式。

正例：

localValue / getHttpMessage() / inputUserId

5. 【強(qiáng)制】常量命名命名使用 UpperCamelCase 風(fēng)格，并使用 const 聲明，力求語(yǔ)義表達(dá)完整清楚，不要嫌名長(zhǎng)。

正例：

const StatusOK = 200

6. 抽象結(jié)構(gòu)命名使用 Abstract 或 Base 開(kāi)頭；異常類(lèi)命名使用 Err 結(jié)尾；測(cè)試類(lèi)命名以 Test 開(kāi)頭，以它要測(cè)試的函數(shù)的名稱(chēng)結(jié)尾。

正例：

ParamsErr := errors.New(“params err”)

7. 接口命名規(guī)范一般使用 er 結(jié)尾：?jiǎn)蝹€(gè)函數(shù)的接口名以“er”作為后綴，接口的實(shí)現(xiàn)則去掉 er；兩個(gè)函數(shù)的接口名綜合兩個(gè)函數(shù)名，以 er 作為后綴，接口的實(shí)現(xiàn)則去掉 er ；三個(gè)以上函數(shù)的接口，抽象這個(gè)接口的功能，類(lèi)似于結(jié)構(gòu)體命名。

8. 【強(qiáng)制】數(shù)據(jù)和切片類(lèi)型命名以 Arr 結(jié)尾，map 類(lèi)型以 Map 結(jié)尾。相同功用的結(jié)構(gòu)體可以根據(jù)功能采用相同的結(jié)尾， Api 請(qǐng)求以 Req 結(jié)尾，相應(yīng)以 Res 結(jié)尾，數(shù)據(jù)結(jié)構(gòu)體以 xxxModel 結(jié)尾， xxx 即為數(shù)據(jù)表名。

正例：

var userArr [3]string / type LoginReq struct{} / type UserDO struct{}

9. 【強(qiáng)制】返回結(jié)果主要為布爾類(lèi)型的函數(shù)，函數(shù)名可以 is、has 等開(kāi)頭

10. 【強(qiáng)制】工程名統(tǒng)一使用小寫(xiě)，單詞之間使用 - 分割。包目錄名一律使用小寫(xiě)，盡量采用一個(gè)單詞命名，單詞間不用符號(hào)分割，統(tǒng)一使用單數(shù)形式，但是結(jié)構(gòu)體名如果有復(fù)數(shù)含義，結(jié)構(gòu)體名可以使用復(fù)數(shù)形式。包目錄下的包名（ package namepackage ），如非 main 函數(shù)，和包目錄名保持一直且單詞間用 _ 分隔，測(cè)試文件以 _test 結(jié) 尾。

正例：

db-utils / package db_utils / package db_utils_test

反例：

services

11. 為了達(dá)到代碼自解釋的目標(biāo)，任何自定義編程元素在命名時(shí)，使用盡量完整的單詞組合來(lái)表達(dá)其意。反例：var a int 的隨意命名方式。

12. 在常量與變量的命名時(shí)，表示類(lèi)型的名詞放在詞尾，以提升辨識(shí)度。如規(guī)范【8】所示。

正例：

startTime / startDate

反例：

startedAt / startDt

13.如果模塊、接口、類(lèi)、方法使用了設(shè)計(jì)模式，在命名時(shí)需體現(xiàn)出具體模式。

說(shuō)明：將設(shè)計(jì)模式體現(xiàn)在名字中，有利于閱讀者快速理解架構(gòu)設(shè)計(jì)理念。

代碼格式

1. 【強(qiáng)制】如果是大括號(hào)內(nèi)為空，則簡(jiǎn)潔地寫(xiě)成{} 即可，大括號(hào)中間無(wú)需換行和空格；如果是非空代碼塊則： 1）左大括號(hào)前不換行。 2）左大括號(hào)后換行。 3）右大括號(hào)前換行。 4）右大括號(hào)后還有 else 等代碼則不換行；表示終止的右大括號(hào)后必須換行。

2. 【強(qiáng)制】左小括號(hào)和字符之間不出現(xiàn)空格；同樣，右小括號(hào)和字符之間也不出現(xiàn)空格；而左大括號(hào) 前需要空格。反例：if (空格 a == b 空格)

3. 【強(qiáng)制】if / for / switch 等保留字與括號(hào)之間都必須加空格。

4. 【強(qiáng)制】任何二目、三目運(yùn)算符的左右兩邊都需要加一個(gè)空格。說(shuō)明：運(yùn)算符包括賦值運(yùn)算符= 、邏輯運(yùn)算符&&、加減乘除符號(hào)等。

5. 【強(qiáng)制】采用 tab 字符縮進(jìn)，寬度設(shè)置為 4 個(gè) 空格

6. 【強(qiáng)制】單行字符數(shù)限制不超過(guò) 120 個(gè)，超出需要換行，換行時(shí)遵循如下原則：

第二行相對(duì)第一行縮進(jìn)一個(gè) tab，從第三行開(kāi)始，不再繼續(xù)縮進(jìn)。
運(yùn)算符與上文一起作為結(jié)尾。
方法調(diào)用的點(diǎn)符號(hào)與上文一起作為結(jié)尾。
方法調(diào)用中的多個(gè)參數(shù)需要換行時(shí)，在逗號(hào) 后進(jìn)行。
在括號(hào)前不要換行

7.【強(qiáng)制】函數(shù)參數(shù)在定義和傳入時(shí)，多個(gè)參數(shù)逗號(hào)后邊必須加空格。

控制語(yǔ)句

1.【強(qiáng)制】在一個(gè) switch 塊內(nèi)，每個(gè) case 無(wú)需聲明 break 來(lái) 終止，如果想順序執(zhí) 行使用 fallthrough ；在一個(gè) switch 塊內(nèi)，都必須包含一個(gè) default 語(yǔ)句并且放在最后，即使它什么代碼也沒(méi)有。

2.【強(qiáng)制】在高并發(fā)場(chǎng)景中，避免使用”等于”判斷作為中斷或退出的條件。說(shuō)明：如果并發(fā)控制沒(méi)有處理好，容易產(chǎn)生等值判斷被“擊穿”的情況，使用大于或小于的區(qū)間判斷條件來(lái)代替。反例：判斷剩余獎(jiǎng)品數(shù)量等于 0 時(shí)，終止發(fā)放獎(jiǎng)品，但因?yàn)椴l(fā)處理錯(cuò)誤導(dǎo)致獎(jiǎng)品數(shù)量瞬間變成了負(fù)數(shù)，這樣的話，活動(dòng)無(wú)法終止。

3.【推薦】表達(dá)異常的分支時(shí)，少用 if-else 方式，這種方式可以改寫(xiě)成：

if condition { … return obj; } // 接著寫(xiě) else 的業(yè)務(wù)邏輯代碼;

說(shuō)明：如果非使用 if()…else if()…else…方式表達(dá)邏輯，避免后續(xù)代碼維護(hù)困難，

【強(qiáng)制】請(qǐng)勿超過(guò) 3 層。

正例：超過(guò) 3 層的 if-else 的邏輯判斷代碼可以使用衛(wèi)語(yǔ)句、策略模式、狀態(tài)模式等來(lái)實(shí)現(xiàn)，其中衛(wèi)語(yǔ)句即代碼邏輯先考慮失敗、異常、中斷、退出等直接返回的情況，以方法多個(gè)出口的方式，解決代碼中判斷分支嵌套的問(wèn)題，這是逆向思維的體現(xiàn)。

4. 【參考】下列情形，需要進(jìn)行參數(shù)校驗(yàn)：

調(diào)用頻次低的方法。
執(zhí)行時(shí)間開(kāi)銷(xiāo)很大的方法。此情形中，參數(shù) 校驗(yàn)時(shí)間幾乎可以忽略不計(jì)，但如果因?yàn)閰?shù)錯(cuò) 誤導(dǎo)致中間執(zhí)行回退，或者錯(cuò)誤，那得不償失。
需要極高穩(wěn)定性和可用性的方法。
對(duì) 外提供的開(kāi) 放接口，不管是 RPC/API/HTTP 接口。
敏感權(quán)限入口。

5. 【參考】下列情形，不需要進(jìn)行參數(shù)校驗(yàn)：

極有可能被循環(huán)調(diào)用的方法。但在方法說(shuō)明里必須注明外部參數(shù)檢查要求。
底層調(diào)用頻度比較高的方法。畢竟是像純凈水過(guò)濾的最后一道，參數(shù)錯(cuò)誤不太可能到底層才會(huì)暴露問(wèn)題。一般 DAO 層與 Service 層都在同一個(gè)應(yīng)用中，部署在同一臺(tái)服務(wù)器中，所以 DAO 的參數(shù)校驗(yàn)，可以省略。

雜項(xiàng)

1. 【強(qiáng)制】在使用正則表達(dá)式時(shí)，利用好其預(yù)編譯功能，可以有效加快正則匹配速度。

正例：

// 預(yù)編譯當(dāng)前正則表達(dá)式re, _ := regexp.Compile("^hel+o") // 是否匹配指定字符串 isMatch := re.MatchString(“hello world”)

2. 【推薦】及時(shí)清理不再使用的代碼段或配置信息。說(shuō)明：對(duì)于垃圾代碼或過(guò)時(shí)配置，堅(jiān)決清理干凈，避免程序過(guò)度臃腫，代碼冗余。正例：對(duì)于暫時(shí)被注釋掉，后續(xù)可能恢復(fù)使用的代碼片斷，在注釋代碼上方，統(tǒng)一規(guī)定使用三個(gè) 斜杠(///)來(lái)說(shuō)明注釋掉代碼的理由。

異常日志

1. 【強(qiáng)制】使用控制流機(jī)制應(yīng)對(duì)錯(cuò)誤，通過(guò)從函數(shù) 返回錯(cuò)誤作為附加返回值來(lái)指示錯(cuò)誤，如果函數(shù) 有多個(gè)返回值，習(xí)慣上將錯(cuò)誤值作為最后一個(gè)結(jié) 果返回。如果錯(cuò)誤只有一種情況，結(jié)果通常設(shè)置為布爾類(lèi)型。nil 值表示沒(méi)有錯(cuò)誤。正例：res, err := somepkgAction()

2. 【強(qiáng)制】對(duì)于總是成功返回的函數(shù)，不必返回錯(cuò)誤。

3. 【強(qiáng)制】錯(cuò)誤信息的首字母小寫(xiě)且避免換行