在最近的一週,我維護的業務系統出現了很多壞毛病,一週七天crash掉了4次,每次都需要都是因爲一點很小的問題,觸發了蝴蝶效應,導致整個系統全盤崩潰,於是產生除了敘述本篇的想法,當然這並不是爲了掩蓋我在Coding上的一些細節處理和職責疏忽，只是爲了從根本的細節上去分析這些問題。
(一、)爲什麼會產生BUG
首先我們需要嘗試理解一下什麼Bug?
關於bug的解釋
bug 是指任何計算機程序或硬件系統中的錯誤，故障或缺陷。錯誤會產生意外結果或導致系統意外運行
簡單來說:bug就是程序出了問題,產生了意外的結果,沒有按照預期的結果去運行。
產生Bug的原因有很多種:
- 開發者水平太低
- 不同的編譯及運行環境
- 與需求方溝通不到位
- 馬虎大意、考慮不周
- 放飛自我,Coding全靠自嗨
- 選擇了錯誤的或者運行不穩定的第三方庫
以上原因總結,主觀和客觀因素都會影響到Bug的產生,正如誤差不可避免一般,我們應該對自己寫出的代碼進行測試、分析、"溝通".
(二、)如何儘量避免Bug
鑑於以上bug產出的原因,我們可以通過這些一些對策來避免Bug的產生,下面是一些常見原因分析和處理對策。
1.開發者水平太低
在進行系統的構建中,部分開發者可能通常因爲開發經驗過少,或者語言不熟悉,會編寫錯誤的代碼,然後未經過代碼測試和審計,便進行提交和上線操作,導致了異常的引發
解決方案:
- 如果是語法錯誤,可通過一些ide的代碼檢測器,或者語法檢查來檢測代碼可否正常運行.
- 如果是PHP等弱類型語言,可使用靜態代碼掃描工具來發現程序中明顯的語法錯誤.
- 編寫足夠的測試用例,覆蓋整個模塊的語句
- 請求你的夥伴進行CodeReview(代碼審計),來改善代碼的質量和發現代碼中的缺陷
2.不同的編譯及運行環境
因爲業務的拓展和服務支持,需要部署多個不同的運行環境中,如:轉賬系統，你在測試環境中轉賬了1000元給用戶小明,小明卻在生產環境中收到了這1000元,併成功進行提現,往往因爲沒有環境判斷,導致了失誤的操作!
解決方案:
1.在代碼中多進行註釋說明,標明哪些函數會在其他環境中操作和運行
2.加強環境邏輯判斷
以下是我在使用的一些標註和說明,其他開發者或我本人再次閱覽該代碼時,就會得到一個清晰的運行結果.
/**
* 執行該函數時,會根據env環境進行處理,詳細如下
* prod(生產環境):會啓動隊列對視頻進行轉碼、截圖、寫入到生產數據庫中操作.
* staging(預演環境):不會啓動隊列,但會寫入staging數據庫中
* test(測試環境):會啓動隊列對視頻進行轉碼、截圖、寫入到測試數據庫中操作.
*/
$video = $this->uploadVideo($file);
$queue = $this->videoQueue($video);3.與需求方溝通不到位
這是經常程序員與產品對撕的一個很重要原因,TA想要A,而你卻做出了B,於是你們產生了很大的爭論
解決方案:
- 多進行溝通,需求進行反覆確認,不要上手就進行編碼,先進行分析。
- 通過PM系統,留存需求規劃與變更記錄,以便每一次業務更改,都得能與系統中的問題對上號.
4.馬虎大意、考慮不周
編碼時以爲問題很小,修改代碼,不走調試與測試流程,直接上線.
解決方案:
- 不要盲目過於自信,相信自己的主觀判斷,一定走測試流程,確保改動無誤!(這是我之前經常犯的錯,然後系統出了問題,我的fix commit從1變成了N....)
- CodeReview(代碼審計),這是一個最好的辦法,當然需要耗費不少的人力,但是能最大的去降低缺陷和錯誤.
5.放飛自我,Coding全靠自嗨
解決方案:
無
這類朋友不適合做開發者,適合去做創造者!
6.選擇了錯誤的或者運行不穩定的第三方庫
有時候爲了省略接入時間,往往會忽略掉一些大型庫,因爲業務的支持只用到了一小部分,所以我們有時候會去選擇一些mini庫,最後由於不穩定或方案不成熟,出現錯誤的運行結果
解決方案:
- 如果業務級別比較高的話,不建議採用冷門或者無人問津的mini庫使用,因爲出現問題的損失會更大.
- 進行反覆測試,開發人員對核心代碼進行閱覽,確保正常無誤.
- 自我組織編寫或實現,但是學習和開發成本比較高,小型規模不建議採取.
(三、)多與代碼進行"溝通"
“橡皮鴨調試法”是我在閱讀《編寫可讀代碼》一書中看到的一個技巧,我在一個人開發的時候會使用這個技巧,我認爲是一個不錯的選擇.
(四、)總結
我們爲什麼會編寫BUG,如果沒有BUG?開發和測試不就失業了嗎?當然這只是一句玩笑話。
在此引用知乎上一句很有意思的話.
編碼也亦如此,因爲很多主觀和客觀的因素,導致程序執行了錯誤的邏輯,產生了不如預期的結果,作爲一個合格的開發人員,我們應該盡力確保程序穩妥運行,減少失誤和異常。
正如CZG提到的"你寫的每一行代碼，都是你的名片",我們每個人都義務去維護好這張名片,讓其他人對這張名片充滿敬畏之心,而不是"what shit code",諸君共勉！