代碼防御性編程的十條技巧匯總

時(shí)間：2025-01-23 15:44:34

關(guān)鍵字：防御性編程編程策略

手機(jī)看文章

掃描二維碼
隨時(shí)隨地手機(jī)看文章

[導(dǎo)讀]防御性編程是一種編程策略，旨在通過(guò)考慮到各種可能的錯(cuò)誤和異常情況，確保程序在任何情況下都能正常工作。這種方法強(qiáng)調(diào)在編碼過(guò)程中盡可能早地發(fā)現(xiàn)并處理錯(cuò)誤，以避免在運(yùn)行時(shí)出現(xiàn)未預(yù)見(jiàn)的問(wèn)題。

在軟件開(kāi)發(fā)中，編寫(xiě)健壯、穩(wěn)定且易維護(hù)的代碼是每個(gè)開(kāi)發(fā)者的追求。特別是在C++編程中，由于其復(fù)雜性和靈活性，如果沒(méi)有良好的編程習(xí)慣，很容易導(dǎo)致難以調(diào)試和維護(hù)的代碼。因此，防御性編程(Defensive Programming)成為了一個(gè)重要的編程原則。

防御性編程是一種編程策略，旨在通過(guò)考慮到各種可能的錯(cuò)誤和異常情況，確保程序在任何情況下都能正常工作。這種方法強(qiáng)調(diào)在編碼過(guò)程中盡可能早地發(fā)現(xiàn)并處理錯(cuò)誤，以避免在運(yùn)行時(shí)出現(xiàn)未預(yù)見(jiàn)的問(wèn)題。

一、什么是防御性編程?

顧名思義，防御性編程是一種細(xì)致、謹(jǐn)慎的編程方法。為了開(kāi)發(fā)可靠的軟件，我們要設(shè)計(jì)系統(tǒng)中的每個(gè)組件，以使其盡可能的”保護(hù)”自己。我們通過(guò)明確地在代碼中對(duì)設(shè)想進(jìn)行檢查，這是一種努力，防止我們的代碼以將會(huì)展現(xiàn)錯(cuò)誤行為的方式被調(diào)用。

防御性編程是指一種預(yù)見(jiàn)代碼可能出現(xiàn)問(wèn)題并提前采取措施來(lái)防止這些問(wèn)題發(fā)生的編程風(fēng)格。在前端開(kāi)發(fā)中，這尤其重要，因?yàn)槟愕拇a直接與用戶(hù)交互，任何錯(cuò)誤都可能導(dǎo)致糟糕的用戶(hù)體驗(yàn)，甚至安全漏洞。

以下是如何在前端開(kāi)發(fā)中進(jìn)行防御性編程的一些關(guān)鍵策略：

1. 輸入驗(yàn)證:

永遠(yuǎn)不要信任用戶(hù)輸入: 始終驗(yàn)證所有來(lái)自用戶(hù)、API 或其他外部來(lái)源的數(shù)據(jù)。這包括檢查數(shù)據(jù)類(lèi)型、長(zhǎng)度、格式和范圍。

使用合適的驗(yàn)證庫(kù)或工具: 利用現(xiàn)有的庫(kù)或框架提供的驗(yàn)證功能，例如 Joi, Yup, validator.js 等，可以簡(jiǎn)化驗(yàn)證過(guò)程并提高代碼的可讀性。

對(duì)所有輸入進(jìn)行消毒: 防止跨站腳本攻擊 (XSS) 等安全漏洞。使用專(zhuān)門(mén)的庫(kù)或函數(shù)對(duì)輸入進(jìn)行轉(zhuǎn)義或編碼。例如，DOMPurify 可以幫助清理 HTML 輸入。

2. 處理空值和未定義值:

使用可選鏈操作符 (?.) 和空值合并運(yùn)算符 (??) : JavaScript 的這兩個(gè)運(yùn)算符可以有效地處理可能為空或未定義的值，避免出現(xiàn) TypeError。

在訪(fǎng)問(wèn)對(duì)象屬性之前進(jìn)行檢查: 在訪(fǎng)問(wèn)嵌套對(duì)象屬性之前，確保父對(duì)象存在。

為函數(shù)參數(shù)設(shè)置默認(rèn)值: 避免函數(shù)在缺少參數(shù)時(shí)產(chǎn)生意外行為。

3. 錯(cuò)誤處理:

使用 try...catch 塊: 捕獲可能拋出的異常，并提供適當(dāng)?shù)腻e(cuò)誤處理機(jī)制。

記錄錯(cuò)誤信息: 使用 console.error 或?qū)ｉT(mén)的日志記錄工具記錄錯(cuò)誤信息，以便調(diào)試和監(jiān)控。

