1. 程式人生 > >「C++ 」借來的資源,何如還的瀟灑?

「C++ 」借來的資源,何如還的瀟灑?

前言

本文的內容將專門對付記憶體管理,培養起有借有還的好習慣,方可消除資源管理的問題。


正文

所謂的資源就是,一旦用了它,將來必須還給系統。如果不是這樣,糟糕的事情就會發生。

C++ 程式內常見的資源:

  • 動態分配記憶體
  • 檔案描述符
  • 互斥鎖
  • 圖形頁面中的字型和筆刷
  • 資料庫連線
  • 網路 sockets

無論哪一種資源,重要的是,當你不再使用它時,必須將它還給系統,有借有還是個好習慣。

細節 01 : 以物件管理資源

把資源放在解構函式,交給解構函式釋放資源

假設某個 class 含有個工廠函式,該函式獲取了物件的指標:

A* createA();    // 返回指標,指向的是動態分配物件。
                 // 呼叫者有責任刪除它。

如上述註釋所言,createA 的呼叫端使用了函式返回的物件後,有責任刪除它。現在考慮有個f函式履行了這個責任:

void f()
{
    A *pa = createA();  // 呼叫工廠函式
    ...                 // 其他程式碼
    delete pa;          // 釋放資源
}

這看起來穩妥,但存在若干情況f函式可能無法執行到delete pa語句,也就會造成資源洩漏,例如如下情況:

  • 或許因為「…」區域內的一個過早的 return 語句;
  • 或許因為「…」區域內的一個迴圈語句過早的continue 或 goto 語句退出;
  • 或許因為「…」區域內的語句丟擲異常,無法執行到 delete。

當然可以通過謹慎地編寫程式可以防止這一類錯誤,但你必須想想,程式碼可能會在時間漸漸過去後被修改,如果是一個新手沒有注意這一類情況,那必然又會再次有記憶體洩漏的可能性。

為確保 A 返回的資源都是被回收,我們需要將資源放進物件內,當物件離開作用域時,該物件的解構函式會自動釋放資源。

「智慧指標」是個好幫手,交給它去管理指標物件。

對於是由動態分配(new)於堆記憶體的物件,指標物件離開了作用域並不會自動呼叫解構函式(需手動delete),為了讓指標物件能像普通物件一樣,離開作用域自動呼叫解構函式回收資源,我們需要藉助「智慧指標」的特性。

常用的「智慧指標」有如下三個:

  • std::auto_ptr( C++ 98 提供、C++ 11 建議摒棄不用 )
  • std::unique_ptr( C++ 11 提供 )
  • std::shared_ptr( C++ 11 提供 )
std::auto_ptr

下面示範如何使用 std::auto_ptr 以避免 f 函式潛在的資源洩漏可能性:

void f()
{
    std::auto_ptr<A> pa (createA()); // 呼叫工廠函式
    ...  // 一如既往的使用pa
}        // 離開作用域後,經由 auto_ptr 的解構函式自動刪除pa;

這個簡單的例子示範「以物件管理資源」的兩個關鍵想法:

  • 獲得資源後立刻放進管理物件內。以上程式碼中 createA 返回的資源被當做其管理者 auto_ptr 的初值,也就立刻被放進了管理物件中。
  • 管理物件運用解構函式確保資源釋放。不論控制流如何離開區塊,一旦物件被銷燬(例如當物件離開作用域)其解構函式自然會被自動呼叫,於是資源被釋放。

為什麼在 C++11 建議棄用 auto_ptr 嗎?當然是 auto_ptr 存在缺陷,所以後續不被建議使用。

auto_ptr 有一個不尋常的特質:若通過「複製建構函式或賦值操作符函式」 copy 它們,它們會變成 null ,而複製所得的指標將獲取資源的唯一擁有權!
見如下例子說明:

std::auto_ptr<A> pa1(createA()); // pa1 指向 createA 返回物

std::auto_ptr<A> pa2(pa1); // 現在 pa2 指向物件,pa1將被設定為 null

pa1 = pa2; // 現在 pa1 指向物件,pa2 將被設定為 null

