Shuffy

【轉】http://www.shnenglu.com/tiandejian/archive/2007/08/02/ec_25.html
第25條：     最好不要讓交換數值函數 swap 拋出異常

swap 是一個非常有趣的程序。它最早是作為 STL 的一部分引入 C++ 的， 而后就成為了異常安全編程的主體內容（參見第 29 條），另外對于可以自賦值的對象而言它還是一個常用的復制處理機制。由于 swap 如此神通廣大，那么以一個恰當的方式去實現它就顯得十分重要了，但是它的舉足輕重的地位也決定了實現它并不是一件手到擒來的事情。在本小節中，我們就會針對 swap 函數展開探索，逐步掌握如何去駕馭它。

swap 函數的功能是交換兩個對象的值。在默認情況下，交換工作時通過標準的 swap 函數完成的。它的標準實現方式就能完美地完成你所期望的工作：

只要你的類型支持復制（通過拷貝構造函數和拷貝復制運算符），那么默認的 swap 實現就可以讓你的類型的兩個對象互相交換，你不需要做任何具體的工作來支持這一功能。

然而，你可能對默認的 swap 實現保有諸多不滿。它會帶來 3 次對象復制工作： a 復制到 temp ， b 到 a ， temp 到 b 。對于一些類型來說，這些復制操作并不都是必需的。對于這些類型來說，默認的 swap 會成為你程序的桎梏。

上述的那種類型大都符合下面的特征：它的主要成分是一個指針，這一指針會指向另一個類型，真實的數據包含在這另一個類型中。對這一設計方式的一種常見的稱謂是“ pimpl idiom ”（ pointer to implementation ，指向實現的指針，參見第 31 條 ）。比如 Widget 類可以使用這種設計模式。請看下面的代碼：

為了交換兩個 Widget 對象的值，我們所要做的僅僅是交換他們的 pImpl 指針，但是默認的 swap 算法是不可能知道這一切的，它不僅會復制三個 Widget 對象，同時也會復制三個 Widget 對象。這樣做效率太低了。

我們要做的是告訴 std::swap 當交換 Widget 時，執行的交換操作應當僅僅針對它們內部的 pImpl 指針。有一種精確的說法來描述這一方法：將 Widget 特化。下面是基本的思想，盡管以這種方式不能通過編譯：

程序開端的“ template<> ”告訴我們這是 std::swap 的一個完全特化模板，函數名后面的“ <Widget> ”告訴我們 T 被特化為了 Widget 。換種說法，當通用的 swap 模板應用于 Widget 時，應當使用這一具體實現。一般情況下，我們沒有權限去改動 std 名字空間內部的內容，但是我們有權針對我們自己創建的類型（比如 Widget ）來完整地特化標準模板（就像 swap ）。這就是我們所要做的。

然而，就像我說過的，這段代碼是不能通過編譯的。這是因為它嘗試訪問 a 與 b 內部的 pImpl 指針，但是它們是私有的。我們可以將我們的特化函數聲明為友元，但慣例是不一樣的：慣例要求我們讓 Widget 包含一個名為 swap 的公共成員函數，讓這個 swap 進行實際的交換工作美然后特化 std:swap 來調用這一成員函數。

這樣的代碼不僅僅可以通過編譯，而且也與 STL 容器相協調，它不僅僅提供了公有的 swap 成員函數，而且還提供了特化的 std::swap 來調用這些成員函數。

然而，我們不難發現， Widget 和 WidgetImpl 都是類模板，而不是類，似乎我們可以自定義 WidgetImpl 中保存的數據的類型：

將一個 swap 成員函數放入 Widget 中（如果需要，也可以是 WidgetImpl ）仍然十分簡單，但是我們對 std::swap 特化時將會遇到問題。下面是我們希望編寫的代碼：

這樣的代碼看上去完美無瑕，但是它是非法的。因為其中嘗試對一個函數模板（ std::swap ）進行不完全的特化，但是，盡管 C++ 允許對類模板進行不完全特化，但是函數模板就不行了。這一代碼將不能通過編譯（盡管一些編譯器會錯誤的接受）。

當你期望對一個函數模板進行“不完全特化”時，通常的做法非常簡單，就是添加一個該函數的重載。代碼可能是下面的樣子：

一般情況下，重載函數模板是可以的，但是 std 是一個很特殊的名字空間，它的規則也是獨特的。對 std 中的模板進行完全特化是合法的，但是為 std 添加一個新的模板卻是不合法的（類或函數或其他一切都不可以）。 std 的內容是由 C++ 標準化委員會一手確定的，我們無法修改他們所規定的任何形式，只能“望代碼興嘆”。越軌的代碼似乎可以運行，但它們的行為確實不可預知的。如果你希望你的代碼擁有可預知的行為，你就不應該寄希望于在 std 中添加新的內容。

那么應該怎么辦呢？我們仍然需要一種方法來讓其他人通過調用 swap 來訪問我們更加高效的特化版本。答案很簡單。我們仍然可以通過聲明一個非成員函數 swap 來調用成員函數 swap 實現，只要這個非成員函數不是 std::swap 的特化或者重載版本即可。比如說，如果我們所有與 Widget 相關的功能都在名字空間 WidgetStuff 中，那么代碼看上去應該是這樣：

現在，如果任意位置的代碼對兩個 Widget 對象調用了 swap ， C++ 的名字搜尋守則（更具體地說，就是所謂的參數依賴搜尋或 Koenig 搜尋）將會在 WidgetStuff 中查找具體到 Widget 的版本。這恰恰是我們需要的。

由于這種方法針對類或者類模板可以正常運行，所以看上去似乎我們在任何情況下都使用它。但是遺憾的是，我們還是要對于類的 std::swap 進行特化（稍后會交代理由），所以如果你想要在盡可能多的上下文中（你所需要的）調用具體到類的 swap 版本，你就需要在你的類所在的名字空間編寫一個非成員版本的 swap ，同時還需要一個 std::swap 的特化版本。

