第6章 函數(shù)設(shè)計(jì)
函數(shù)是C++/C程序的基本功能單元，其重要性不言而喻。函數(shù)設(shè)計(jì)的細(xì)微缺點(diǎn)很容易導(dǎo)致該函數(shù)被錯(cuò)用，所以光使函數(shù)的功能正確是不夠的。本章重點(diǎn)論述函數(shù)的接口設(shè)計(jì)和內(nèi)部實(shí)現(xiàn)的一些規(guī)則。
函數(shù)接口的兩個(gè)要素是參數(shù)和返回值。C語(yǔ)言中，函數(shù)的參數(shù)和返回值的傳遞方式有兩種：值傳遞（pass by value）和指針傳遞（pass by pointer）。C++ 語(yǔ)言中多了引用傳遞（pass
by reference）。由于引用傳遞的性質(zhì)象指針傳遞，而使用方式卻象值傳遞，初學(xué)者常常迷惑不解，容易引起混亂，請(qǐng)先閱讀6.6節(jié)“引用與指針的比較”。
6.1 參數(shù)的規(guī)則
l
【規(guī)則6-1-1】參數(shù)的書寫要完整，不要貪圖省事只寫參數(shù)的類型而省略參數(shù)名字。如果函數(shù)沒有參數(shù)，則用void填充。
例如：
void SetValue(int width, int height); // 良好的風(fēng)格
void SetValue(int, int); // 不良的風(fēng)格
float GetValue(void); // 良好的風(fēng)格
float GetValue(); // 不良的風(fēng)格
l
【規(guī)則6-1-2】參數(shù)命名要恰當(dāng)，順序要合理。
例如編寫字符串拷貝函數(shù)StringCopy，它有兩個(gè)參數(shù)。如果把參數(shù)名字起為str1和str2，例如
void StringCopy(char *str1, char *str2);
那么我們很難搞清楚究竟是把str1拷貝到str2中，還是剛好倒過來(lái)。
可以把參數(shù)名字起得更有意義，如叫strSource和strDestination。這樣從名字上就可以看出應(yīng)該把strSource拷貝到strDestination。
還有一個(gè)問題，這兩個(gè)參數(shù)那一個(gè)該在前那一個(gè)該在后？參數(shù)的順序要遵循程序員的習(xí)慣。一般地，應(yīng)將目的參數(shù)放在前面，源參數(shù)放在后面。
如果將函數(shù)聲明為：
void StringCopy(char *strSource, char
*strDestination);
別人在使用時(shí)可能會(huì)不假思索地寫成如下形式：
char str[20];
StringCopy(str, “Hello World”); // 參數(shù)順序顛倒
l
【規(guī)則6-1-3】如果參數(shù)是指針，且僅作輸入用，則應(yīng)在類型前加const，以防止該指針在函數(shù)體內(nèi)被意外修改。
例如：
void StringCopy(char *strDestination，const char *strSource);
l
【規(guī)則6-1-4】如果輸入?yún)?shù)以值傳遞的方式傳遞對(duì)象，則宜改用“const &”方式來(lái)傳遞，這樣可以省去臨時(shí)對(duì)象的構(gòu)造和析構(gòu)過程，從而提高效率。
²
【建議6-1-1】避免函數(shù)有太多的參數(shù)，參數(shù)個(gè)數(shù)盡量控制在5個(gè)以內(nèi)。如果參數(shù)太多，在使用時(shí)容易將參數(shù)類型或順序搞錯(cuò)。
²
【建議6-1-2】盡量不要使用類型和數(shù)目不確定的參數(shù)。
C標(biāo)準(zhǔn)庫(kù)函數(shù)printf是采用不確定參數(shù)的典型代表，其原型為：
int printf(const chat *format[, argument]…);
這種風(fēng)格的函數(shù)在編譯時(shí)喪失了嚴(yán)格的類型安全檢查。
6.2 返回值的規(guī)則
l
【規(guī)則6-2-1】不要省略返回值的類型。
C語(yǔ)言中，凡不加類型說(shuō)明的函數(shù)，一律自動(dòng)按整型處理。這樣做不會(huì)有什么好處，卻容易被誤解為void類型。
C++語(yǔ)言有很嚴(yán)格的類型安全檢查，不允許上述情況發(fā)生。由于C++程序可以調(diào)用C函數(shù)，為了避免混亂，規(guī)定任何C++/ C函數(shù)都必須有類型。如果函數(shù)沒有返回值，那么應(yīng)聲明為void類型。
l
【規(guī)則6-2-2】函數(shù)名字與返回值類型在語(yǔ)義上不可沖突。
違反這條規(guī)則的典型代表是C標(biāo)準(zhǔn)庫(kù)函數(shù)getchar。
例如：
char c;
c = getchar();
if (c == EOF)
…
按照getchar名字的意思，將變量c聲明為char類型是很自然的事情。但不幸的是getchar的確不是char類型，而是int類型，其原型如下：
int
getchar(void);
由于c是char類型，取值范圍是[-128，127]，如果宏EOF的值在char的取值范圍之外，那么if語(yǔ)句將總是失敗，這種“危險(xiǎn)”人們一般哪里料得到！導(dǎo)致本例錯(cuò)誤的責(zé)任并不在用戶，是函數(shù)getchar誤導(dǎo)了使用者。
l
【規(guī)則6-2-3】不要將正常值和錯(cuò)誤標(biāo)志混在一起返回。正常值用輸出參數(shù)獲得，而錯(cuò)誤標(biāo)志用return語(yǔ)句返回。
回顧上例，C標(biāo)準(zhǔn)庫(kù)函數(shù)的設(shè)計(jì)者為什么要將getchar聲明為令人迷糊的int類型呢？他會(huì)那么傻嗎？
在正常情況下，getchar的確返回單個(gè)字符。但如果getchar碰到文件結(jié)束標(biāo)志或發(fā)生讀錯(cuò)誤，它必須返回一個(gè)標(biāo)志EOF。為了區(qū)別于正常的字符，只好將EOF定義為負(fù)數(shù)（通常為負(fù)1）。因此函數(shù)getchar就成了int類型。
我們?cè)趯?shí)際工作中，經(jīng)常會(huì)碰到上述令人為難的問題。為了避免出現(xiàn)誤解，我們應(yīng)該將正常值和錯(cuò)誤標(biāo)志分開。即：正常值用輸出參數(shù)獲得，而錯(cuò)誤標(biāo)志用return語(yǔ)句返回。
函數(shù)getchar可以改寫成 BOOL GetChar(char *c);
雖然gechar比GetChar靈活，例如 putchar(getchar());
但是如果getchar用錯(cuò)了，它的靈活性又有什么用呢？
²
【建議6-2-1】有時(shí)候函數(shù)原本不需要返回值，但為了增加靈活性如支持鏈?zhǔn)奖磉_(dá)，可以附加返回值。
例如字符串拷貝函數(shù)strcpy的原型：
char *strcpy(char *strDest，const char *strSrc);
strcpy函數(shù)將strSrc拷貝至輸出參數(shù)strDest中，同時(shí)函數(shù)的返回值又是strDest。這樣做并非多此一舉，可以獲得如下靈活性：
char
str[20];
int length = strlen( strcpy(str, “Hello World”)
);
²
【建議6-2-2】如果函數(shù)的返回值是一個(gè)對(duì)象，有些場(chǎng)合用“引用傳遞”替換“值傳遞”可以提高效率。而有些場(chǎng)合只能用“值傳遞”而不能用“引用傳遞”，否則會(huì)出錯(cuò)。
例如：
class String
{…
// 賦值函數(shù)
String
& operate=(const String &other);
// 相加函數(shù)，如果沒有friend修飾則只許有一個(gè)右側(cè)參數(shù)
friend String
operate+( const String &s1, const String &s2);
private:
char
*m_data;
}
String的賦值函數(shù)operate = 的實(shí)現(xiàn)如下：
String &
String::operate=(const String &other)
{
if
(this == &other)
return
*this;
delete
m_data;
m_data
= new char[strlen(other.data)+1];
strcpy(m_data,
other.data);
return
*this; // 返回的是 *this的引用，無(wú)需拷貝過程
}
對(duì)于賦值函數(shù)，應(yīng)當(dāng)用“引用傳遞”的方式返回String對(duì)象。如果用“值傳遞”的方式，雖然功能仍然正確，但由于return語(yǔ)句要把 *this拷貝到保存返回值的外部存儲(chǔ)單元之中，增加了不必要的開銷，降低了賦值函數(shù)的效率。例如：
String
a,b,c;
…
a = b;
// 如果用“值傳遞”，將產(chǎn)生一次 *this 拷貝
a = b
= c; // 如果用“值傳遞”，將產(chǎn)生兩次 *this 拷貝
String的相加函數(shù)operate + 的實(shí)現(xiàn)如下：
String operate+(const String &s1, const String
&s2)
{
String
temp;
delete
temp.data; // temp.data是僅含‘\0’的字符串
temp.data
= new char[strlen(s1.data) + strlen(s2.data) +1];
strcpy(temp.data,
s1.data);
strcat(temp.data,
s2.data);
return
temp;
}
對(duì)于相加函數(shù)，應(yīng)當(dāng)用“值傳遞”的方式返回String對(duì)象。如果改用“引用傳遞”，那么函數(shù)返回值是一個(gè)指向局部對(duì)象temp的“引用”。由于temp在函數(shù)結(jié)束時(shí)被自動(dòng)銷毀，將導(dǎo)致返回的“引用”無(wú)效。例如：
c = a + b;
此時(shí) a + b 并不返回期望值，c什么也得不到，流下了隱患。
6.3 函數(shù)內(nèi)部實(shí)現(xiàn)的規(guī)則
不同功能的函數(shù)其內(nèi)部實(shí)現(xiàn)各不相同，看起來(lái)似乎無(wú)法就“內(nèi)部實(shí)現(xiàn)”達(dá)成一致的觀點(diǎn)。但根據(jù)經(jīng)驗(yàn)，我們可以在函數(shù)體的“入口處”和“出口處”從嚴(yán)把關(guān)，從而提高函數(shù)的質(zhì)量。
l
【規(guī)則6-3-1】在函數(shù)體的“入口處”，對(duì)參數(shù)的有效性進(jìn)行檢查。
很多程序錯(cuò)誤是由非法參數(shù)引起的，我們應(yīng)該充分理解并正確使用“斷言”（assert）來(lái)防止此類錯(cuò)誤。詳見6.5節(jié)“使用斷言”。
l
【規(guī)則6-3-2】在函數(shù)體的“出口處”，對(duì)return語(yǔ)句的正確性和效率進(jìn)行檢查。
如果函數(shù)有返回值，那么函數(shù)的“出口處”是return語(yǔ)句。我們不要輕視return語(yǔ)句。如果return語(yǔ)句寫得不好，函數(shù)要么出錯(cuò)，要么效率低下。
注意事項(xiàng)如下：
（1）return語(yǔ)句不可返回指向“棧內(nèi)存”的“指針”或者“引用”，因?yàn)樵搩?nèi)存在函數(shù)體結(jié)束時(shí)被自動(dòng)銷毀。例如
char * Func(void)
{
char str[] = “hello world”; //
str的內(nèi)存位于棧上
…
return str; // 將導(dǎo)致錯(cuò)誤
}
（2）要搞清楚返回的究竟是“值”、“指針”還是“引用”。
（3）如果函數(shù)返回值是一個(gè)對(duì)象，要考慮return語(yǔ)句的效率。例如
return String(s1 + s2);
這是臨時(shí)對(duì)象的語(yǔ)法，表示“創(chuàng)建一個(gè)臨時(shí)對(duì)象并返回它”。不要以為它與“先創(chuàng)建一個(gè)局部對(duì)象temp并返回它的結(jié)果”是等價(jià)的，如
String temp(s1 + s2);
return temp;
實(shí)質(zhì)不然，上述代碼將發(fā)生三件事。首先，temp對(duì)象被創(chuàng)建，同時(shí)完成初始化；然后拷貝構(gòu)造函數(shù)把temp拷貝到保存返回值的外部存儲(chǔ)單元中；最后，temp在函數(shù)結(jié)束時(shí)被銷毀（調(diào)用析構(gòu)函數(shù)）。然而“創(chuàng)建一個(gè)臨時(shí)對(duì)象并返回它”的過程是不同的，編譯器直接把臨時(shí)對(duì)象創(chuàng)建并初始化在外部存儲(chǔ)單元中，省去了拷貝和析構(gòu)的化費(fèi)，提高了效率。
類似地，我們不要將
return int(x + y); // 創(chuàng)建一個(gè)臨時(shí)變量并返回它
寫成
int temp = x + y;
return temp;
由于內(nèi)部數(shù)據(jù)類型如int,float,double的變量不存在構(gòu)造函數(shù)與析構(gòu)函數(shù)，雖然該“臨時(shí)變量的語(yǔ)法”不會(huì)提高多少效率，但是程序更加簡(jiǎn)潔易讀。
²
【建議6-4-1】函數(shù)的功能要單一，不要設(shè)計(jì)多用途的函數(shù)。
²
【建議6-4-2】函數(shù)體的規(guī)模要小，盡量控制在50行代碼之內(nèi)。
²
【建議6-4-3】盡量避免函數(shù)帶有“記憶”功能。相同的輸入應(yīng)當(dāng)產(chǎn)生相同的輸出。
帶有“記憶”功能的函數(shù)，其行為可能是不可預(yù)測(cè)的，因?yàn)樗男袨榭赡苋Q于某種“記憶狀態(tài)”。這樣的函數(shù)既不易理解又不利于測(cè)試和維護(hù)。在C/C++語(yǔ)言中，函數(shù)的static局部變量是函數(shù)的“記憶”存儲(chǔ)器。建議盡量少用static局部變量，除非必需。
²
【建議6-4-4】不僅要檢查輸入?yún)?shù)的有效性，還要檢查通過其它途徑進(jìn)入函數(shù)體內(nèi)的變量的有效性，例如全局變量、文件句柄等。
²
【建議6-4-5】用于出錯(cuò)處理的返回值一定要清楚，讓使用者不容易忽視或誤解錯(cuò)誤情況。
程序一般分為Debug版本和Release版本，Debug版本用于內(nèi)部調(diào)試，Release版本發(fā)行給用戶使用。
斷言assert是僅在Debug版本起作用的宏，它用于檢查“不應(yīng)該”發(fā)生的情況。示例6-5是一個(gè)內(nèi)存復(fù)制函數(shù)。在運(yùn)行過程中，如果assert的參數(shù)為假，那么程序就會(huì)中止（一般地還會(huì)出現(xiàn)提示對(duì)話，說(shuō)明在什么地方引發(fā)了assert）。
|
void
*memcpy(void *pvTo, const void *pvFrom, size_t size)
{
assert((pvTo != NULL) &&
(pvFrom != NULL)); // 使用斷言
byte *pbTo = (byte *) pvTo; // 防止改變pvTo的地址
byte *pbFrom = (byte *) pvFrom; // 防止改變pvFrom的地址
while(size
-- > 0 )
*pbTo ++ = *pbFrom ++ ;
return pvTo;
}
|
示例6-5 復(fù)制不重疊的內(nèi)存塊
assert不是一個(gè)倉(cāng)促拼湊起來(lái)的宏。為了不在程序的Debug版本和Release版本引起差別，assert不應(yīng)該產(chǎn)生任何副作用。所以assert不是函數(shù)，而是宏。程序員可以把assert看成一個(gè)在任何系統(tǒng)狀態(tài)下都可以安全使用的無(wú)害測(cè)試手段。如果程序在assert處終止了，并不是說(shuō)含有該assert的函數(shù)有錯(cuò)誤，而是調(diào)用者出了差錯(cuò)，assert可以幫助我們找到發(fā)生錯(cuò)誤的原因。
很少有比跟蹤到程序的斷言，卻不知道該斷言的作用更讓人沮喪的事了。你化了很多時(shí)間，不是為了排除錯(cuò)誤，而只是為了弄清楚這個(gè)錯(cuò)誤到底是什么。有的時(shí)候，程序員偶爾還會(huì)設(shè)計(jì)出有錯(cuò)誤的斷言。所以如果搞不清楚斷言檢查的是什么，就很難判斷錯(cuò)誤是出現(xiàn)在程序中，還是出現(xiàn)在斷言中。幸運(yùn)的是這個(gè)問題很好解決，只要加上清晰的注釋即可。這本是顯而易見的事情，可是很少有程序員這樣做。這好比一個(gè)人在森林里，看到樹上釘著一塊“危險(xiǎn)”的大牌子。但危險(xiǎn)到底是什么？樹要倒？有廢井？有野獸？除非告訴人們“危險(xiǎn)”是什么，否則這個(gè)警告牌難以起到積極有效的作用。難以理解的斷言常常被程序員忽略，甚至被刪除。[Maguire, p8-p30]
l
【規(guī)則6-5-1】使用斷言捕捉不應(yīng)該發(fā)生的非法情況。不要混淆非法情況與錯(cuò)誤情況之間的區(qū)別，后者是必然存在的并且是一定要作出處理的。
l
【規(guī)則6-5-2】在函數(shù)的入口處，使用斷言檢查參數(shù)的有效性（合法性）。
l
【建議6-5-1】在編寫函數(shù)時(shí)，要進(jìn)行反復(fù)的考查，并且自問：“我打算做哪些假定？”一旦確定了的假定，就要使用斷言對(duì)假定進(jìn)行檢查。
l
【建議6-5-2】一般教科書都鼓勵(lì)程序員們進(jìn)行防錯(cuò)設(shè)計(jì)，但要記住這種編程風(fēng)格可能會(huì)隱瞞錯(cuò)誤。當(dāng)進(jìn)行防錯(cuò)設(shè)計(jì)時(shí)，如果“不可能發(fā)生”的事情的確發(fā)生了，則要使用斷言進(jìn)行報(bào)警。
6.6 引用與指針的比較
引用是C++中的概念，初學(xué)者容易把引用和指針混淆一起。一下程序中，n是m的一個(gè)引用（reference），m是被引用物（referent）。
int
m;
int
&n = m;
n相當(dāng)于m的別名（綽號(hào)），對(duì)n的任何操作就是對(duì)m的操作。例如有人名叫王小毛，他的綽號(hào)是“三毛”。說(shuō)“三毛”怎么怎么的，其實(shí)就是對(duì)王小毛說(shuō)三道四。所以n既不是m的拷貝，也不是指向m的指針，其實(shí)n就是m它自己。
引用的一些規(guī)則如下：
（1）引用被創(chuàng)建的同時(shí)必須被初始化（指針則可以在任何時(shí)候被初始化）。
（2）不能有NULL引用，引用必須與合法的存儲(chǔ)單元關(guān)聯(lián)（指針則可以是NULL）。
（3）一旦引用被初始化，就不能改變引用的關(guān)系（指針則可以隨時(shí)改變所指的對(duì)象）。
以下示例程序中，k被初始化為i的引用。語(yǔ)句k = j并不能將k修改成為j的引用，只是把k的值改變成為6。由于k是i的引用，所以i的值也變成了6。
int
i = 5;
int
j = 6;
int
&k = i;
k =
j; // k和i的值都變成了6;
上面的程序看起來(lái)象在玩文字游戲，沒有體現(xiàn)出引用的價(jià)值。引用的主要功能是傳遞函數(shù)的參數(shù)和返回值。C++語(yǔ)言中，函數(shù)的參數(shù)和返回值的傳遞方式有三種：值傳遞、指針傳遞和引用傳遞。
以下是“值傳遞”的示例程序。由于Func1函數(shù)體內(nèi)的x是外部變量n的一份拷貝，改變x的值不會(huì)影響n, 所以n的值仍然是0。
void
Func1(int x)
{
x = x + 10;
}
…
int n = 0;
Func1(n);
cout
<< “n = ” << n << endl; //
n = 0
以下是“指針傳遞”的示例程序。由于Func2函數(shù)體內(nèi)的x是指向外部變量n的指針，改變?cè)撝羔樀膬?nèi)容將導(dǎo)致n的值改變，所以n的值成為10。
void
Func2(int *x)
{
(* x) = (* x) + 10;
}
…
int n = 0;
Func2(&n);
cout
<< “n = ” << n << endl; // n = 10
以下是“引用傳遞”的示例程序。由于Func3函數(shù)體內(nèi)的x是外部變量n的引用，x和n是同一個(gè)東西，改變x等于改變n，所以n的值成為10。
void
Func3(int &x)
{
x = x + 10;
}
…
int n = 0;
Func3(n);
cout
<< “n = ” << n << endl; // n = 10
對(duì)比上述三個(gè)示例程序，會(huì)發(fā)現(xiàn)“引用傳遞”的性質(zhì)象“指針傳遞”，而書寫方式象“值傳遞”。實(shí)際上“引用”可以做的任何事情“指針”也都能夠做，為什么還要“引用”這東西？
答案是“用適當(dāng)?shù)墓ぞ咦銮∪缙浞值墓ぷ?#8221;。
指針能夠毫無(wú)約束地操作內(nèi)存中的如何東西，盡管指針功能強(qiáng)大，但是非常危險(xiǎn)。就象一把刀，它可以用來(lái)砍樹、裁紙、修指甲、理發(fā)等等，誰(shuí)敢這樣用？
如果的確只需要借用一下某個(gè)對(duì)象的“別名”，那么就用“引用”，而不要用“指針”，以免發(fā)生意外。比如說(shuō)，某人需要一份證明，本來(lái)在文件上蓋上公章的印子就行了，如果把取公章的鑰匙交給他，那么他就獲得了不該有的權(quán)利。