【轉(zhuǎn)】http://m.shnenglu.com/tiandejian/archive/2007/09/23/ec_28.html
第28條: 不要返回指向?qū)ο髢?nèi)部部件的“句柄”
假設(shè)你正在設(shè)計(jì)一個(gè)與矩形相關(guān)的應(yīng)用程序。每個(gè)矩形的區(qū)域都由它的左上角和右下角的坐標(biāo)來(lái)表示。為了 讓 Rectangle 對(duì)象盡可能的小巧,你可能會(huì)做出這樣的決定: Rectangle 自身并不保存這些點(diǎn)的坐標(biāo)的信息,取而代之的是將這些信息保存在一個(gè)輔助結(jié)構(gòu)中,然后讓 Rectangle 指向它:
class Point { // 表示點(diǎn)的類
public:
Point(int x, int y);
...
void setX(int newVal);
void setY(int newVal);
...
};
struct RectData { // 供 Rectangle 類使用的點(diǎn)的數(shù)據(jù)
Point ulhc; // ulhc = " 左上角點(diǎn)的坐標(biāo)
Point lrhc; // lrhc = " 右下角點(diǎn)的坐標(biāo) "
};
class Rectangle {
...
private:
std::tr1::shared_ptr<RectData> pData;
// 關(guān)于 tr1::shared_ptr 請(qǐng)參見第 13 條
};
因?yàn)?/span> Rectangle 的客戶端程序員可能需要了解矩形的區(qū)域,所以這個(gè)類就應(yīng)該提供 upperLeft 和 lowerRight 函數(shù)。然而, Point 卻是一個(gè)用戶自定義的類型,因此你可能會(huì)回憶起第 20 條的經(jīng)驗(yàn):通過引用傳遞用戶自定義類型的對(duì)象要比直接傳值更高效,這些函數(shù)可以返回引用來(lái)指向更底層的 Point 對(duì)象:
class Rectangle {
public:
...
Point& upperLeft() const { return pData->ulhc; }
Point& lowerRight() const { return pData->lrhc; }
...
};
這樣的設(shè)計(jì)可以通過編譯,但是它卻是錯(cuò)誤的。實(shí)際上,它是自我矛盾的。另外,由于 upperLeft 和 lowerRight 的設(shè)計(jì)初衷僅僅是為客戶端程序員提供一個(gè)途徑來(lái)了解 Rectangle 的兩個(gè)頂點(diǎn)坐標(biāo)在哪里,而不是讓客戶端程序員去修改它,因此這兩個(gè)函數(shù)應(yīng)聲明為 const 成員函數(shù)。另外,這兩個(gè)函數(shù)都返回指向私有內(nèi)部數(shù)據(jù)的引用——通過這些引用,調(diào)用者可以任意修改內(nèi)部數(shù)據(jù)!請(qǐng)看下邊的示例:
Point coord1(0, 0);
Point coord2(100, 100);
const Rectangle rec(coord1, coord2);// rec 是一個(gè) Rectangle 常量
// 兩頂點(diǎn)是 (0, 0), (100, 100)
rec.upperLeft().setX(50); // 但現(xiàn)在 rec 的兩頂點(diǎn)卻變?yōu)?/span>
// (50, 0), (100, 100)!
upperLeft 返回了 rec 內(nèi)部的 Point 數(shù)據(jù)成員,在這里請(qǐng)注意:雖然 rec 本身應(yīng)該是 const 的,但是調(diào)用者竟可以使用 upperLeft 所返回的引用來(lái)修改這個(gè)數(shù)據(jù)成員!
上面的現(xiàn)象立刻引出了兩個(gè)議題:首先,數(shù)據(jù)成員僅僅與訪問限制最為寬泛的函數(shù)擁有同等的封裝性。在這種情況下,即使 ulhc 和 lrhc 聲明為私有的,它們實(shí)際上仍然是公共的,這是因?yàn)楣埠瘮?shù) upperLeft 和 lowerRight 返回了指向它們的引用。其次,如果一個(gè) const 成員函數(shù)返回一個(gè)引用,這一引用指向的數(shù)據(jù)與一個(gè)對(duì)象相關(guān),但這一數(shù)據(jù)卻保存在該對(duì)象以外,那么函數(shù)的調(diào)用者就可以修改這一數(shù)據(jù)。(這樣恰巧超出了按位恒定的范疇——參見第 3 條。)
我們所做的一切都與返回引用的成員函數(shù)有關(guān),但是如果它們返回的是指針或者迭代器,同樣的問題仍然會(huì)因?yàn)橥瑯拥睦碛砂l(fā)生。引用、指針、迭代器都可以稱作“句柄”(獲取其它對(duì)象的渠道),返回一個(gè)指向?qū)ο髢?nèi)部部件的句柄,通常都會(huì)危及到對(duì)象的封裝性。就像我們看到的,即使成員函數(shù)是 const 的,返回對(duì)象的狀態(tài)也是可以任意更改的。
大體上講,對(duì)象的“內(nèi)部部件”主要是它的數(shù)據(jù)成員,但是非公用的成員函數(shù)同樣也是對(duì)象的內(nèi)部部件。與數(shù)據(jù)成員相同,返回指向成員函數(shù)的句柄也是糟糕的設(shè)計(jì)。這意味著你不應(yīng)該讓一個(gè)公用成員函數(shù) A 返回一個(gè)指向非公用成員函數(shù) B 的指針。如果你這樣做了, B 的訪問權(quán)層次就與 A 一樣了,這是因?yàn)榭蛻舳顺绦騿T將能夠取得 B 的指針,然后通過這一指針來(lái)調(diào)用它。
索性的是,返回指向成員函數(shù)指針的函數(shù)并不常見,所以讓我們還是把精力放在 Rectangle 類和他的 upperLeft 和 lowerRight 成員函數(shù)上來(lái)吧。我們所發(fā)現(xiàn)的關(guān)于這些函數(shù)所存在的兩個(gè)問題都可以簡(jiǎn)單的解決,只要將它們的返回值限定為 const 的就可以了:
class Rectangle {
public:
...
const Point& upperLeft() const { return pData->ulhc; }
const Point& lowerRight() const { return pData->lrhc; }
...
};
使用這一改進(jìn)的設(shè)計(jì)方案,客戶端程序員就可以讀取用來(lái)定義一個(gè)矩形的兩個(gè)點(diǎn),但是他們不可以修改這兩個(gè)點(diǎn)。這就意味著將 upperLeft 和 lowerRight 聲明為 const 的并不是一個(gè)假象,因?yàn)樗鼈儗⒉辉试S調(diào)用者來(lái)修改對(duì)象的狀態(tài)。至于封裝問題,我們一直堅(jiān)持讓客戶端程序員能能夠看到構(gòu)造一個(gè) Rectangle 的兩個(gè) Point ,所以說這里我們故意放松了封裝的限制。更重要的是,這一放松是有限的:這些函數(shù)僅僅提供了讀的訪問權(quán)限。寫權(quán)限仍然是禁止的。
class GUIObject { ... };
const Rectangle boundingBox(const GUIObject& obj);
// 以傳值方式返回一個(gè)矩形。關(guān)于返回值為什么是 const 的,請(qǐng)參見第 3 條
現(xiàn)在請(qǐng)考慮一下客戶端程序員可能怎樣來(lái)使用這個(gè)函數(shù):
GUIObject *pgo; // 讓 pgo 指向某個(gè) GUIObject
const Point *pUpperLeft = &(boundingBox(*pgo).upperLeft());
// 取得一個(gè)指向 boundingBox 左上角點(diǎn)的指針
調(diào)用 boundingBox 將會(huì)返回一個(gè)新的、臨時(shí)的 Retangle 對(duì)象。這個(gè)對(duì)象沒有名字,所以姑且叫它 temp 。隨后 temp 將調(diào)用 upperLeft ,然后此次調(diào)用將返回一個(gè)指向 temp 內(nèi)部部件的引用,特別地,指向構(gòu)造 temp 的一個(gè)點(diǎn)。 pUpperleft 將會(huì)指向這一 Point 對(duì)象。到目前為止一切都很完美,但是任務(wù)尚未完成,因?yàn)樵谶@一語(yǔ)句的最后, boundingBox 的返回值—— temp ——將會(huì)被銷毀,這樣間接上會(huì)導(dǎo)致 temp 的 Point 被銷毀掉。于是, pUpperLeft 將會(huì)指向一個(gè)并不存在的對(duì)象。這條語(yǔ)句創(chuàng)建了 pUpperLeft ,可也讓它成了孤魂野鬼。
為什么說:任何返回指向?qū)ο髢?nèi)部部件句柄的函數(shù)都是危險(xiǎn)的,這個(gè)問題已經(jīng)一目了然了。至于句柄是指針還是引用還是迭代器,函數(shù)是否是 const 的,成員函數(shù)返回的句柄本身是不是 const 的,這一切都無(wú)關(guān)緊要。只有一點(diǎn),那就是:只要返回了一個(gè)句柄,那么就意味著你正在承擔(dān)風(fēng)險(xiǎn):它可能會(huì)比它指向的對(duì)象存活更長(zhǎng)的時(shí)間。
這并不意味著你永遠(yuǎn)也不能讓一個(gè)成員函數(shù)返回一個(gè)句柄。有些時(shí)候你不得不這樣做。比如說, operator[] 允許你獲取 string 和 vector 中的任一元素,這些 operator[] 的工作就是通過返回容器內(nèi)部的數(shù)據(jù)來(lái)完成的(參見第 3 條)——當(dāng)容器本身被銷毀時(shí),這些數(shù)據(jù)同時(shí)也會(huì)被銷毀。然而,這僅僅是一個(gè)例外,不是慣例。
銘記在心
l 避免返回指向?qū)ο髢?nèi)部部件的句柄(引用、指針或迭代器)。這樣做可以增強(qiáng)封裝性,幫助 const 成員函數(shù)擁有更加“ const ”的行為,并且使“野句柄”出現(xiàn)的幾率降至最低。