這一詭異的複製行為,如果再次使用指向為 null 的指標,那必然會導致程式奔潰。
意味著 auto_ptr 並非管理動態分配資源的神兵利器。

std::unique_ptr

unique_ptr 也採用所有權模型,但是在使用時,是直接禁止通過複製建構函式或賦值操作符函式 copy 指標物件,如下例子在編譯時,會出錯:

std::unique_ptr<A> pa1(createA()); // pa1 指向 createA 返回物

std::unique_ptr<A> pa2(pa1); // 編譯出錯!

pa1 = pa2; // 編譯出錯!
std::shared_ptr

shared_ptr 在使用複製建構函式或賦值操作符函式後,引用計會數累加並且兩個指標物件指向的都是同一個塊記憶體,這就與 unique_ptr、auto_ptr 不同之處。

void f()
{
    std::shared_ptr<A> pa1(createA()); // pa1 指向 createA 返回物

    std::shared_ptr<A> pa2(pa1); // 引用計數+1,pa2和pa1指向同一個記憶體

    pa1 = pa2; // 引用計數+1,pa2和pa1指向同一個記憶體
}

當一個物件離開作用域,shared_ptr 會把引用計數值 -1 ,直到引用計數值為 0 時,才會進行刪除物件。

由於 shared_ptr 釋放空間時會事先要判斷引用計數值的大小,因此不會出現多次刪除一個物件的錯誤。

小結 - 請記住

  • 為防止資源洩漏,請使用 RAII(Resource Acquisition Is Initaliaztion - 資源取得時機便是初始化時機) 物件,它們在建構函式中獲取資源,並在解構函式中是釋放資源
  • 兩個建議使用的 RAII classes 分別是 std::unique_ptr 和 std::shared_ptr。前者不允許 copy 動作,後者允許 copy 動作。但是不建議用 std::auto_ptr,若選 auto_ptr,複製動作會使它(被複制物)指向 null 。

細節 02:在資源管理類中小心 copying 行為

假設,我們使用 C 語音的 API 函式處理型別為 Mutex 的互斥物件,共有 lock 和 unlock 兩函式可用:

void locak(Mutex *pm);  // 鎖定 pm 所指的互斥器
void unlock(Mutex* pm); // 將互斥器解除鎖定

為確保絕不會忘記一個被鎖住的 Mutex 解鎖,我們可能會希望創立一個 class 來管理鎖資源。這樣的 class 要遵守 RAII 守則,也就是「資源在構造期間獲得,在析構釋放期間釋放」:

class Lock
{
public:
    explicit Lock(Mutex *pm) // 建構函式
        : pMutex(pm)
    {
        lock(pMutex);
    }

    ~Lock()  // 解構函式
    {
        unlock(pMutex);
    }
private:
    Mutex* pMutex;
};

這樣定義的 Lock,用法符合 RAII 方式:

Mutex m;      //定義你需要的互斥鎖
... 
{                 // 建立一個區域性區塊作用域
    Lock m1(&m);  // 鎖定互斥器
    ...
}                 // 在離開區塊作用域,自動解除互斥器鎖定

這很好,但如果 Lock 物件被複制,會發生什麼事情?

Lock m1(&m);  // 鎖定m
Lock m2(&m1); // 將 m1 複製到 m2身上,這會發生什麼?

這是我們需要思考和麵對的:「當一個 RAII 物件被複制,會發生什麼事情?」大多數時候你會選擇以下兩種可能:

  • 禁止複製。如果 RAII 不允許被複制,那我們需要將 class 的複製建構函式和賦值操作符函式宣告在 private。
  • 使用引用計數法。有時候我們希望保有資源,直到它直的最後一個物件被消耗。這種情況下複製 RAII 物件時,應該將資源的「被引用數」遞增。std::shared_ptr 便是如此。

如果前述的 Lock 打算使用使用引用計數法,它可以使用 std::shared_ptr 來管理 pMutex 指標,然後很不幸 std::shared_ptr 的預設行為是「當引用次數為 0 時刪除其所指物」那不是我們想要的行為,因為要對 Mutex 釋放動作是解鎖而非刪除。