順便說一下，即使你沒有使用名字空間，上述內容仍然有效（也就是說，你仍需要一個非成員的 swap 去調用成員函數 swap ），但是為什么你要把所有的類、模板、函數、枚舉類型、 enumerant 、 typedef 的名字統統塞進全局名字空間里呢？如果你對編程規范有一點概念的話，都不會這樣做的。

到目前為止我所介紹的一切內容都是以 swap 的作者的角度展開的，但是以一個客戶端程序員的眼光來審視一下 swap 也是很有價值的。假設你正在編寫一個函數模板，這里你需要交換兩個對象的值：

這里應該調用哪一個 swap 呢？ std 中存在一個通用版本，這是你所知道的；另外 std 中可能還有一個針對這一通用版本的特化版本，它可能存在也可能不存在；或者一個模板的版本，它可能存在也可能不存在，它是否在一個名字空間中也不能確定（但可以肯定不在 std 名字空間中）？此時你所希望的是，如果存在一個模板版本的話，就調用它；如果不存在，就返回調用 std 中的通用版本。以下是滿足這一要求的代碼：

當編譯器看到對 swap 的調用時，它們會尋找恰當的 swap 來進行調用。 C++ 的名字搜尋原則確保了在全局或 T 類型所在的名字空間中來查找所有的精確到 T 的 swap 。（舉例說，如果 T 是位于 WidgetStuff 名字空間中的 Widget ，那么編譯器將會使用參數依賴搜尋方式來查找 WidgetStuff 中的 swap 。）如果沒有精確到 T 的 swap 存在，那么編譯器將會使用 std 中的 swap ，多虧了 using 聲明可以使 std::swap 在本函數中可見。然而即使這樣，編譯器也更期望得到一個精確到 T 的 std::swap 的特化版本，而不是未確定類型的模板，因此如果 std::swap 特化為 T 版本，那么這一特化的版本將會得到使用。

因此，調用正確的 swap 十分簡單。你所需要關心的事僅僅是不去限制對它的調用，因為如果這樣做會使 C++ 如何決定去調用函數的方式受到影響。舉例說，如果你用下面的方式調用了 swap ：

你強迫編譯器僅僅去考慮 std 中的 swap （包括所有的模板特化版本），這樣做就排除了得到一個位于其他位置的精確到 T 版本的 swap 的可能，即使它是更加合理的。然而，一些進入誤區的程序員還是會以這種方式限制 swap 的調用，這里你就可以看出，為你的類提供一個 std::swap 的完全特化版本是多么重要：對于那些使用不恰當的編碼風格寫出的代碼（這樣的代碼也存在于一些標準庫的實現當中，如果你感興趣可以自己編寫一些代碼，來幫助這樣的代碼盡可能的提高效率），精確到類的 swap 實現仍然有效。

此刻，我們已經介紹了默認的 swap 、成員 swap 、非成員 swap 、 std::swap 的特化版本，以及對 swap 的調用，現在讓我們來做一個總結。

首先，如果對你的類或者類模板使用默認的 swap 實現能夠得到可以接受的效率，你就不需要做任何事情。任何人想要交換你創建的類型的對象時，都會去調用默認的版本，此時可以正常工作。

其次，如果默認的 swap 實現并不夠高效（大多數情況下意味著你的類或模板正在運用 pimpl idiom ），請按下面步驟進行：

1． 提供一個公用的 swap 成員函數，讓它可以高效的交換你的類型的兩個對象的值。理由將在后面列出，這個函數永遠不要拋出異常。

2． 在你的類或模板的同一個名字空間中提供一個非成員的 swap 。讓它調用你的 swap 成員函數。

3． 如果你正在編寫一個類（而不是類模板），要為你的類提供一個 std::swap 的特化版本。同樣讓它調用你的 swap 成員函數。

最后，如果你正在調用 swap ，要確保使用一條 using 聲明來使 std::swap 對你的函數可見，然后在調用 swap 時，不要做出任何名字空間的限制。

文中還有一處欠缺，那就是本文的標題中的敬告：不要讓 swap 的成員函數版本拋出異常。這是因為 swap 最重要的用途之一就是幫助類（或類模板）來提供異常安全的保證。第 29 條中詳細介紹了這一點，但是這一技術做出了“ swap 的成員函數版本永遠不會拋出異常”這一假設。這一約束僅僅應用于成員函數版本，非成員版本則不受這一限制。這是因為 swap 的默認版本基于拷貝構造和拷貝賦值，而在一般情況下，這兩種函數都可能拋出異常。因此，當你編寫一個自定義版本的 swap 時，在典型情況下你不僅要提供一條更高效的交換對象值的方式，同時你也要提供一個不拋出異常的版本。作為一條一般的守則，這兩條 swap 的特征是相輔相成的，因為高效的 swap 同時也基于內建數據類型的操作（諸如 pimpl idiom 中使用的指針），同時內建數據類型的操作決不會拋出異常。

銘記在心

l 在對你的類型使用 std::swap 時可能會造成效率低下時，可以提供一個 swap 成員函數。確保你的 swap 不要拋出異常。

l 如果你提供了一個 swap 的成員函數，那么同時要提供一個非成員函數 swap 來調用這一成員。對于類而言（而不是模板），還要提供一個 std::swap 的特化版本來調用 swap 成員函數。

l 在調用 swap 時，要為 std::swap 使用一條 using 聲明，然后在調用 swap 時，不要做出名字空間的限制。

l 對用戶自定義類型而言，提供 std 的完全特化版本不成問題，但是決不要嘗試在 std 中添加全新的內容。