每天一個 PHP 語法六陣列使用及內部結構

ifelse發表於2020-04-19
PHP陣列

說明

這裡基於php7.2.5進行測試，php7之後內部結構變化應該不是太大，但與php5.X有差別。

我們今天學習PHP中的陣列語法，陣列在PHP中堪稱萬能結構，什麼都能存什麼都能放，非常靈活，因為PHP沒有其他語言的如map、list等結構，PHParray就夠了。

我們前面說變數的儲存結構為zval, 值呢放在zend_value中，忘了的看這裡

如何宣告

$arr  = [];
$arr[1] = "hello";

$arr1 = ['name' => '憤怒的鳥'];

如何實現

陣列的底層結構為zend_array 也叫HashTable，也就是通過對陣列的key進行hash計算之後能直接獲取value的地址，時間複雜度為O(1)那是很快的。

typedef struct _zend_array HashTable;

struct _zend_array {
    zend_refcounted_h gc;// 引用計數
    union {
        struct {
            ZEND_ENDIAN_LOHI_4(
                zend_uchar    flags,
                zend_uchar    nApplyCount,
                zend_uchar    nIteratorsCount,
                zend_uchar    consistency)
        } v;
        uint32_t flags;
    } u;
    uint32_t          nTableMask; // 中間對映計算
    Bucket           *arData; // 這裡是真正存放陣列元素的地方
    uint32_t          nNumUsed; // 已使用的bucket數量，可能包含已刪除的元素
    uint32_t          nNumOfElements; // 陣列中有效元素的數量
    uint32_t          nTableSize; // 陣列的總容量
    uint32_t          nInternalPointer;
    zend_long         nNextFreeElement;// 數值索引的值
    dtor_func_t       pDestructor;
};

typedef struct _Bucket {
    zval              val; // 元素的值 實際是一個zval
    zend_ulong        h;  /* 陣列key 經過hash計算得出的值 */              /* hash value (or numeric index)   */
    zend_string      *key;   /*元素的key*/           /* string key or NULL for numerics */
} Bucket;

我們知道陣列的key可以是數字或者字串，但是PHP中的陣列是有序的，也就是跟插入順序是保持一致的，那麼是如何做到的。

結論：

key在存入bucket之前先通過一箇中間對映表儲存key的位置，先對key進行hash計算然後與陣列大小值進行取模運算得出這個key在中間表的位置，然後在中間表的位置儲存這個key在bucket中的位置。如圖

這裡在key是字串的時候需要進行hash計算，如果是數值就直接拿來用就行了。

插入元素

這個操作比較明晰了，先計算中間表的位置，再儲存到bucket

add_to_hash:
    // nMumUsed  Bucket的數量 ++
    idx = ht->nNumUsed++;
// 有效元素的數量 ++
    ht->nNumOfElements++;
    if (ht->nInternalPointer == HT_INVALID_IDX) {
        ht->nInternalPointer = idx;
    }
    zend_hash_iterators_update(ht, HT_INVALID_IDX, idx);
// arData的記憶體位置 給當前元素用
    p = ht->arData + idx;
// 設定bucket的key
    p->key = key;
    if (!ZSTR_IS_INTERNED(key)) {
        zend_string_addref(key);
        ht->u.flags &= ~HASH_FLAG_STATIC_KEYS;
        zend_string_hash_val(key);
    }
// 設定bucket的h值 ，這裡其實是zend_string中的h 
    p->h = h = ZSTR_H(key);
// 設定bucket的val, 
    ZVAL_COPY_VALUE(&p->val, pData);
// 在bucket中的位置
    nIndex = h | ht->nTableMask;
    Z_NEXT(p->val) = HT_HASH(ht, nIndex);
    HT_HASH(ht, nIndex) = HT_IDX_TO_HASH(idx);

    return &p->val;

查詢元素

先自己思考一下我們在獲取陣列的值$a[‘name’],是如何獲取的，先用key計算hash值，拿到中間表的位置，再拿到bucket的位置，就能取到值了

// 拿到key的hash值
h = zend_string_hash_val(key);
    arData = ht->arData;
// 拿到中間表的位置
    nIndex = h | ht->nTableMask;
// 拿到bucket的位置
    idx = HT_HASH_EX(arData, nIndex);
