C 語言返回指標函數的四大陷阱與最佳實踐方案

經典錯誤：返回棧上局部變量地址

/* 錯誤示範 */
char* GetStaffNameById(int id)
{
    StaffInfo db[] = { {"Socrates",1}, {"dyx1024",2}, {"Kevin",3}, {"Jim",4} };
    for (int i=0; i<4; i++)
        if (db[i].id == id) return db[i].name; // db 在棧上，函數返回即銷毀
    return "No match";
}

int main()
{
    char* name = GetStaffNameById(2);
    printf("%s\n", name); // 運行時未定義行為：可能輸出正確、亂碼或崩潰
}

根因：db 是自動存儲期局部變量，函數返回後棧幀釋放，內存被後續調用覆蓋。返回指標變成懸空指標 (Dangling Pointer)。

四種修復方案深度對比

方案一：靜態存儲期 (static)

char* GetStaffNameById_v1(int id)
{
    static StaffInfo db[] = { {"Socrates",1}, {"dyx1024",2}, {"Kevin",3}, {"Jim",4} };
    // static 使 db 存儲於 .data/.bss 段，生命週期 = 程序全周期
    for (int i=0; i<4; i++)
        if (db[i].id == id) return db[i].name;
    return "No match";
}

方案二：全局/文件作用域靜態變量

static StaffInfo g_Db[] = { ... }; // 文件內可見，鏈接時不導出符號

char* GetStaffNameById_v2(int id) { /* 同 v1 */ }

本質同方案一，但作用域可控。適用於模塊內部共享狀態。

方案三：輸出參數 (Output Parameter) —— 推薦

/* 接口契約：調用方分配緩衝區，傳入指針與容量 */
void GetStaffNameById_v3(int id, char* outBuf, size_t bufSize)
{
    StaffInfo db[] = { {"Socrates",1}, {"dyx1024",2}, {"Kevin",3}, {"Jim",4} };
    const char* src = "No match";
    for (int i=0; i<4; i++)
        if (db[i].id == id) { src = db[i].name; break; }
    
    if (outBuf && bufSize > 0) {
        strncpy(outBuf, src, bufSize - 1);
        outBuf[bufSize - 1] = '\0'; // 保證以 null 結尾
    }
}

int main()
{
    char name[32];
    GetStaffNameById_v3(2, name, sizeof(name));
    printf("%s\n", name); // 完全安全
}

方案四：調用方分配、被調用方填充 (Heap Allocation by Callee)

/* 返回堆內存，調用方負責 free */
char* GetStaffNameById_v4(int id)
{
    StaffInfo db[] = { {"Socrates",1}, {"dyx1024",2}, {"Kevin",3}, {"Jim",4} };
    const char* src = "No match";
    for (int i=0; i<4; i++)
        if (db[i].id == id) { src = db[i].name; break; }

    char* ret = malloc(strlen(src) + 1);
    if (!ret) return NULL; // 或 abort()
    strcpy(ret, src);
    return ret;
}

int main()
{
    char* name = GetStaffNameById_v4(2);
    if (name) {
        printf("%s\n", name);
        free(name); // 必須釋放！
        name = NULL;
    }
}

決策矩陣：如何選擇？

進階防禦技巧

1. 返回類型加 const 保護只讀語義

const char* GetErrorMsg(int code); // 明確告知：不可修改

2. 靜態分析標註 (SAL / Clang Thread Safety)

/* SAL 註釋：調用方必須提供有效緩衝區 */
void GetName(_In_ int id, _Out_writes_(bufSize) char* buf, _In_ size_t bufSize);

/* Clang 線程安全註釋 */
const char* GetConfig() __attribute__((const)); // 純函數

3. 緩衝區大小查詢接口

size_t GetStaffNameMaxLen(void); // 返回所需最小緩衝區 (含\0)
void GetStaffNameById(int id, char* buf, size_t bufSize);

總結

返回指標函數的核心矛盾在於內存生命週期與所有權歸屬。牢記：

1. 絕不返回棧地址 —— 編譯器不會攔截，只有運行時災難。
2. 首選輸出參數 —— 所有權清晰、線程安全、零分配，工程級首選。
3. 若必須返回堆指標 —— 在函數名/文檔中明確標註 _malloc/_free 契約，配合靜態分析工具檢查泄漏。
4. 善用 const —— 將只讀語義編碼進類型系統。

掌握這四種模式及其權衡，是編寫健壯 C 接口的必修課。