基于SonarQube平臺提升企業軟件項目質量的應用研究

曾新勵

摘要：隨著企業軟件項目復雜性的日益增加，提高可靠性和避免錯誤缺陷成為開發企業級應用軟件的一個重要因素。該文在分析企業代碼質量管理方面的現狀以及對代碼質量管理的內外在需求的基礎上，研究了SonarQube平臺的運行機制和技術優勢，結合代碼質量規范標準的制定、質量管理平臺在企業內的部署和代碼質量管理流程，提出了基于SonarQube平臺的代碼質量管理解決方案。從系統源代碼的角度出發，在軟件研發過程中使用SonarQube控制代碼質量，不但實現了在項目開發時的代碼質量標準化，并且能夠持續跟蹤代碼質量，對問題形成閉環高效管理。持續有效地進行代碼質量監控，并制定相應的改進措施，對企業高質量交付軟件產品意義重大。

關鍵詞：SonarQube；代碼質量；質量分析；質量管理

中圖分類號：TP311 文獻標識碼：A

文章編號：1009-3044（2019）11-0078-03

1引言

企業軟件項目質量會受到團隊開發人員個體能力以及團隊磨合期不夠等因素影響，傳統的人工代碼質量檢查隨著企業軟件復雜性的日益增加逐漸成為項目的瓶頸。如何持續有效地進行代碼質量管理，高質量交付軟件產品成為企業當下必須要解決的問題。

企業對代碼質量管理的需求一方面來自企業對軟件產品的代碼需要標準化、精細化的管控，力求控制軟件項目的風險。代碼質量管理不當直接造成員工工作量增加，上級不滿意，間接管理成本增加。另一方面，民航機場信息系統建設競爭日益激烈，軟件產品服務質量的高低成為是否能夠贏得客戶的重要因素。與此同時在交付軟件產品時，客戶不僅要檢測產品功能是否實現，還要檢驗軟件自身的代碼質量。

針對民航機場業務支撐系統的現狀，本文從接入復雜度、應用范圍、規則數量、可擴展性和準確率幾個方面對用于代碼質量管理的主流工具進行了調研，重點研究了SonarQube平臺的運行機制和技術優勢，并提出了一種基于SonarQube平臺的代碼質量管理解決方案。從系統源代碼的角度出發，在軟件研發過程中使用SonarQube控制代碼質量，減少人工代碼質量檢查的時間成本，提高問題檢測的準確率，并且同企業現有的內部問題管理工作流程相結合，對問題形成閉環高效管理，從源頭上把控業務系統質量。

2 SonarQube介紹

研發人員在編寫、組織、構建、測試和不斷改進應用程序時使用許多工具、技術、框架和流程，SonarQube作為一款開源代碼質量管理工具，最初是為了跟蹤Java項目的質量而編寫的，它使跟蹤、管理和提高代碼總體質量變得高效規范，并且實現了公認的最佳實踐，為代碼質量度量、評審和補救提供了功能齊全的綜合平臺[1]。

SonarQube通過插件式設計模式方便地集成FindBugs、PMD、Checkstyle、Cubertuna、Jcoco等多種工具，實現軟件項目代碼的靜態檢測。并且通過配置語言插件即可以支持對C/C++、C#、Cobol、Java、PHP等超過25種編程語言進行質量檢測 [2]。

基于SQALE軟件質量方法理論，將通過插件集成工具的各項檢測結果統計分析，以數據、圖表等多維度方式將代碼質量的變化和最終檢測結果合并分析輸出，形成直觀可視化代碼質量報告，量化評估軟件項目質量。也可以擴充報表展示插件，更加豐富Web頁面的展現形式。

在對其他工具的支持方面，采用了統一接口設計方式便于自身被其他平臺引入。支持持續集成工具，可以利用持續集成工具Jenkins來使用SonarQube。得益于其通用規范的設計思想，得到了國內外越來越多軟件研發人員的關注。SonarQube提供了對Eclipse和IntelliJ IDEA開發環境的SonarLint插件支持，對于Maven工程可以在Maven的settings.xml配置文件中添加分析器插件的配置進行分析，還可以直接在控制臺啟動分析項目代碼的默認啟動器SonarQube Scanner執行分析，就可以完成對項目代碼的分析[3]。

3 應用SonarQube代碼質量管理平臺

基于SonarQube的代碼質量管理體系具有三個方面的內容：代碼質量規范標準的制定、質量管理平臺在企業內的部署和代碼質量管理流程。

3.1 代碼質量規范標準

代碼質量是從代碼的角度衡量軟件系統的質量。SonarQube通過簡單、易于遵循的核心7大質量標準來持續改進源代碼質量，包括設計與架構、重復度、注釋比例、單元測試質量、復雜度、潛在bug、編碼規范，如圖1所示。每個維度中包含若干掃描規則，根據不同場景的需要和對代碼質量關注點的差異，可以按照需求對SonarQube中配置的掃描規則進行裁剪和調整。SonarQube根據這7個維度的代碼質量檢測數據形成一個直觀可視化質量報告。

