HOWTO · C++

在 C++ 中返回指向陣列的指標

本文演示瞭如何從 C++ 中的函式中返回指向陣列的指標。

本頁內容

C++ 函式可以傳回指向陣列元素的指標,但指標本身不包含陣列長度,也不代表該陣列的所有權。若要安全使用,必須知道哪個物件擁有這段儲存空間、可用的元素數量,以及該物件會存活多久。一般情況下,以值傳回容器通常比移交原始指標更清楚。

了解陣列指標所指向的內容

在函式參數中,int values[] 會調整為 int* values。它不會保留固定的陣列界限,因此必須另外傳入元素數量,或使用會記錄大小的容器。這個指標指向第一個元素;只有當 values[i] 等索引仍位於同一個陣列內,且索引未超出界限時,才能存取後續元素。

傳回 values 就是傳回該位址。這不會複製陣列,也不會延長它的生命週期。對於像 values 這樣的 std::array 物件,呼叫其 values.data() 成員會傳回指向元素的指標。只有在 values 物件仍然存活,且其儲存空間尚未失效時,該指標才有效。

傳回指向由呼叫端擁有之陣列的指標

一種實用的原始指標模式,是讓呼叫端擁有陣列,再將陣列的位址與長度傳給函式。函式可以修改元素,並傳回同一個指標,方便呼叫端繼續使用。只要還會使用傳回的指標,呼叫端就必須讓陣列保持存活,且其儲存空間不能失效。

執行這個範例:

本節中的程式碼以及顯示的標籤或輸出仍為英文。

#include <cstddef>
#include <iostream>

int* subtractFrom(int values[], std::size_t size, int amount) {
    for (std::size_t i = 0; i < size; ++i) {
        values[i] -= amount;
    }
    return values;
}

int main() {
    int values[] = {5, 10, 15};
    int* result = subtractFrom(values, 3, 2);

    for (std::size_t i = 0; i < 3; ++i) {
        if (i != 0) std::cout << ' ';
        std::cout << result[i];
    }
    std::cout << '\n';
}
3 8 13

陣列由 main 擁有,因此在該處讀取 result 時仍然存活。由於函式參數不知道原始陣列的長度,因此必須另外提供大小。若要使用固定大小的容器,std::array<int, 3> values 可提供包含大小資訊的物件;若介面需要元素指標,也可以使用它的 data() 成員取得。

傳回指向動態配置陣列儲存空間的指標

函式可以使用 new[] 配置儲存空間,並傳回取得的指標。這會把手動清理的責任交給呼叫端:保留指標、使用的元素不得超過配置數量,並在使用完畢後恰好呼叫一次 delete[] 釋放配置。呼叫端也必須知道元素數量,因為原始指標不會記錄大小。以純量 delete 配對 new[]、重複刪除,或忘記釋放儲存空間,都會造成錯誤或記憶體洩漏。

在這個範例中,makeSequence 會配置並填入三個整數。呼叫端取得指標後,依已知的元素數量使用陣列,並以相符的 delete[] 釋放它:

本節中的程式碼以及顯示的標籤或輸出仍為英文。

#include <cstddef>
#include <iostream>

int* makeSequence(std::size_t count) {
    int* values = new int[count];
    for (std::size_t i = 0; i < count; ++i) {
        values[i] = static_cast<int>(i * 5 + 3);
    }
    return values;
}

int main() {
    const std::size_t count = 3;
    int* values = makeSequence(count);

    for (std::size_t i = 0; i < count; ++i) {
        std::cout << values[i] << '\n';
    }

    delete[] values;
}

這種做法可以表示執行期間才決定大小的陣列,但所有權很容易管理不清。若結果長度可變,建議以值傳回 std::vector<int>。vector 會管理自己的配置、提供大小資訊,也能有效率地移動;呼叫端只能在 vector 仍然存活,且其儲存空間尚未因重新配置而失效時使用其中的元素。

避免懸空指標並選擇更安全的傳回型別

不要傳回指向自動儲存期區域陣列的指標。函式返回時,該陣列的生命週期便結束,呼叫端因此會取得懸空指標。這與函式區域的 static 陣列不同:靜態儲存期會持續到程式結束,因此不會只因函式返回就讓指標懸空。不過,每次呼叫都會共用同一個可修改陣列,容量固定,而且並行或巢狀呼叫可能互相干擾。只有在確實需要共用狀態時,才使用靜態儲存空間。

若結果大小固定,請以值傳回 std::array<int, N>;若結果大小可變,請以值傳回 std::vector<int>。這些型別能明確表達所有權,也不必要求呼叫端另外配對原始指標與清理規則。如果 API 必須傳回元素指標,請說明擁有該元素的物件及指標的有效期限;物件銷毀或其儲存空間改變後,就不要再使用該指標。