引言:在“DevOps能力之屋(CapabilitiesHouse of DevOps)”中,華為云DevCloud提出(工程方法+最佳實踐+生態)×工具平臺=DevOps能力。華為云DevCloud將持續推出“DevOps on DevCloud”系列,按場景闡述在華為云DevCloud上的實施方法與實踐。本文將聚焦闡述如何使用華為云DevCloud代碼檢查服務來防止Java NPE(Null PointerException)問題。
在《如何構建Kotlin開發的Android Apps》一文曾指出“空安全(Null Safety)”是Kotin最吸引Java開發者的特性之一,?Kotlin類型系統的目標是消除Null reference的危險性。Tony Hoare在2019年QCon London上將Null reference稱為“my billion-dollar mistake”。所謂Null reference是許多編程語言最為常見的陷阱之一,指的是訪問Null reference的成員將導致null reference exception。在Java語言中,Nullreference通常等同于NullPointerException(即NPE)。
對于Java開發者來講,或許只有處理過了NPE,才能成為一名真正的Java開發者。NPE通常來講,會來自于以下場景:
調用了一個空對象的實例方法;
訪問或者修改一個空對象的域成員;
當數組是一個空對象時,取它的長度;
對數組中的某些null元素進行范文或者修改;
將null當做Throwable值拋出
如何防止NPE,簡單來講,主要是兩點要素:手段與方法、意識與經驗。Java開發者可以參考以下最佳實踐來防空:
通過已知字符串常量而不是未知對象來調用equals()與equalsIgnoreCase()方法
在valueOf()與toString()返回相同結果的地方優先使用valueOf()
使用null安全的方法與庫
避免從方法中返回null,而是返回空的collection或者array
使用注解@NotNull和@Nullable
在代碼中避免不必要的autoboxing和unboxing
遵循Contract并定義合理的缺省值
在Java 8中使用Optional
雙重入參校驗
盡管Java開發者能力對于防空是至關重要的,然而人難免會有所失誤。為了進一步降低風險,華為云DevCloud建議項目或者產品團隊使用代碼檢查服務來檢查是否存在NPE。
1.準備工作
1.1???示例工程
Code4Benchmark是采用Java開發的示例工程,希望用于評估代碼質量評估工具或者云服務對代碼問題的檢查能力,例如空指針(Null Pointer)、資源泄露、SQL注入(SQL Injection)等。
對于空指針場景,目前主要是顯式解引用、前置判空、后置判空、空返回值等,代碼片段如下:
顯式解引用:?直接對null對象解引用
前置判空?:對象前面有判空,后面解引用
后置判空?:對象后面有判空,前面解引用
空返回值?:空返回值直接解引用
Code4Benchmark完整代碼可以參考https://github.com/supremeGoodness/Code4Benchmark.git。
1.2???創建項目及代碼庫
開發者可以訪問華為云DevCloud,登錄后在首頁新建項目,選擇“空白項目”的Scrum或者看板之一,輸入項目名稱(例如:CodeCheckBenchmark)即可創建項目。
在訪問CodeCheckBenchmark項目,并進入“代碼”-“代碼托管”后,可以點擊“新建”-“導入外部倉庫”來創建倉庫,輸入github上的倉庫地址(https://github.com/supremeGoodness/Code4Benchmark.git)。后續步驟接受默認值即可創建倉庫。
圖1?導入外部倉庫來新建代碼倉庫
2?.檢查代碼
通常情況下,使用華為云DevCloud進行代碼檢查非常簡單:新建代碼檢查任務然后執行此任務即可。當前前提是默認的規則集“通用檢查規則集”滿足代碼質量的要求。用戶可以在任務的“設置”-“規則集”中選擇系統內置的其它規則集(例如“全面檢查規則集”)或者自定義的規則集。接下來,我們通過自定義規則集的方式來進行NPE問題的檢查。
2.1???自定義規則集
在訪問CodeCheckBenchmark項目,并進入“代碼”-“代碼檢查”后,在“規則集”頁面“新增規則集”,輸入規則集名稱rs-npe-java、檢查語言等,如圖2所示。然后在規則集的配置頁面,將“Correctness - Nullcheck of value previously dereferenced”、“Null dereference”、“Correctness - Possible null pointer dereference”等規則從“未啟用”規則中選中保存以變為“已啟用”規則
圖2 新建檢查規則集
圖3?配置規則集
2.2???創建檢查任務并設置規則集
在訪問CodeCheckBenchmark項目,并進入“代碼”-“代碼檢查”后,在“任務”頁面“新建任務”,選擇代碼倉庫Code4Benchmark、輸入任務名稱cc-Code4Benchmark等完成任務創建。如圖4所示為創建后的任務概覽。
圖4 創建后的任務概覽
在cc-Code4Benchmark任務中,通過“設置”來配置自定義的規則集rs-npe-java,如圖5所示。
圖5 為任務選擇自定義的規則集
2.3???執行檢查任務
在cc-Code4Benchmark任務中,可以點擊“開始檢查”。在檢查完成后,在“概覽”頁面查看檢查結果,如圖6所示。在概覽中,我們可以發現檢測出4個問題。
圖6 任務檢查結果概覽
3.分析與修改
在cc-Code4Benchmark任務中,在“概覽“頁點擊未解決問題的數量,或者點擊“代碼問題”,可以查看問題詳情。對于每一個問題,可以根據“修改建議”進行相關的問題修訂。
圖7 問題詳情與修改建議
NPE是Java開發中的經典問題,華為云DevCloud代碼檢查服務提供的規則不止本文提到的3條規則,具體可以在“規則”中查看。在實際的項目開發中,用戶可以直接選擇“全面檢查規則”來進行全方位的代碼質量檢測,以提升代碼質量。
W. Edwards Deming曾說過“Inspectionis too late. Quality cannot be inspected into a product or servive. It must bebuilt into it.”本質上,軟件質量取決于工程師的意識、能力、方法與技能。然而,工程師的意識、能力、方法與技能需要不斷提升。因而,華為云DevCloud代碼檢查服務在軟件交付中仍然具有舉足輕重的地位,不僅可以及時發現代碼質量問題,而且可以強化工程師的預期行為,有助于提升工程師的意識、能力、方法與技能。