¶Code Complete II《軟體建構之道 2》#8 讀書心得與整理

原文連結: https://darkblack01.blogspot.com/2013/02/code-complate-ii-28.html
移植時的最後更新日期: 2013-02-08T11:01:41.930+08:00

第八章 防禦性程式設計
Defensive Programming

8.1 保護程式在無效輸入資料的破壞
Protecting Your Program from Invalid Inputs

1. 重複的設計
2. 程式碼前先寫虛擬碼
3. 程式碼前先寫測試案例
4. 進行低層級設計視察

8.2 判斷提示
Assertions

assert(常式);  //若常式為false，則程式崩潰、印出訊息。

1. 是否滿足定義域和值域
2. 檔案或資料流狀態是否開啟（或關閉）
3. 檔案或資料流讀寫位置是否在開頭（或結尾）
4. 檢查檔案或資料流權限（唯讀、唯寫、可讀寫）。
5. 只能輸入的變數，經過一個常式是否有被改變
6. 指標是否為null
7. 陣列項目數量是否為特定數目
8. 初始化的表格，變數是否都初始化了。
9. 在常式內的容器，是否為空（或滿）
10. 最佳化前後的常式，結果是否一致
11. ....（更多更多的假設）

建立自己的Assertion機制
Building Your Own Assertion Mechanism

//C++ Example of a Assertion Macro
#define Assert( condition, message )\
{\
  if ( !(condition) )\
  {\
    LogError ("Assertion failed: ", #condition, message);\
    exit( EXIT_FAILURE );\
  }\
}

使用Assertions的方針
Guidelines for Using Assertions

//系統預設的code，assert本身並不會在release編譯時成為release版的程式內容
#ifdef _DEBUG
    ASSERT()
#endif

1. 可靠的內部來源，檢查定義域外的值←用Assert(定義域)
2. 外部來源，檢查錯誤格式←錯誤處理的程式碼

1. Assert()
2. 處理錯誤的程式碼

Visual Basic Example of Using Assertion to Document Preconditions and Postconditions
private Function Velocity ( _
    ByRef latitude As Single, _
    ByRef longitude  As Single, _
    ByRef elevation  As Single, _
) As Single

' Preconditions'

Debug.Assert( -90<= latitude And latitude <= 90 )
Debug.Assert( ...)
Debug.Assert( ...)
...
' Sanitize input data. Values should be within the ranges asserted above,'
' but if a value is not within its valid range, it will be changed to the closest legal value'
If  ( latitude < -90 ) Then
     latitude = -90
ElseIf ( latitude > 90 ) then
    latitude = 90
...

8.3 錯誤處理技巧
Error-Handling Techniques

1.     設定狀態變數的值
2.     將狀態回傳，作為常式的回傳值
3.     用程式語言內嵌的例外處理

比較強壯性與正確性
Robustness vs. Correctness

高層次設計的錯誤處理啟示
High-Level Design Implications of Error Processing

8.4 例外狀況
Exceptions

Bad Java Example of Ignoring an Exception
try{
    ...
    //lots of cods
    ...
} catch( AnException exception) {
    //程式執行到這，不會終止，會當作沒有這個例外而繼續執行。
    //可以的話寫個MessageBox或者記錄到檔案中也好。
    //空白的話讓co-work的程式設計不知道這是怎麼一回事
}

• 用Exctption類別裝例外狀況拋出的所有物件。增加使用不同程式碼之間的相容性。
• for專案的個人化Exception
• 定義在特定的情況中，程式碼可用throw-catch語法處理。
• 定義在特定的情況中，程式碼可用throw一個不在local程式碼中處理的exception 。
• 決定是否使用集中的例外狀況報告格式
• 定義在構建式與解構式中，是否存在例外狀況。

• 區域程式處理錯誤
• 使用error code傳播錯誤
• 錯誤記錄到檔案中
• 關閉系統
• 其它

8.5 （防火牆）隔離你的程式，避免錯誤造成損毀
Barricade Your Program to Contain the Damage Caused by Errors

防火牆與判斷提示的關係
Relationship between Barricades and Assertions

8.6 除錯輔助工具
Debugging Aids

不要在debug版程式直接套用release版程式的規範
Don’t Automatically Apply Production Constraints to the Development Version

儘早採用除錯輔助工具
Introduce Debugging Aids Early

1. 遇到了好幾次相同的問題。
2. 初次寫除錯輔助程式
3. 使用之前專案的除錯輔助工具

使用自殺式程式設計（原意：攻擊式程式設計）
Use Offensive Programming

• 確定以assert()中止程式
• 完全填滿記憶體，偵測記憶體配置問題
• 完全填滿分配的檔案，偵測出檔案格式的錯誤
• 確定每個「case陳述式的default」或「else子句」的程式碼能產生錯誤（ex: 中止程式）或無法被忽略。
• 刪除物件前，填入垃圾值，確定它再也用不到。
• 設定程式將錯誤記錄檔以mail的方式寄給自己，以了解release後的軟體中發生的錯誤種類。

計畫性移除錯輔助工具
Plan to Remove Debugging Aids

#define DEBUG
...
#if define( DEBUG )
// debugging code
...
#endif

#define DEBUG
#if define( DEBUG )
#define DebugCode( code_fragment ) { code_fragment }
#else
#define DebugCode( code_fragment )
#endif
...
DebugCode(

    statement 1;
    statement 2;
    statement 3;

);
...

void DoSomething(SOME_TYPE *pointer)
{
    //check parameters passed in
    CheckPoint( pointer );
    ...
}

void CheckPinter( void *pointer )
{
    // perform check 1 -- maybe check that it's not NULL
...
}

void CheckPinter( void *pointer )
{
    // no code
}

8.7 決定實際實執行所採用的防禦性程式設計程式碼
Determining How Much Defensive Programming to Leave in Production Code

8.8 防禦性程式設計的防禦狀態
Being Defensive About Defensive Programming