向用戶(hù)顯示友好的錯(cuò)誤信息: 避免將原始錯(cuò)誤信息直接展示給用戶(hù)，而是提供更易理解和有幫助的提示。

處理異步操作中的錯(cuò)誤: 使用 .catch() 方法捕獲 Promise 或 async/await 函數(shù)中的錯(cuò)誤。

4. 代碼清晰和注釋:

編寫(xiě)清晰易懂的代碼: 使用有意義的變量名和函數(shù)名，并保持代碼簡(jiǎn)潔。

添加必要的注釋: 解釋代碼的邏輯和目的，尤其是在復(fù)雜的代碼塊中。

5. 使用類(lèi)型檢查:

使用 TypeScript 或 Flow: 這些工具可以幫助你在編譯時(shí)發(fā)現(xiàn)類(lèi)型錯(cuò)誤，從而減少運(yùn)行時(shí)錯(cuò)誤的可能性。

6. 測(cè)試:

編寫(xiě)單元測(cè)試和集成測(cè)試: 確保代碼的各個(gè)部分都能正常工作，并能正確地處理各種輸入和邊緣情況。

下面總結(jié)了一些防御性編程的反對(duì)和支持者的意見(jiàn)：

反對(duì)者：

它降低了代碼的效;即使是一個(gè)很小的額外代碼也需要一些額外的執(zhí)行時(shí)間。它對(duì)于一個(gè)函數(shù)來(lái)說(shuō)也許不要緊，但是對(duì)于一個(gè)由10萬(wàn)個(gè)函數(shù)組成的系統(tǒng)，問(wèn)題就變得嚴(yán)重了。

每種防御性的做法都需要一些額外的工作;

支持者：

防御性編程可以節(jié)省大量的調(diào)試時(shí)間，使你可以去做更有意義的事情。

編寫(xiě)可以正常運(yùn)行、只是速度有些慢的代碼，要遠(yuǎn)遠(yuǎn)好過(guò)大多數(shù)時(shí)間都正常運(yùn)行、但是有時(shí)候會(huì)崩潰的代碼。

防御性編程避免了大量的安全性問(wèn)題。

二、防御性編程技巧

2.1 使用好的編碼風(fēng)格和合理的設(shè)計(jì)

采用良好的編碼風(fēng)格，來(lái)防范大多數(shù)編碼錯(cuò)誤。如：

const關(guān)鍵字：

關(guān)鍵字const可以給讀你代碼的人傳達(dá)非常有用的信息。例如，在函數(shù)的形參前添加const關(guān)鍵字意味著這個(gè)參數(shù)在函數(shù)體內(nèi)不會(huì)被修改，屬于輸入?yún)?shù)。

同時(shí)，合理地使用關(guān)鍵字const可以使編譯器很自然的保護(hù)那些不希望被修改的參數(shù)，防止其被無(wú)意的代碼修改，減少bug的出現(xiàn)。

volatile關(guān)鍵字：

在一些并行設(shè)備的硬件寄存器(如狀態(tài)寄存器)，中斷服務(wù)子程序中會(huì)訪(fǎng)問(wèn)到的全局變量以及多線(xiàn)程應(yīng)用中被幾個(gè)任務(wù)共享的變量前使用volatile關(guān)鍵字來(lái)防止編譯優(yōu)化。

static關(guān)鍵字：

函數(shù)體內(nèi)static變量的作用范圍為該函數(shù)體，不同于auto變量，該變量的內(nèi)存只被分配一次，因此其值在下次調(diào)用時(shí)仍維持上次的值。

在模塊內(nèi)的static全局變量可以被模塊內(nèi)的所有函數(shù)訪(fǎng)問(wèn)，但不能被模塊外其它函數(shù)訪(fǎng)問(wèn)。

在模塊內(nèi)的static函數(shù)只可能被這一模塊內(nèi)的其它函數(shù)調(diào)用，這個(gè)函數(shù)的使用范圍被限制在聲明它的模塊內(nèi)。

位操作運(yùn)算中，盡可能使用<<、 >>、 &、|等運(yùn)算符，盡可能少使用/、%、*運(yùn)算符。

變量和函數(shù)的命名要有意義，并且盡可能做到一個(gè)函數(shù)只做一件事情。

多采用面向?qū)ο蟮乃枷雭?lái)編寫(xiě)代碼。

在投入到編碼工作之前，先考慮大體的設(shè)計(jì)方案，這也非常關(guān)鍵。

2.2 不要倉(cāng)促的編寫(xiě)代碼

