【性能为王】从PHP源码剖析array_keys和array_unique

文章来自：http://www.hoohack.me/2016/02/25/analyze-array-unique-array-keys-source-code

我在github有对PHP源码更详细的注解。感兴趣的能够围观一下，给个star。PHP5.4源码注解。能够经过commit记录查看已添加的注解。

以前在[译]更快的方式实现PHP数组去重这篇文章里讨论了使用array_flip后再调用array_keys函数替换直接调用array_unique函数实现数组去重性能较好。因为原文没有给出源码分析和测试的结果，致使给读者形成迷惑，在此说声抱歉。为了解开读者的疑惑，笔者承诺了会补上源码的分析，因而花了一些时间去研究PHP的源码，如今此补上详细的说明。

性能分析

从运行性能上分析，看看下面的测试代码：

$test=array();
for($run=0; $run<10000; $run++)
$test[]=rand(0,100);

$time=microtime(true);

$out = array_unique($test);

$time=microtime(true)-$time;
echo 'Array Unique: '.$time."\n";

$time=microtime(true);

$out=array_keys(array_flip($test));

$time=microtime(true)-$time;
echo 'Keys Flip: '.$time."\n";

$time=microtime(true);

$out=array_flip(array_flip($test));

$time=microtime(true)-$time;
echo 'Flip Flip: '.$time."\n";

运行结果以下：

从上图能够看到，使用array_unique函数须要0.069s;使用array_flip后再使用array_keys函数须要0.00152s;使用两次array_flip函数须要0.00146s。

测试结果代表，使用array_flip后再调用array_keys函数比array_unique函数快。那么，具体缘由是什么呢？让咱们看看在PHP底层，这两个函数是怎么实现的。

源码分析

/* {{{ proto array array_keys(array input [, mixed search_value[, bool strict]])
   Return just the keys from the input array, optionally only for the specified             search_value */
PHP_FUNCTION(array_keys)
{
    //变量定义
    zval *input,                /* Input array */
         *search_value = NULL,    /* Value to search for */
         **entry,                /* An entry in the input array */
           res,                    /* Result of comparison */
          *new_val;                /* New value */
    int    add_key;                /* Flag to indicate whether a key should be added */
    char  *string_key;            /* String key */
    uint   string_key_len;
    ulong  num_key;                /* Numeric key */
    zend_bool strict = 0;        /* do strict comparison */
    HashPosition pos;
    int (*is_equal_func)(zval *, zval *, zval * TSRMLS_DC) = is_equal_function;

    //程序解析参数
    if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "a|zb", &input, &search_value, &strict) == FAILURE) {
        return;
    }

    // 若是strict是true，则设置is_equal_func为is_identical_function，即全等比较
    if (strict) {
        is_equal_func = is_identical_function;
    }

    /* 根据search_vale初始化返回的数组大小 */
    if (search_value != NULL) {
        array_init(return_value);
    } else {
        array_init_size(return_value, zend_hash_num_elements(Z_ARRVAL_P(input)));
    }
    add_key = 1;

    /* 遍历输入的数组参数，而后添加键值到返回的数组 */
    zend_hash_internal_pointer_reset_ex(Z_ARRVAL_P(input), &pos);//重置指针
    //循环遍历数组
    while (zend_hash_get_current_data_ex(Z_ARRVAL_P(input), (void **)&entry, &pos) == SUCCESS) {
        // 若是search_value不为空
        if (search_value != NULL) {
            // 判断search_value与当前的值是否相同，并将比较结果保存到add_key变量
            is_equal_func(&res, search_value, *entry TSRMLS_CC);
            add_key = zval_is_true(&res);
        }

        if (add_key) {
            // 建立一个zval结构体
            MAKE_STD_ZVAL(new_val);

            // 根据键值是字符串仍是整型数字将值插入到return_value中
            switch (zend_hash_get_current_key_ex(Z_ARRVAL_P(input), &string_key, &string_key_len, &num_key, 1, &pos)) {
                case HASH_KEY_IS_STRING:
                    ZVAL_STRINGL(new_val, string_key, string_key_len - 1, 0);
                    // 此函数负责将值插入到return_value中，若是键值已存在，则使用新值更新对应的值，不然直接插入
                    zend_hash_next_index_insert(Z_ARRVAL_P(return_value), &new_val, sizeof(zval *), NULL);
                    break;

                case HASH_KEY_IS_LONG:
                    Z_TYPE_P(new_val) = IS_LONG;
                    Z_LVAL_P(new_val) = num_key;
                    zend_hash_next_index_insert(Z_ARRVAL_P(return_value), &new_val, sizeof(zval *), NULL);
                    break;
            }
        }

        // 移动到下一个
        zend_hash_move_forward_ex(Z_ARRVAL_P(input), &pos);
    }
}
/* }}} */

