如何保障Go語言基礎代碼質量?

来源:https://www.cnblogs.com/jinsdu/archive/2019/03/06/10486645.html
-Advertisement-
Play Games

為什麼要談這個topic? 實踐中,質量保障體系的建設,主要針對兩個目標: 一是不斷提高目標業務測試覆蓋率,保障面向客戶的產品質量;二就是儘可能的提高人效,增強迭代效率。而構建全鏈路質量卡點就是整個體系建設的核心手段。筆者用下圖來描述這整個鏈路: 可以看到,雖然保障業務迭代的方向性正確排在最前面,但 ...


為什麼要談這個topic?

實踐中,質量保障體系的建設,主要針對兩個目標: 一是不斷提高目標業務測試覆蓋率,保障面向客戶的產品質量;二就是儘可能的提高人效,增強迭代效率。而構建全鏈路質量卡點就是整個體系建設的核心手段。筆者用下圖來描述這整個鏈路:

可以看到,雖然保障業務迭代的方向性正確排在最前面,但在具體操作上,這一步需要的是強化流程規範和構建企業文化,同時對各負責人技能培訓,可以說多數是軟技能。而保障基礎代碼質量環節發力於自動化建設鏈路之始,是可以通過技術手段來消滅潛在的質量問題,所以構建好的話能極大的降低心智負擔,非常值得關註。

我們都知道,代碼的好壞會直接影響到業務質量,團隊協作,以及後期技術債等。有一個經典的圖來描述代碼質量的好壞,當能深切表達程式員的內心:

而同時我們相信,絕大部分程式員都有追求卓越的初心,且會儘可能的在自己能力範圍內編寫高質量的代碼。

但是,保障基礎代碼質量光靠程式員的個人素質一定是不全面,是人就會犯錯,可能會疏忽。我們最需要的是一種自動化的機制來持續確保不出問題。這也是自動化的魅力,一次構建,持續收穫價值。

此類工具在業界一般叫linter,不同的語言有不同的實現。本文主要探究Go語言相關的。
在介紹相關工具之前,我們先看看幾個經典的代碼壞味道:

這段代碼常規運行不會有問題,但是在一些場景下迴圈執行,那可能就會有問題了, 我們來看看:

(註:ex2是上述代碼編譯出的可執行文件名字)

很明顯,有句柄泄露。原因也很簡單,http response的body沒有關閉。但這個關閉語句,一不註意也容易寫錯:

