前面翻譯的一篇文章《使用錯誤代碼物件進行C++錯誤處理》中提到,作者的靈感來源于另一篇檔案《捕獲未經測驗的回傳值》,于是再把這篇文章翻譯過來,做為對比,也算是形成一個系列的文章,

前言
函式回傳值通常用于表函式是否在沒有錯誤的情況下執行,但是,很難確保呼叫者適當地使用這些資訊(指回傳值),也許一些商業工具可以完成這項作業,但你并不總是能獲得購買許可,特別是在小型專案中,你很有可能聽到過這樣說:“我相信你,你不會犯這樣的錯誤,”
我在這里提出的想法,是受到幾周前我們在專案中出現的一個錯誤的啟發,它只出現在一個生產環境中,花了幾天的時間才發現,它來自于一個特定環境的初始化例程的失敗,實際上,呼叫此例程的代碼沒有測驗其回傳代碼,
添加責任標志
在我的經驗中(但不是很長時間),我經常看到函式返會是按型別分組成一個列舉,如圖1所示,呼叫者可以或多或少忽略此類回傳值,為了控制回傳值發生了什么,我不直接回傳這些值,而是回傳類ErrorCode的實體,它包含兩個成員變數:值(enValue_)指示函式錯誤代碼,責任標志(PboResp_):
class ErrorCode
{
private:
ErrorCodeValue enValue_;
bool * PboResp_;
public:
// some code
}
責任標志的目的是表明是否需要對ErrorCode物件的值負責(指是否需要檢查),當ErrorCode物件使用拷貝建構式或賦值函式拷貝物件時,值(enValue_)被拷貝,同時責任標志PboResp_中包含的責任需要“轉移”,所謂“轉移”,是指拷貝操作將責任從源實體轉移到目標實體,復制后,源實體不再負責其內容(即呼叫者不再需要檢查),(實際上,拷貝建構式的語意與賦值函式略有不同,但總體思路是相同的,下文詳解,)
因為拷貝建構式和賦值函式的引數使用const修飾符,我選擇將責任標志PboResp_實作為一個指向布林值的指標,而不是一個布林值,這使拷貝函式能夠修改作為引數傳遞進來的源實體的責任標志PboResp_,還有另一個適用于運算子=約束:如果引數ErrorCode物件的責任標志PboResp_是true,使之前值enValue_會丟失,必須要記錄(指輸出日志),(此處描述的責任轉移程序類似于發生在auto_ptr上的復制)
ErrorCode物件還要使用==和!=運算子,與從函式回傳的臨時ErrorCode物件比較時,需要這些運算子,這些臨時ErrorCode物件已被構造成表示特定的錯誤狀態(例如成功),如您所料,這些運算子函式就是比較兩個ErrorCode物件內部的值enValue_,而且,這些ErrorCode物件的責任標志PboResp_也要設定為false,這樣就不會出現“未經測驗的錯誤代碼”的日志記錄,如有需要,其他測驗運算子(<, >)也可以實作,
最后,解構式要檢查實體是否仍然對錯誤代碼值負責(責任標志PboResp_為true),如果存在這種情況就要記錄它,
與現有代碼的集成
在我看來,這項技術的成功取決于它能否很容易地集成到現有的程式中,圖1展示了一種情況,這是一個很好的起點,可以演示如何進行集成,
首先,在類定義時,我使用之前定義的列舉的名稱作為類名(即舊的列舉名是ErrorCode,則新的類名就是ErrorCode),因此,所有之前回傳列舉值的函式,現在都變成回傳一個錯誤碼物件,只要重新編譯程式即可,我還將現在有列舉名ErrorCode改為ErrorCodeValue,要使這項技術真正有效,還必須定義一個ErrorCodeValue作為引數的建構式,此建構式主要在兩種情況下會被隱式呼叫:第一,之前函式是回傳ErrorCodeValue,而不是ErrorCode類的物件,第二,當ErrorCode物件和ErrorCodeValue進行比較(通過運算子==或!=),在這種情況下,會用ErrorCodeValue構造出一個臨時的ErrorCode物件,用作比較運算子的引數,如前所述,比較運算子還“關閉”兩個物件的責任標志(責任標志PboResp_置為true),
實施
圖2顯示錯誤處理的新實作,即使用ErrorCode類,ErrorCode類添加到現有檔案ErrorCodes.h中,此外,還需要創建一個檔案ErrorCodes.cpp,用于實作ErrorCode類的成員函式,
如上所述,拷貝建構式和賦值運算子必須將錯誤代碼的責任轉移到它們的目標物件,但這還不夠,函式必須始終ErrorCode物件,該物件負責其內容,因此,拷貝建構式和接受ErrorCodeValue的建構式,在構建物件時將責任標志PboResp_設定為true(他們無條件地這樣做),這就是rf建構式與賦值運算子的不同之處:賦值運算子把責任標志從源物件復制到目標實體的,拷貝建構式則要設定責任標志為true,
最后,默認建構式與所有其他建構式不同,因為它將責任標志初始化為false,默認構造的ErrorCode物件不表示未經測驗的錯誤代碼,它完全取決于創建它的程式員來決定如何處理它,
增強版的ErrorCode類,可以在解構式和賦值運算子函式中增加斷言,以便在開發和測驗階段攔截“錯誤泄漏”(即知道有哪些錯誤碼沒有檢查),
把新的錯誤碼類在圖1程式中實施,運行后將在標準錯誤輸出上輸出以下訊息:
Destruction of untested error code:
value 1
Untested error code (value 0) erased by
new value 2
結語
我相信這個編碼技巧對于檢測某種型別的錯誤是非常有幫助的,請注意,此方法沒有消除任何錯誤,只是在問題發生后報告未經測驗的回傳代碼,我相信即使在現有的專案中也很容易實作,開始時,你可能會得到一個日志檔案,其中包含大量未經測驗的回傳代碼,因此,在我們的專案中,我們不得不稍微清理一下代碼,
歡迎關注我的公眾號【林哥哥的編程札記】,也歡迎贊賞,謝謝!
![]()
轉載請註明出處,本文鏈接:https://www.uj5u.com/houduan/40799.html
標籤:C++