3.2 質量管理平臺在企業內的部署

SonarQube平臺可以很好的與企業現有的開源持續集成工具Jenkins和版本管理工具SVN相結合，借助持續集成工具的輔助可以不斷地創建、執行軟件測試。首先在SonarQube中安裝檢測插并按需求配置好相應規則，然后創建Jenkins項目來啟動SonarQube進行質量檢測，完成檢測后SonarQube會把執行結果直接寫入數據庫，并執行分析統計供Web展現時讀取。SonarQube支持多種數據庫，默認安裝情況下使用自帶的H2 嵌入式數據庫，在遷移和擴展時存在不足，可以根據需要選擇MySql、Oracle、MS SQLServer等數據庫。通過修改sonar.properties配置文件完成數據庫連接的配置，SonarQube啟動時會自動創建數據庫實例并配置好相應的表結構。代碼質量管理平臺如圖2所示。

3.3 代碼質量管理流程

在項目開發中，應用SonarQube進行代碼質量分析評估是一個循環往復、持續性的工作，遵循四個標準流程執行，具體流程包括版本管理、執行評估、風險應對、持續改進，符合PDCA持續循環改進的科學過程。具體流程如圖3所示。

過程描述如下：

1）版本管理。隨著軟件開發過程中業務創新和需求變更，代碼版本控制成為了代碼質量評估的基礎。在版本升級和維護的過程中需要記錄新增加的功能，具體修復的問題，以及在此過程中產生的新問題，都依賴于版本管理的把控。

2）執行評估。執行評估的對象是軟件系統源代碼。從代碼版本管理工具中獲取新的軟件項目版本，使用SonarQube按照預先配置的掃描規則集，執行代碼的初步掃描。SonarQube將掃描出的結果以報表的形式展示，向研發人員提供決策支持。同時調用企業問題管理平臺，根據掃描出來的問題列表創建任務清單，以消息的形式推送給各個研發人員。

3）風險應對。執行完評估后的首要工作是對收到的問題任務清單進行分析，任何工具都可能會產生誤報或漏報的情況，人工參與審查代碼是必須的。研發人員共同對問題進行分析、確認、篩選并確定其嚴重程度，刪除無關緊要和誤報的問題。并針對實際問題設計解決方案，提出改進建議，提交到版本管理SVN。

4）持續改進。研發人員按照風險應對環節給出的改進方案進行修改，在提交代碼時系統自動判斷是否所有任務清單問題都已修改，防止問題代碼繼續提交。完成修改后研發人員填寫任務修改記錄單，企業內部問題管理平臺關閉相關問題，并刪除代碼質量管理平臺對應問題，實現對問題的閉環管理。

4 結論

通過在企業軟件研發過程中引入SonarQube代碼質量管理平臺，實現代碼質量管理全流程的標準化和精細化，讓軟件產品質量管理更加集中，并且能夠實現代碼質量的持續改進。帶來的好處有以下幾點。

1）讓部門管理者、項目管理者可以有針對性的對項目質量進行控制，研發人員隨時了解自己的代碼質量，注重程序設計質量符合企業標準。

2）利用SonarQube和代碼質量管理流程實現代碼質量的持續改進，通過分析評估，使問題得到有效解決，形成一個符合PDCA的科學流程，提升軟件開發過程的工作效率。

3）持續對改進后的結果再評估，確保所有問題落實到相應的人負責，監督改進方案的執行情況，避免到項目后期測試上線才發現問題，實現在開發階段完成軟件產品質量的有效保證，提升客戶滿意度。

5 總結

科學的代碼質量管理能夠有效提高企業軟件項目質量。本文在分析企業代碼質量管理方面的現狀以及需求的基礎上，研究了SonarQube平臺的運行機制和技術優勢，并與企業現有的內部問題管理工作流程相結合，提出了基于SonarQube平臺的代碼質量管理解決方案。不但實現了在項目開發時的代碼質量標準化，還可以持續有效地進行代碼質量監控。按期評估代碼質量并制定相應的風險應對措施，持續循環改進，有助于實現高質量完成軟件項目。同時，SonarQube也適用于企業代碼質量管理云平臺的搭建，有助于推進民航信息系統標準化和規范化建設。

參考文獻：

[1] 楊冰娥.代碼規則自動化檢查系統的設計與實現[D].成都：西南交通大學，2014.

[2] 徐萌.持續集成在現代企業軟件開發中的研究與實現[D].青島：中國海洋大學，2013.

[3] 戚華，楊銘.代碼質量管理平臺Sonar在軟件項目管理中的應用研究[J].電子技術與軟件工程，2016（6）：68-69.

【通聯編輯：王力】