這時候如果百度掛了,上述程式程式就會因為空指針引用,造成非預期的panic,非常的不優雅。所以正確的做法應該是在err判斷之後再行關閉body(關於Client.Do 具體的各種限制,大家可以參考這裡: https://golang.org/pkg/net/http/#Client.Do)

如此種種,此類小問題在實際編碼活動中非常常見,且不容易一眼看出問題。甚至常規的測試可能也難檢測出來,可謂非常棘手。好在Go語言的開發者們為我們想到了這一點,內置工具鏈中的vet命令,就能方便的檢測到很多類似的問題。

還比如下麵的代碼場景,我在實際的測試用例和業務代碼都看到過:

go vet 可以很容易檢測出這個問題(其他vet功能,可以參考這裡: https://golang.org/cmd/vet/)。

go的工具鏈中,還有一個不得不提,那就是大名鼎鼎的go fmt,其了卻了其他語言經常陷入的代碼風格之爭,是Go語言生態構建非常巧妙的地方。另外golint也是google主推的go語言代碼代碼風格工具,雖非強制,但強烈建議新項目適用。

Go linters業界現狀

上面主要說到Go工具鏈的內置工具,還有一些非官方的工具也比較有名,比如 staticcheck, errcheck在github上Star都較多。此類工具有個專門的的github庫,收集的比較全,參見 awesone-static-analysis

同時還有些項目旨在聚合此類工具,提供更方便的使用方式,以及一些酷炫的產品化。比如golangci-lint, 其衍生的商業化項目,可以自動針對github PR做代碼審核,對有問題的地方自動comments,比較有意思。

如何才能優雅的落地linter檢查?

linter工具必須為產品質量服務,不然就是做無用功。實踐中,我們應該思考的是如何才能優雅的落地linter檢查,如何才能建立有效的質量卡點。

推薦針對PR,做代碼檢查,保障入庫代碼質量。基於PR做事情是我比較看好的,因為這是調動所有研發力量,天然契合的地方。且進一步講,這也是測試基礎設施更能體現價值的地方。

目前Github上有很多這方面的集成系統做的都比較好,能夠快速的幫我們落地PR測的檢查,比如Travis, Circle CI等。另外就是著名的Kubernetes社區,也自行構建了強大的Prow系統,其不光是基於CICD系統,還構建了chat ops模式,為參與Kubernetes的社區的貢獻者提供了方便。

細看Kubernetes庫,會發現,其會針對每個PR都做如下靜態檢查:

  • gofmt: https://github.com/kubernetes/kubernetes/blob/master/hack/verify-gofmt.sh
  • govet: https://github.com/kubernetes/kubernetes/blob/master/hack/make-rules/vet.sh
  • golint: https://github.com/kubernetes/kubernetes/blob/master/hack/verify-golint.sh
    因為golint只是糾正代碼風格,並不是強制,所以k8s官方就弄了比較軟的方案,對於當前已經存在的代碼如果有問題,先排除掉(如下)。對於新生代碼,如果檢查失敗,ci就掛掉。
    https://github.com/kubernetes/kubernetes/blob/master/hack/.golint_failures

Kubernetes只利用了官方的幾款工具, 在檢測準確性上比較有保障。有了這些檢查點,也能倒逼研發人員關註提交代碼的質量,會迫使其在本地或者IDE上就配置好檢查,確保每次提交的PR都能通過檢查,不浪費CI資源。這也是合格工程師的基本要求。

總結

高質量的代碼是業務質量保障的基礎。而編寫高質量的代碼是技術問題,同時也應該是企業文化問題。因為當大家都開始註重技術,註重代碼質量時,自然會朝著精益求精的路上行進,視糟糕的代碼為仇寇。

我的一位老闆跟我說過,要做就做Number One。而在沒達到第一的時候,那就要向業界標桿看齊,比如Netflix,Google,Facebook等。當大家都非常註重自己代碼質量時,工程師才有時間去關註解決更加系統性的問題,而不用一直在Low Level徘徊。筆者深以為然。

Contact me?

Email: [email protected]

Blog: http://www.cnblogs.com/jinsdu/

Github: https://github.com/CarlJi


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • Java就是用來做項目的!Java的主要應用領域就是企業級的項目開發!要想從事企業級的項目開發,你必須掌握如下要點:1、掌握項目開發的基本步驟2、具備極強的面向對象的分析與設計技巧3、掌握用例驅動、以架構為核心的主流開發方法沒有人願意自己一輩子就滿足於掌握了一些代碼實現的技巧,別人告訴你要實現什麼, ...
  • 前言 開心一刻 本人幼教老師,冬天戴帽子進教室,被小朋友看到,這時候,有個小家伙對我說:老師你的帽子太醜,趕緊摘了吧。我逗他:那你好好學習,以後給老師買個漂亮的?這孩子想都沒想立刻回答:等我賺錢了,帶你去南韓整形 簡單示例 我們先來看一個純粹的mybatis示例(不集成spring等其他框架),代碼 ...
  • 經 @沈默 在上文 "Antlr4添加中文變數賦求值,括弧,各種問題" 評論中指出, 語法規則描述依賴於Antlr4生成的語法分析器的預設分析方法, 比如運算符的左聯繫, 以及優先順序處理等等. 於是將語法修改為下麵(源碼版本號: "program in chinese/quan5" ): 這樣做的結 ...
  • 中文編程 "知乎專欄" 原文 "地址" (前文 "通用型的中文編程語言探討之一: 高考" , 即使是這"第一步", 即使一切順利達到列出的功能恐怕也需要個人數年的業餘時間. 看到不少乎友都遠更有資本和實力更快速地完成這一工程. 希望隨時告知類似項目, 省得在下作無用功) 初步打算用Antlr4生成J ...
  • 中文編程 "知乎專欄" 原文 "地址" 基本參考https://pragprog.com/book/tpantlr2/the definitive antlr 4 reference 一書"Building a Calculator Using a Visitor"一節, 僅添加了數學乘除法符號的支 ...
  • 在可預見的未來, 高考仍是最重要的也最有社會影響力的人才選拔機制. 很久沒有關註, 最近得知高考自選科目中開始增加了編程一項(見 "如何評價2017浙江高考七選三科目中包含技術?" ). 雖然個人對編程是否應該進入高考仍有保留看法, 但至少全民(都應該可以)編程這一趨勢已經很明顯了. 這應該是中文編 ...
  • 筆者環境 centos7 python3 pytesseract只是tesseract-ocr的一種實現介面。所以要先安裝tesseract-ocr(大名鼎鼎的開源的OCR識別引擎)。 依賴安裝 安裝依賴的leptonica庫 安裝tesseract-ocr 安裝語言包: 安裝pytesseract ...
  • Maven 有一個生命周期,當你運行 mvn install 的時候被調用。這條命令告訴 Maven 執行一系列的有序的步驟,直到到達你指定的生命周期。遍歷生命周期旅途中的一個影響就是,Maven 運行了許多預設的插件目標,這些目標完成了像編譯和創建一個 JAR 文件這樣的工作。 一個jar包,會有 ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發(一):使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說,近來想嘗試開發一款安卓APP,考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP,畢竟是使用Visual Studio開發工具,使用起來也比較的順手,結合微軟官方的教程進行了安卓 ...
  • 前言 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 ...
  • 話不多說,直接開乾 一.下載 1.官方鏈接下載: https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe,運行開始下載SQL server; 二. ...
  • 前言 隨著物聯網(IoT)技術的迅猛發展,MQTT(消息隊列遙測傳輸)協議憑藉其輕量級和高效性,已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫,為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog支持多種接收器用於日誌存儲,增強器用於添加屬性,LogContext管理動態屬性,支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項,適用於不同需求。 ...
  • 目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據,爬取信息時需要模擬瀏覽器行為,否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下: 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • 1.前言 什麼是熱更新 游戲或者軟體更新時,無需重新下載客戶端進行安裝,而是在應用程式啟動的情況下,在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR,Xlua,ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles,Addressable, ...
  • 本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺,其實像阿裡雲,騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後,它會送 ...
  • 通過以下方式可以高效,並保證數據同步的可靠性 1.API設計 使用RESTful設計,確保API端點明確,並使用適當的HTTP方法(如POST用於創建,PUT用於更新)。 設計清晰的請求和響應模型,以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...