以上是array_keys函数底层的源码。为方便理解，笔者添加了一些中文注释。若是须要查看原始代码，能够点击查看。这个函数的功能就是新建一个临时数组，而后将键值对从新复制到新的数组，若是复制过程当中有重复的键值出现，那么就用新的值替换。这个函数的主要步骤是地57和63行调用的zend_hash_next_index_insert函数。该函数将元素插入到数组中，若是出现重复的值，则使用新的值更新原键值指向的值，不然直接插入，时间复杂度是O(n)。

/* {{{ proto array array_flip(array input)
   Return array with key <-> value flipped */
PHP_FUNCTION(array_flip)
{
    // 定义变量
    zval *array, **entry, *data;
    char *string_key;
    uint str_key_len;
    ulong num_key;
    HashPosition pos;

    // 解析数组参数
    if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "a", &array) == FAILURE) {
        return;
    }

    // 初始化返回数组
    array_init_size(return_value, zend_hash_num_elements(Z_ARRVAL_P(array)));

    // 重置指针
    zend_hash_internal_pointer_reset_ex(Z_ARRVAL_P(array), &pos);
    // 遍历每一个元素，并执行键<->值交换操做
    while (zend_hash_get_current_data_ex(Z_ARRVAL_P(array), (void **)&entry, &pos) == SUCCESS) {
        // 初始化一个结构体
        MAKE_STD_ZVAL(data);
        // 将原数组的值赋值为新数组的键
        switch (zend_hash_get_current_key_ex(Z_ARRVAL_P(array), &string_key, &str_key_len, &num_key, 1, &pos)) {
            case HASH_KEY_IS_STRING:
                ZVAL_STRINGL(data, string_key, str_key_len - 1, 0);
                break;
            case HASH_KEY_IS_LONG:
                Z_TYPE_P(data) = IS_LONG;
                Z_LVAL_P(data) = num_key;
                break;
        }

        // 将原数组的键赋值为新数组的值，若是有重复的，则使用新值覆盖旧值
        if (Z_TYPE_PP(entry) == IS_LONG) {
            zend_hash_index_update(Z_ARRVAL_P(return_value), Z_LVAL_PP(entry), &data, sizeof(data), NULL);
        } else if (Z_TYPE_PP(entry) == IS_STRING) {
            zend_symtable_update(Z_ARRVAL_P(return_value), Z_STRVAL_PP(entry), Z_STRLEN_PP(entry) + 1, &data, sizeof(data), NULL);
        } else {
            zval_ptr_dtor(&data); /* will free also zval structure */
            php_error_docref(NULL TSRMLS_CC, E_WARNING, "Can only flip STRING and INTEGER values!");
        }

        // 下一个
        zend_hash_move_forward_ex(Z_ARRVAL_P(array), &pos);
    }
}
/* }}} */

上面就是是array_flip函数的源码。点击连接查看原始代码。这个函数主要的作的事情就是建立一个新的数组，遍历原数组。在26行开始将原数组的值赋值为新数组的键，而后在37行开始将原数组的键赋值为新数组的值，若是有重复的，则使用新值覆盖旧值。整个函数的时间复杂度也是O(n)。所以，使用了array_flip以后再使用array_keys的时间复杂度是O(n)。

