開發者提高軟件質量的六個步驟

停止產生新的質量問題

無論手頭的軟件過去是如何編寫的,您都應當立即停止向該軟件引入新的質量問題。

第1步:安裝Sonarlin

作為開發人員,請在您最常用的IDE(如Eclipse)中安裝Sonarlin(請參見https://www.sonarlint.org/)。您會驚奇地發現:當自己在編寫代碼時,它會識別出代碼中的質量問題,并給出詳細的說明,進而提供修復的正確方法。

就我個人而言,我在過去的一年中一直使用著Sonarlin,它持續給我指出代碼中的各種未被意識到的錯誤,讓我成長為一名更好的軟件開發者。

第2步:在SonarQube中建立Quality Gates

如果您有一個開發團隊,我建議您通過制定一套質量控制策略,來給每一次提交建立一種檢查源代碼中質量問題的自動化方法,以防止任何問題被合并到主線上。通常,您可以在SonarQube(請參見https://www.sonarqube.org/)中配置Quality Gates(請參見https://docs.sonarqube.org/display/SONAR/Quality+Gates),為不同類型的質量問題設置一個或多個閾值。例如:您可以在不引入任何新的關鍵或重大問題的前提下,成功提交新的源代碼。

a87fccc247ff6125b6c78f9a342ac3da.png-wh_600x-s_1164006254.png

時間都去哪兒了?

作為一個開發人員,您很可能會將大部分的時間花費在閱讀代碼,并理清代碼的意圖上。在嘗試修復bug或實現新功能的過程中,您是否會反復讀到相同的代碼?您肯定會認為應當通過重構,以提高代碼的可讀性。但是,當您面對一個由數千個文件(例如Java的類)所組成的軟件應用時,又該如何下手進行代碼重構呢?

通常情況下,縱然應用程序由數千個文件所組成,我們的軟件開發活動一般也就集中在有限的某個文件集中。例如:對于我所維護的企業級應用程序而言,雖然它有著一萬多個源代碼文件,但是我的開發活動往往只集中在其中的十多個文件上,它們在每一次提交中都會發生變化。

第3步:只重構頻繁變更的文件

通過在自己的代碼庫里識別那些變更最為頻繁的文件,您會了解到開發人員都將時間不知不覺地花費到了何處。如果您正在使用Git作為自己的版本控制系統,那么就可以執行以下的命令:

git log --format=format: --name-only | egrep -v '^$' | sort | uniq -c | sort -r > commits_per_file.txt 

該命令將針對您的代碼庫進行文件列表的排序打印,其中變更最為頻繁的文件(即具有***提交次數的)會被排在最前列,如下所示:

Commits File

230 gr/kolaxis/Utils.java

220 gr/kolaxis/UserManager.java

210 gr/kolaxis/UserTemplate.java

根據實際的數據(本例來自版本控制系統),您可以協同自己的開發團隊,針對哪些需要進行重構的文件做出明智的決定。

只有對代碼庫中變更最為頻繁的文件予以重構,才能增加它們的易讀性,也就更容易被每一位開發人員所理解。同時,有了針對性的代碼重構,開發人員閱讀代碼的時間花銷也會大幅降低,整個開發團隊的生產力同樣會得到相應的提升。

第4步:將測試集中在頻繁變更的代碼上

請不要浪費時間測試那些長時間未曾被修改的成熟代碼。相反,您應當將重點放在測試頻繁變更代碼的質量保證環節。為什么這樣說呢?原因如下:

  • 由于頻繁變化,它們包含了更多的軟件缺陷與安全風險,因此更需要打上各種補丁。
  • 它們一般提供的是用戶常用的功能,因此對于其效果的改進需求會與日俱增。

雖然我們可以通過調整測試套件,只測試那些頻繁變更的代碼,從而節省寶貴的交付時間。但是開發人員也需要經常捫心自問:這些頻繁變更的代碼覆蓋率到底是多少?

第5步:不要觸摸舊的代碼!

當您打開一個長時間未進行更改的源文件時,不管它有多“難看”,您都要抵住對它進行重構的誘惑。舊的源代碼已經經受了一段時間的考驗,已經在生產環境中無故障地運行了許久。因此,我們沒有必要再花費開發的寶貴時間與精力,對已被證明為正確的成熟代碼進行改動,除非您有非常充分的理由。

我個人認為:對于舊代碼的任意修復,往往會引入一些意想不到的新bug。因此,“存在便是合理”,我們暫且對它們進行擱置。當然,凡事也并非絕對,此處的例外是“死代碼(dead code)”。即:過去曾經為了開發某個特性而提交過的,但是從未真正使用過的代碼。因此,如果您確信某段代碼確實沒有被調用過,那么就請刪掉它吧!通過刪除“死代碼”,每一位開發人員都會更加容易地去瀏覽現有的代碼庫,同時也能減少軟件應用的總體構建時間,進而節省開發團隊寶貴的交付時間。

誰動了我的代碼?

對于某個軟件應用,您知道有多少開發人員正工作在給定的組件上嗎?根據微軟的研究:“小部分代碼貢獻者(minor contributor)的數量,與發布前后的失敗率,有著較強的正相關性。”也就是說,如果有許多開發人員只是偶爾對源代碼做出了貢獻(增加小段新的程序),而且每段代碼都只有少量的提交(例如低于整體提交的5%),那么該組件就很可能會對整體質量造成影響。

相反,如果某一個開發者對組件執行了大部分的提交工作(甚至可以稱他們為組件的所有者),那么該組件的失敗可能性會比較低,而預計的質量則會比較高。

第6步:關注小部分代碼的貢獻者

如下圖所示,通過對軟件應用中的所有組件逐一識別出小部分代碼的貢獻者,進而著重測試他們的代碼質量,以減少軟件應用中的bug。

因此,主要代碼貢獻者需要定期審查小部分代碼貢獻者提交上來的程序;而小部分代碼貢獻者則需要在進行程序修改之前,主動咨詢主要代碼貢獻者。

擴展閱讀

如果您對上述提高軟件質量的話題感興趣的話,請進一步閱讀如下的資源與鏈接:

原文標題:Improve the Quality of Your Software in 6 Steps,作者: Ioannis Kolaxis

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 228,345評論 6 531
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 98,494評論 3 416
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 176,283評論 0 374
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 62,953評論 1 309
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,714評論 6 410
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 55,186評論 1 324
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,255評論 3 441
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,410評論 0 288
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 48,940評論 1 335
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 40,776評論 3 354
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 42,976評論 1 369
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,518評論 5 359
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,210評論 3 347
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,642評論 0 26
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,878評論 1 286
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,654評論 3 391
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 47,958評論 2 373

推薦閱讀更多精彩內容

  • 詹聰聰 2020/05/08 02:08:40 用體溫計量體溫不能治病,它只能證明一個人生了病;同樣地,對軟件的測...
    天涯待歸客閱讀 7,143評論 0 4
  • 前言 才華橫溢的Stoyan Stefanov,在他寫的由O’Reilly初版的新書《JavaScript Pat...
    兔爸閱讀 343評論 0 3
  • 久違的晴天,家長會。 家長大會開好到教室時,離放學已經沒多少時間了。班主任說已經安排了三個家長分享經驗。 放學鈴聲...
    飄雪兒5閱讀 7,540評論 16 22
  • 今天感恩節哎,感謝一直在我身邊的親朋好友。感恩相遇!感恩不離不棄。 中午開了第一次的黨會,身份的轉變要...
    迷月閃星情閱讀 10,592評論 0 11
  • 可愛進取,孤獨成精。努力飛翔,天堂翱翔。戰爭美好,孤獨進取。膽大飛翔,成就輝煌。努力進取,遙望,和諧家園。可愛游走...
    趙原野閱讀 2,751評論 1 1