欲速則不達(dá)，每敲一個(gè)字，都要想清楚你要輸入的是什么。在寫(xiě)每一行時(shí)都三思而后行?？赡軙?huì)出現(xiàn)什么樣的錯(cuò)誤?你是否已經(jīng)考慮了所有可能出現(xiàn)的邏輯分支?放慢速度，有條不紊的編程雖然看上去很平凡，但這的確是減少缺陷的好辦法。

如C語(yǔ)言編程中，追求速度的程序員經(jīng)常會(huì)出現(xiàn)的一個(gè)問(wèn)題就是將==錯(cuò)誤的輸入為=，而有些編譯器并不會(huì)警告，這就會(huì)造成問(wèn)題。

2.3 不要相信任何人

這里是指用懷疑的眼光來(lái)審視所有的輸入和所有的結(jié)果，直到你能證明這段代碼是正確的時(shí)候?yàn)橹埂?

2.4 編碼的目標(biāo)要清晰，而不是簡(jiǎn)潔

簡(jiǎn)單是一種美，不要讓你的代碼過(guò)于復(fù)雜。即編寫(xiě)的代碼一定要邏輯清晰，可讀性強(qiáng)。

2.5 編譯時(shí)打開(kāi)所有警告開(kāi)關(guān)

在你的代碼中產(chǎn)生任何警告信息，都應(yīng)立即修正代碼。要知道警告的出現(xiàn)總是有原因的。即使你認(rèn)為某個(gè)警告無(wú)關(guān)緊要，也不要置之不理。

2.6 使用安全的數(shù)據(jù)結(jié)構(gòu)

我們最常見(jiàn)的一些安全隱患大概是由緩沖溢出引起的。緩沖溢出是由于不正確的使用固定大小的數(shù)據(jù)結(jié)構(gòu)而造成的。例如，如下這個(gè)代碼：

char *unsafe_copy(const char *source)

{

char *buffer = new char[10];

strcpy(buffer,source);

return buffer;

}

123456

如果source中的數(shù)據(jù)長(zhǎng)度超過(guò)10個(gè)字符，它就會(huì)造成其它問(wèn)題。我們可以改成如下形式：

char * safe_copy(const char * source)

{

char *buffer = new char[10];

// 用strncpy代替strcpy可以保護(hù)這個(gè)代碼段

strncpy(buffer,source, 10);

return buffer;

}

1234567

2.7 檢查所有的返回值

如果一個(gè)函數(shù)返回一個(gè)值，他這樣做肯定是有理由的。檢查這個(gè)返回值，如果返回值是一個(gè)錯(cuò)誤代碼，你就必須辨別這個(gè)代碼并處理所有的錯(cuò)誤。不要讓錯(cuò)誤悄無(wú)聲息的侵入你的程序;大多數(shù)難以察覺(jué)的錯(cuò)誤都是因?yàn)槌绦騿T沒(méi)有檢查返回值而出現(xiàn)的。

2.8 審慎的處理內(nèi)存

對(duì)于在執(zhí)行期間所獲取的任何資源，必須徹底釋放。

2.9 在聲明位置初始化所有變量

如果你意外的使用了一個(gè)沒(méi)有初始化的變量，那么你的程序在每次運(yùn)行的時(shí)候都將得到不同的結(jié)果，這取決于當(dāng)時(shí)內(nèi)存中的垃圾信息是什么。這樣會(huì)造成很多隨機(jī)的行為，給查找?guī)?lái)很多的麻煩。因此，需要在聲明每個(gè)變量的時(shí)候就對(duì)它進(jìn)行初始化。

同時(shí)，平時(shí)編碼時(shí)還要注意一些細(xì)則

提供默認(rèn)的行為:Switch語(yǔ)句中將default case的執(zhí)行明示出來(lái)。同樣地，如果你- 要編寫(xiě)一些不帶else子句的if語(yǔ)句，停下來(lái)想一想，你是否該處理這個(gè)邏輯上的默認(rèn)情況

檢查數(shù)值的上下限：確保每次運(yùn)算數(shù)值變量都不會(huì)溢出，即數(shù)據(jù)類(lèi)型的使用要謹(jǐn)慎

注意強(qiáng)制轉(zhuǎn)換是否合理

聲明變量，可以使變量的聲明位置與使用它的位置盡量接近，從而防止它干擾代碼的其他部分

加合理的異常處理、日志文件

正確設(shè)置常量

2.10 優(yōu)秀的程序應(yīng)該做到

關(guān)心代碼是否健壯

確保每個(gè)設(shè)想都顯示地體現(xiàn)在防御性代碼中

希望代碼對(duì)無(wú)用信息的輸入有正確的行為

在編程的時(shí)候認(rèn)真思考自己所編寫(xiě)的代碼