幸運的是 std::shared_ptr 允許指定自定義的刪除方式,那是一個函式或函式物件。如下:

class Lock
{
public:
    explicit Lock(Mutex *pm)  
        : pMutex(pm, unlock)  // 以某個 Mutex 初始化 shared_ptr,
                              // 並以 unlock 函式為刪除器。
    {
        lock(pMutex.get());  // get 獲取指標地址
    }

private:
    std::shared_ptr<Mutex> pMutex; // 使用 shared_ptr
};

請注意,本例的 Lock class 不再宣告解構函式。因為編譯器會自動創立預設的解構函式,來自動呼叫其 non-static 成員變數(本例為 pMutex )的解構函式。

而 pMutex 的解構函式會在互斥器的引用次數為 0 時,自動呼叫 std::shared_ptr 的刪除器(本例為 unlock )。

小結 - 請記住

  • 複製 RAII 物件必須一併複製它的所管理的資源(深拷貝),所以資源的 copying 行為決定 RAII 物件的 copying 行為。
  • 普通而常見的 RAII class copying 行為是:禁止 copying、施行引用計數法。

細節 03 :在資源類中提供對原始資源的訪問

智慧指標「顯式」轉換,也就是通過 get 成員函式的方式轉換為原始指標物件。

上面提到的「智慧指標」分別是:std::auto_ptr、std::unique_ptr、std::shared_ptr。它們都有訪問原始資源的辦法,都提供了一個 get 成員函式,用來執行顯式轉換,也就是它會返回智慧指標內部的原始指標(的復件)。

舉個例子,使用智慧指標如 std::shared_ptr 儲存 createA() 返回的指標物件 :

std::shared_ptr<A> pA(createA());

假設你希望以某個函式處理 A 物件,像這樣:

int getInfo(const A* pA);

你想這麼呼叫它:

std::shared_ptr<A> pA(createA());
getInfo(pA);       // 錯誤!!

會編譯錯誤,因為 getInfo 需要的是 A 指標物件,而不是型別為 std::shared_ptr<A> 的物件。

這時候就需要用 std::shared_ptr 智慧指標提供的 get 成員函式訪問原始的資源:

std::shared_ptr<A> pA(createA());
getInfo(pA.get());   // 很好,將 pA 內的原始指標傳遞給 getInfo

智慧指標「隱式」轉換的方式,是通過指標取值操作符。

智慧指標都過載了指標取值操作符(operator->和operator*),它們允許隱式轉換至底部原始指標:

class A
{
public:
    bool isExist() const;
    ...
};

A* createA();  // 工廠函式,建立指標物件

std::shared_ptr<A> pA(createA()); // 令 shared_ptr 管理物件資源

bool exist = pA->isExist();    // 經由 operator-> 訪問資源
bool exist2 = (*pA).isExist(); // 經由 operator* 訪問資源

多數設計良好的 classes 一樣,它隱藏了程式設計師不需要看到的部分,但是有程式設計師需要的所有東西。

所以對於自身設計 RAII classes 我們也要提供一個「取得其所管理的資源」的辦法。

小結 - 請記住

  • APIs 往往要求訪問原始資源,所以每一個 RAII class 應該提供一個「取得其所管理的資源」的辦法。
  • 對原始資源的訪問可能經由顯式轉換或隱式轉換。一般而言顯式轉換比較安全,但隱式轉換比較方便。

細節 04:成對使用 new 和 delete

以下動作有什麼錯?

std::string* strArray = new std::string[100];
...
delete strArray;

每件事情看起來都井然有序。使用了 new,也搭配了對應的 delete。但還是有某樣東西完全錯誤。strArray 所含的 100 個 string 物件中的 99 個不太可能被適當刪除,因為它們的解構函式很可能沒有被呼叫。

當使用 new ,有兩件事發生:

  • 記憶體被分配出來(通過名為 operator new 的函式)
  • 針對此記憶體會有一個或多個建構函式被呼叫

當使用 delete,也會有兩件事情:

  • 針對此記憶體會有一個或多個解構函式被呼叫
  • 然後記憶體才被釋放(通過名為 operator delete 的函式)