接下来，咱们看看array_unique函数的源码。点击连接查看原始代码。

/* {{{ proto array array_unique(array input [, int sort_flags])
   Removes duplicate values from array */
PHP_FUNCTION(array_unique)
{
    // 定义变量
    zval *array, *tmp;
    Bucket *p;
    struct bucketindex {
        Bucket *b;
        unsigned int i;
    };
    struct bucketindex *arTmp, *cmpdata, *lastkept;
    unsigned int i;
    long sort_type = PHP_SORT_STRING;

    // 解析参数
    if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "a|l", &array, &sort_type) == FAILURE) {
        return;
    }

    // 设置比较函数
    php_set_compare_func(sort_type TSRMLS_CC);

    // 初始化返回数组
    array_init_size(return_value, zend_hash_num_elements(Z_ARRVAL_P(array)));
    // 将值拷贝到新数组
    zend_hash_copy(Z_ARRVAL_P(return_value), Z_ARRVAL_P(array), (copy_ctor_func_t) zval_add_ref, (void *)&tmp, sizeof(zval*));

    if (Z_ARRVAL_P(array)->nNumOfElements <= 1) {    /* 什么都不作 */
        return;
    }

    /* 根据target_hash buckets的指针建立数组并排序 */
    arTmp = (struct bucketindex *) pemalloc((Z_ARRVAL_P(array)->nNumOfElements + 1) * sizeof(struct bucketindex), Z_ARRVAL_P(array)->persistent);
    if (!arTmp) {
        zval_dtor(return_value);
        RETURN_FALSE;
    }
    for (i = 0, p = Z_ARRVAL_P(array)->pListHead; p; i++, p = p->pListNext) {
        arTmp[i].b = p;
        arTmp[i].i = i;
    }
    arTmp[i].b = NULL;
    // 排序
    zend_qsort((void *) arTmp, i, sizeof(struct bucketindex), php_array_data_compare TSRMLS_CC);

    /* 遍历排序好的数组，而后删除重复的元素 */
    lastkept = arTmp;
    for (cmpdata = arTmp + 1; cmpdata->b; cmpdata++) {
        if (php_array_data_compare(lastkept, cmpdata TSRMLS_CC)) {
            lastkept = cmpdata;
        } else {
            if (lastkept->i > cmpdata->i) {
                p = lastkept->b;
                lastkept = cmpdata;
            } else {
                p = cmpdata->b;
            }
            if (p->nKeyLength == 0) {
                zend_hash_index_del(Z_ARRVAL_P(return_value), p->h);
            } else {
                if (Z_ARRVAL_P(return_value) == &EG(symbol_table)) {
                    zend_delete_global_variable(p->arKey, p->nKeyLength - 1 TSRMLS_CC);
                } else {
                    zend_hash_quick_del(Z_ARRVAL_P(return_value), p->arKey, p->nKeyLength, p->h);
                }
            }
        }
    }
    pefree(arTmp, Z_ARRVAL_P(array)->persistent);
}
/* }}} */

能够看到，这个函数初始化一个新的数组，而后将值拷贝到新数组，而后在45行调用排序函数对数组进行排序，排序的算法是zend引擎的块树排序算法。接着遍历排序好的数组，删除重复的元素。整个函数开销最大的地方就在调用排序函数上，而快排的时间复杂度是O(nlogn)，所以，该函数的时间复杂度是O(nlogn)。

结论

由于array_unique底层调用了快排算法，加大了函数运行的时间开销，致使整个函数的运行较慢。这就是为何array_keys比array_unique函数更快的缘由。

原创文章，文笔有限，才疏学浅，文中如有不正之处，万望告知。

若是本文对你有帮助，望点下推荐，写文章不容易。

最后再安利一下，我在github有对PHP源码更详细的注解。感兴趣的能够围观一下，给个star。PHP5.4源码注解。能够经过commit记录查看已添加的注解。