// 這裡先不看
    while (EXPECTED(idx != HT_INVALID_IDX)) {
        p = HT_HASH_TO_BUCKET_EX(arData, idx);
        if (EXPECTED(p->key == key)) { /* check for the same interned string */
            return p;
        } else if (EXPECTED(p->h == h) &&
             EXPECTED(p->key) &&
             EXPECTED(ZSTR_LEN(p->key) == ZSTR_LEN(key)) &&
             EXPECTED(memcmp(ZSTR_VAL(p->key), ZSTR_VAL(key), ZSTR_LEN(key)) == 0)) {
            return p;
        }
        idx = Z_NEXT(p->val);
    }

hash衝突

hash計算不可避免的在資料量大的時候有衝突的機率，一般一個常用方法是拉鍊法，也就是衝突元素串成連結串列，當keyhash衝突後遍歷這個位置的連結串列，最終拿到匹配的key, 也就是上面的查詢元素中while那一段，來看下PHP hashTable是如何處理的，我們還是分析上面那一段程式碼

add_to_hash:
    // nMumUsed  Bucket的數量 ++
    idx = ht->nNumUsed++;
// 有效元素的數量 ++
    ht->nNumOfElements++;
    if (ht->nInternalPointer == HT_INVALID_IDX) {
        ht->nInternalPointer = idx;
    }
    zend_hash_iterators_update(ht, HT_INVALID_IDX, idx);
// arData的記憶體位置 給當前元素用
    p = ht->arData + idx;
// 設定bucket的key
    p->key = key;
    if (!ZSTR_IS_INTERNED(key)) {
        zend_string_addref(key);
        ht->u.flags &= ~HASH_FLAG_STATIC_KEYS;
        zend_string_hash_val(key);
    }
// 設定bucket的h值 ，這裡其實是zend_string中的h 
    p->h = h = ZSTR_H(key);
// 設定bucket的val, 
    ZVAL_COPY_VALUE(&p->val, pData);
// 在bucket中的位置
    nIndex = h | ht->nTableMask;
// 這一步，把 bucket當前位置nIndex的元素，設定為新值的next  
// 也就是 ht[idx] = p->newval , p->nexal -> next -> p->oldval
    Z_NEXT(p->val) = HT_HASH(ht, nIndex);
    HT_HASH(ht, nIndex) = HT_IDX_TO_HASH(idx);

    return &p->val;

// 這裡是 zval.u2.next 下一個元素，忘了的看zval結構
#define Z_NEXT(zval)                (zval).u2.next
// 這裡就是取到 data[idx]的元素
#define HT_HASH_EX(data, idx)
    ((uint32_t*)(data))[(int32_t)(idx)]
#define HT_HASH(ht, idx)
    HT_HASH_EX((ht)->arData, idx)

上圖

擴容

PHP陣列在初始化時不需要指定容量大小，也就是它是自動擴容的，如何實現呢。

結論：

如果插入元素時發現容量不夠了，如果已刪除的元素達到一定比例就重建索引，如果沒有達到就會進行原大小2倍的擴容，然後複製元素到新陣列。

IS_CONSISTENT(ht);
    HT_ASSERT_RC1(ht);

// 是否達到了這個值
    if (ht->nNumUsed > ht->nNumOfElements + (ht->nNumOfElements >> 5)) { /* additional term is there to amortize the cost of compaction */
        zend_hash_rehash(ht);
    } else if (ht->nTableSize < HT_MAX_SIZE) {    /* Let's double the table size */
    // 這裡會擴容2倍
        void *new_data, *old_data = HT_GET_DATA_ADDR(ht);
    // 2倍
        uint32_t nSize = ht->nTableSize + ht->nTableSize;
        Bucket *old_buckets = ht->arData;
// 申請記憶體
        new_data = pemalloc(HT_SIZE_EX(nSize, -nSize), ht->u.flags & HASH_FLAG_PERSISTENT);
    // 設定一些屬性
        ht->nTableSize = nSize;
        ht->nTableMask = -ht->nTableSize;
        HT_SET_DATA_ADDR(ht, new_data);
    // 複製buckets
        memcpy(ht->arData, old_buckets, sizeof(Bucket) * ht->nNumUsed);
    // 刪除老bucket
        pefree(old_data, ht->u.flags & HASH_FLAG_PERSISTENT);
        zend_hash_rehash(ht);
    } else {
        zend_error_noreturn(E_ERROR, "Possible integer overflow in memory allocation (%u * %zu + %zu)", ht->nTableSize * 2, sizeof(Bucket) + sizeof(uint32_t), sizeof(Bucket));
    }

總結

PHP陣列底層是hashTable, 通過一箇中間對映表實現順序性，自動擴容，value可以任何型別，key可以是int也可以是string

參考資料：
《PHP核心剖析》

本作品採用《CC 協議》，轉載必須註明作者和本文連結

相關文章