delete 的最大問題在於:即將被刪除的記憶體之內究竟有多少物件?這個答案決定了需要執行多少個解構函式。

物件陣列所用的記憶體通常還包括「陣列大小」的記錄,以便 delete 知道需要呼叫多少次解構函式。單一物件的記憶體則沒有這筆記錄。你可以把兩者不同的記憶體佈局想象如下,其中 n 是陣列大小:

當你對著一個指標使用 delete,唯一能夠讓 delete 知道記憶體中是否存在一個「陣列大小記錄」的辦法就是:由你告訴它。如果你使用 delete 時加上中括號[],delete 便認定指標指向一個數組,否則它便認定指標指向一個單一物件:

std::string* strArray = new std::string[100];
std::string* strPtr = new std::strin;
... 
delete [] strArray;  // 刪除一個物件
delete strPtr;       // 刪除一個由物件組成的陣列

遊戲規則很簡單:

  • 如果你在 new 表示式中使用[],必須在相應的 delete 表示式也使用[]。
  • 如果你在 new 表示式中不使用[],一定不要在相應的 delete 表示式使用[]。

小結 - 請記住

  • 如果你在 new 表示式中使用[],必須在相應的 delete 表示式也使用[]。如果你在 new 表示式中不使用[],一定不要在相應的 delete 表示式使用[]。

細節 05:以獨立語句將 newed (已被 new 的)物件置入智慧指標

假設我們有個以下示範的函式:

int getNum();
void fun(std::shared_ptr<A> pA, int num);

現在考慮呼叫 fun:

fun(new A(), getNum());

它不能通過編譯,因為 std::shared_ptr 建構函式需要一個原始指標,而且該建構函式是個 explicit 建構函式,無法進行隱式轉換。如果寫成這樣就可以編譯通過:

fun(std::shared_ptr<A>(new A), getNum());

令人想不到吧,上述呼叫卻可能洩露資源。接下來我們來一步一步的分析為什麼存在記憶體洩漏的可能性。

在進入 fun 函式之前,肯定會先執行各個實參。上述第二個實參只是單純的對 getNum 函式的呼叫,但第一個實參 std::shared_ptr<A>(new A) 由兩部分組成:

  • 執行 new A 表示式
  • 呼叫 std::shared_ptr 建構函式

於是在呼叫 fun 函式之前,先必須做以下三件事:

  • 呼叫 getNum 函式
  • 執行 new A 表示式
  • 呼叫 std::shared_ptr 建構函式

那麼他們的執行次序是一定如上述那樣的嗎?可以確定的是 new A 一定比 std::shared_ptr 建構函式先被執行。但對 getNum 呼叫可以排在第一或第二或第三執行。

如果編譯器選擇以第二順位執行它:

  1. 執行 new A 表示式
  2. 呼叫 getNum 函式
  3. 呼叫 std::shared_ptr 建構函式
    萬一在呼叫 getNum 函式發生了異常,會發生什麼事情?在此情況下 new A 返回的指標將不會置入 std::shared_ptr 智慧指標裡,就存在記憶體洩漏的現象。

避免這類問題的辦法很簡單:使用分離語句。

分別寫出:

  1. 建立 A
  2. 將它置入一個智慧指標內
  3. 然後再把智慧指標傳遞給 fun 函式。
std::shared_ptr<A> pA(new A); // 先構造智慧指標物件
fun(pA, getNum()); // 這個呼叫動作絕不至於造成洩漏。

以上的方式,就能避免原本由於次序導致記憶體洩漏發生。

小結 - 請記住

  • 以獨立語句將 newed (已 new 過) 物件儲存於智慧指標內。如果不這樣做,一旦異常被丟擲,有可能導致難以察覺的資源洩漏。

最後

本文部分內容參考了《Effective C++ (第3版本)》第三章節內容,前兩章節的內容可看舊文
《學過 C++ 的你,不得不知的這 10 條細節!》


關注公眾號,後臺回覆「我要學習」,即可免費獲取精心整理「伺服器 Linux C/C++ 」成長路程(書籍資料 + 思維導圖)