C語言函數(shù)調(diào)用:【錯誤碼】和【返回值】傳遞的小思考
C 語言是一門面向過程的編程語言,通過一個又一個函數(shù),把計算、過程控制等邏輯,包裝成一個個獨立的處理單元。
既然是函數(shù)調(diào)用,就一定會有參數(shù)和返回值的傳遞問題,因此也就產(chǎn)生了多種不同的編程范式,比如:
- Posix 風格:函數(shù)返回值只用來表示成功(0)或失敗(非0),其他的輸出結(jié)果都使用參數(shù)來傳遞。
- Unix 風格:函數(shù)返回值即包括錯誤代碼,也包括有用的輸出結(jié)果。
- GAI 風格:與 Posix 有點類似,函數(shù)執(zhí)行成功時返回0,否則就返回非0。
這篇文章就來輕松一下,聊一聊這些函數(shù)調(diào)用范式在開發(fā)過程中的一些小思考。
我們假設有一個算法函數(shù),輸入兩個整型參數(shù),輸出一個整型結(jié)果,并且輸出一個錯誤代碼。
第一種:輸入、輸出結(jié)果和錯誤碼全部通過參數(shù)傳遞
既然所有的信息都是通過參數(shù)來傳遞的,那么函數(shù)定義就應該是下面這樣:
- void func1(int a, int b, int *result, int *err_code)
- {
- int c = a + b;
- *result = c;
- err_code = 0; // 沿用 Linux 中的習慣,0 表示沒有發(fā)生錯誤。
- }
因為不需要返回任何數(shù)據(jù),因此函數(shù)簽名的返回類型就是 void 。
因為調(diào)用者需要獲取輸出結(jié)果和錯誤碼,因此在形參中, result和err_code需要傳遞指針類型的變量。
面對這樣的函數(shù)簽名,調(diào)用者就必須顯示的定義兩個變量result和err_code,用來接收函數(shù)的輸出。
- // 調(diào)用者代碼
- int result, err_code;
- func(1, 2, &result, &err_code);
- if (0 == err_code)
- printf("Success. result = %d \n", result);
- else
- printf("Failed. err_code = %d \n", err_code);
這種函數(shù)范式的優(yōu)點就是:在調(diào)用形式上統(tǒng)一,無論參數(shù)類型是什么(基礎類型、結(jié)構體等待),都是整齊劃一的函數(shù)調(diào)用寫法。
缺點就是有點累贅。
面對任何一個函數(shù),調(diào)用者都必須定義一個err_code變量傳遞進去。
如果一個函數(shù)是過程控制類型的,壓根就不會產(chǎn)生什么錯誤碼,這樣的函數(shù)調(diào)用就顯得很臃腫,因為調(diào)用者壓根就不需要檢查錯誤碼。
第二種:函數(shù)返回值表示錯誤碼
也就是把第一種方式中的err_code參數(shù),通過函數(shù)返回值賦值給調(diào)用者。
這種函數(shù)編程范式還是比較常見的,返回值只表示錯誤碼,其他的輸出結(jié)果都通過參數(shù)引用(指針)來傳遞。
- int func2(int a, int b, int *result)
- {
- int c = a + b;
- *result = c;
- return 0; // 返回錯誤碼
- }
這樣的函數(shù)范式跟POSIX風格很像了。
面對這樣的函數(shù),調(diào)用者的寫法就會變成這樣:
- // 調(diào)用者代碼
- int result, err_code;
- err_code = func2(1, 2, &result);
- if (0 == err_code)
- printf("Success. result = %d \n", result);
- else
- printf("Failed. err_code = %d \n", err_code);
看起來好像跟第一種方式?jīng)]有什么本質(zhì)區(qū)別,但是再看一下下面這樣的寫法呢:
- // 調(diào)用者代碼
- int result;
- if (0 == func2(1, 2, &result))
- printf("Success. result = %d \n", result);
- else
- printf("Failed.\n");
這樣的代碼風格,在Linux中是不是很常見?當不需要處理錯誤碼時,這樣的編程方式會更方便一些。
第三種:函數(shù)返回值表示輸出結(jié)果
也就是把第一種方式中的result參數(shù),通過函數(shù)返回值賦值給調(diào)用者。
- int func3(int a, int b, int *err_code)
- {
- int c = a + b;
- err_code = 0;
- return c;
- }
這有點類似Unix中的風格:
返回結(jié)果中包括了有用的數(shù)據(jù),但是它有一個局限:返回結(jié)果必須與錯誤碼的類型一致。
另外還有一個問題:如果 int 型的返回結(jié)果也可能是負數(shù), 所以 Unix 中還必須使用另一個全局變量 errno 來單獨存儲錯誤碼,存在線程安全問題(可以使用線程局部存儲來解決)。
面對這樣的函數(shù)簽名,調(diào)用者的調(diào)用方式如下:
- // 調(diào)用者代碼
- int result, err_code;
- result = func3(1, 2, &err_code))
- if (0 == err_code)
- printf("Success. result = %d \n", result);
- else
- printf("Failed.\n");
這種方式的缺點與第一種一樣:必須定義一個變量 err_code,來接收錯誤碼。
在不必要檢查錯誤碼的場合中,顯得有點多此一舉。
小結(jié)
以上的這三種函數(shù)調(diào)用方式,沒有好壞之分,只與每一位開發(fā)者的編碼習慣有關系。
而且在實際的項目代碼中,這三種方式都能看得到。
如果函數(shù)輸出結(jié)果是結(jié)構體呢?
剛才討論的三種方式中,函數(shù)輸出結(jié)果reuslt是一個整型,如果它是一個結(jié)構體類型的變量,那么哪一種方式相對比較好呢?
這就要注意另外兩點了:
結(jié)構體的賦值是需要時間開銷的;
結(jié)構體賦值時,需要考慮深拷貝、淺拷貝的問題;
當看完以上幾個小思考時,是不是覺得特別簡單、不屑一顧?
不妨繼續(xù)思考一步:在我們的實際編程過程中,是不是每次能夠注意、遵守這些小細節(jié)問題呢?
如果團隊中沒有強制的代碼規(guī)范,同事之間不會code review,我們是不是都會選擇偷懶、放過自己呢?我就是^-^
本文轉(zhuǎn)載自微信公眾號「IOT物聯(lián)網(wǎng)小鎮(zhèn)」,可以通過以下二維碼關注。轉(zhuǎn)載本文請聯(lián)系IOT物聯(lián)網(wǎng)小鎮(zhèn)公眾號。