好書推薦
代碼質(zhì)量衡量指標(biāo)可以分為兩部分:設(shè)計(jì)規(guī)約和代碼規(guī)范。設(shè)計(jì)規(guī)約是思想,代碼規(guī)范是思想的具體實(shí)現(xiàn)。
《設(shè)計(jì)規(guī)約》有以下部分:
- 擴(kuò)展性
- 可讀性
- 維護(hù)性
- 容錯(cuò)性
- 健壯性
- 魯棒性
- 高內(nèi)聚/低耦合
《代碼規(guī)范》有以下部分:
- 編碼規(guī)范:是否遵守了編碼規(guī)范衷掷,遵循了最佳實(shí)踐。
- 潛在的BUG:可能在最壞情況下出現(xiàn)問題的代碼柿菩,以及存在安全漏洞的代碼戚嗅。
- 文檔和注釋:過少(缺少必要信息)、過多(沒有信息量)枢舶、過時(shí)的文檔或注釋懦胞。
- 重復(fù)代碼:違反了Don’tRepeat Yourself原則。
- 復(fù)雜度:代碼結(jié)構(gòu)太復(fù)雜(如圈復(fù)雜度高)祟辟,難以理解医瘫、測(cè)試和維護(hù)。
- 測(cè)試覆蓋率:編寫單元測(cè)試旧困,特別是針對(duì)復(fù)雜代碼的測(cè)試覆蓋是否足夠醇份。
- 設(shè)計(jì)與架構(gòu):是否高內(nèi)聚、低耦合吼具,依賴最少僚纷。
擴(kuò)展性
擴(kuò)展性指的是代碼在不改動(dòng)或者改動(dòng)代碼極少的情況下,可以支持新增業(yè)務(wù)或者新增功能拗盒。
可讀性
可讀性指的是代碼可以很容易讀懂或者花費(fèi)很少的時(shí)間讀懂怖竭。
維護(hù)性
維護(hù)性是基于可讀性,代碼可讀性強(qiáng)了陡蝇,那么維護(hù)起來就更容易痊臭。
容錯(cuò)性
容錯(cuò)性指的是在你處理業(yè)務(wù)邏輯的時(shí)候哮肚,要抓取異常,在異常里面處理錯(cuò)誤信息广匙,代碼流程是繼續(xù)還是停止允趟。
健壯性
健壯性是指軟件對(duì)于規(guī)范要求以外的輸入情況的處理能力。所謂健壯的系統(tǒng)是指對(duì)規(guī)范要求以外的輸入能夠判斷出這個(gè)輸入不符合規(guī)范要求鸦致,并能有合理的處理方式潮剪。
魯棒性
魯棒是Robust的音譯,也就是健壯和強(qiáng)壯的意思分唾。所謂“魯棒性”抗碰,是指控制系統(tǒng)在一定(結(jié)構(gòu),大姓狼恰)的參數(shù)攝動(dòng)下弧蝇,維持某些性能的特性。根據(jù)對(duì)性能的不同定義迄汛,可分為穩(wěn)定魯棒性和性能魯棒性捍壤。以閉環(huán)系統(tǒng)的魯棒性作為目標(biāo)設(shè)計(jì)得到的固定控制器稱為魯棒控制器。
魯棒性(robustness)就是系統(tǒng)的健壯性鞍爱。它是指一個(gè)程序中對(duì)可能導(dǎo)致程序崩潰的各種情況都充分考慮到鹃觉,并且作相應(yīng)的處理,在程序遇到異常情況時(shí)還能正常工作睹逃,而不至于死機(jī)盗扇。
失敗設(shè)計(jì)思維
失敗設(shè)計(jì)思維是魯棒性中很好的思維,該思維要貫穿代碼生命周期始終沉填,把失敗當(dāng)作代碼設(shè)計(jì)中合理存在疗隶,提前準(zhǔn)備好從運(yùn)行失敗的場(chǎng)景中恢復(fù)。倡導(dǎo)防御式編程思想翼闹,拒絕契約式編程斑鼻。入?yún)⑴锌铡⒂行詸z驗(yàn)猎荠。系統(tǒng)設(shè)計(jì)時(shí)識(shí)別弱依賴坚弱,并針對(duì)性地設(shè)計(jì)降級(jí)、限流等應(yīng)急預(yù)案关摇,保證核心邏輯正郴囊叮可用。在考慮主干功能的同時(shí)输虱,要充分考慮評(píng)估異常流程與業(yè)務(wù)邊界些楣。
高內(nèi)聚/低耦合
軟件設(shè)計(jì)中通常用耦合度和內(nèi)聚度作為衡量模塊獨(dú)立程度的標(biāo)準(zhǔn)。劃分模塊的一個(gè)準(zhǔn)則就是高內(nèi)聚低耦合。
耦合性
耦合性也稱塊間聯(lián)系愁茁。指軟件系統(tǒng)結(jié)構(gòu)中各模塊間相互聯(lián)系緊密程度的一種度量蚕钦。模塊之間聯(lián)系越緊密,其耦合性就越強(qiáng)埋市,模塊的獨(dú)立性則越差冠桃。模塊間耦合高低取決于模塊間接口的復(fù)雜性、調(diào)用的方式及傳遞的信息道宅。
內(nèi)聚性
內(nèi)聚性又稱塊內(nèi)聯(lián)系。指模塊的功能強(qiáng)度的度量胸蛛,即一個(gè)模塊內(nèi)部各個(gè)元素彼此結(jié)合的緊密程度的度量污茵。若一個(gè)模塊內(nèi)各元素(語名之間、程序段之間)聯(lián)系的越緊密葬项,則它的內(nèi)聚性就越高泞当。
耦合性與內(nèi)聚性是模塊獨(dú)立性的兩個(gè)定性標(biāo)準(zhǔn),將軟件系統(tǒng)劃分模塊時(shí)民珍,盡量做到高內(nèi)聚低耦合襟士,提高模塊的獨(dú)立性,為設(shè)計(jì)高質(zhì)量的軟件結(jié)構(gòu)奠定基礎(chǔ)嚷量。
參考文章
https://www.zhihu.com/question/304499849/answer/1926930568
https://www.zhihu.com/question/30948927/answer/1968677650