PHP数组洗牌保留键名方法

本篇文章向大家介绍《PHP数组洗牌保留键名技巧》，主要包括，具有一定的参考价值，需要的朋友可以参考一下。

在PHP中，shuffle()函数用于随机打乱数组元素，但它会默认重置数组的键名为数字索引，导致原始的关联键名丢失。本教程将详细解析shuffle()函数的这一行为，并提供一个自定义的shuffle_assoc()函数，通过分离键名和值、独立打乱键名再重构数组的方式，实现关联数组在随机化过程中键名的有效保留，确保数据完整性。

PHP shuffle() 函数的行为解析

当我们需要随机化一个数组时，PHP的内置函数shuffle()是一个常用的选择。然而，对于关联数组（即使用字符串作为键名的数组），shuffle()函数有一个重要的特性需要注意：它会重新分配数组元素的键名，将其转换为从0开始的数字索引。这意味着，如果你的数组依赖于其原始的关联键名进行数据标识或后续操作，使用shuffle()将导致这些键名丢失。

让我们通过一个示例来演示这个问题：

<?php
$speciesarray = array(
    "Amanita aprica"          => "species/Amanita_aprica.html",
    "Amanita augusta"         => "species/Amanita_augusta.html",
    "Amanita calyptratoides"  => "species/Amanita_calyptratoides.html",
    "Amanita calyptroderma"   => "species/Amanita_calyptroderma.html",
    "Amanita constricta"      => "species/Amanita_constricta.html",
    "Amanita gemmata"         => "species/Amanita_gemmata.html",
    "Amanita magniverrucata"  => "species/Amanita_magniverrucata.html",
    "Amanita muscaria"        => "species/Amanita_muscaria.html",
    "Amanita novinupta"       => "species/Amanita_novinupta.html",
    "Amanita ocreata"         => "species/Amanita_ocreata.html",
    "Amanita pachycolea"      => "species/Amanita_pachycolea.html",
    "Amanita pantherina"      => "species/Amanita_pantherina.html",
    "Amanita phalloides"      => "species/Amanita_phalloides.html",
    "Amanita porphyria"       => "species/Amanita_porphyria.html",
    "Amanita protecta"        => "species/Amanita_protecta.html",
    "Amanita pruittii"        => "species/Amanita_pruittii.html",
    "Amanita silvicola"       => "species/Amanita_silvicola.html",
    "Amanita smithiana"       => "species/Amanita_smithiana.html",
    "Amanita vaginata"        => "species/Amanita_vaginata.html",
    "Amanita velosa"          => "species/Amanita_velosa.html",
    "Amanita vernicoccora"    => "species/Amanita_vernicoccora.html"
);

// 原始意图：随机打乱并截取前5个元素，然后获取第一个元素的键名
shuffle($speciesarray); // 第一次打乱
$speciesarray = array_slice($speciesarray, 0, 5); // 截取前5个
reset($speciesarray);
$choice = key($speciesarray); // 获取第一个元素的键名

// 调试输出
print_r($speciesarray);
echo("<br/>");
print_r($choice);
?>

预期输出：

Array ( [Amanita silvicola] => species/Amanita_silvicola.html [Amanita gemmata] => species/Amanita_gemmata.html ... )
Amanita silvicola

实际输出：

Array ( [0] => species/Amanita_silvicola.html [1] => species/Amanita_gemmata.html ... )
0

从实际输出可以看出，经过shuffle()处理后，数组的键名从原始的字符串变为了数字0, 1, 2, ...。这导致后续尝试获取原始键名key($speciesarray)时，得到的是数字0，而非我们期望的字符串键名。

根据PHP官方文档对shuffle()函数的说明：

"此函数会为数组中的元素分配新键。它将删除任何可能已分配的现有键，而不仅仅是重新排序键。"

这明确解释了为什么关联键名会丢失。

保留关联键名的自定义洗牌函数 shuffle_assoc()

为了在随机打乱数组的同时保留其关联键名，我们需要实现一个自定义的函数。核心思想是：首先提取出数组的所有键名，对这些键名进行随机打乱，然后依据打乱后的键名顺序重新构建一个新的数组，从而实现值随机排列但键名与值保持关联。

以下是实现这一功能的shuffle_assoc()函数：

<?php
/**
 * 随机打乱关联数组，并保留其原始键名。
 *
 * @param array &$array 待打乱的关联数组，通过引用传递以便直接修改原数组。
 * @return bool 始终返回 true。
 */
function shuffle_assoc(&$array) {
    // 1. 提取数组的所有键名
    $keys = array_keys($array);

    // 2. 随机打乱键名数组
    shuffle($keys);

    // 3. 创建一个新数组，按照打乱后的键名顺序重构
    $new = [];
    foreach ($keys as $key) {
        $new[$key] = $array[$key];
    }

    // 4. 将原数组替换为重构后的数组
    $array = $new;

    return true;
}
?>

shuffle_assoc() 函数的工作原理：

1. $keys = array_keys($array);：首先使用array_keys()函数获取原数组$array中的所有键名，并将它们存储在一个新的索引数组$keys中。此时$keys只包含键名，例如 ["Amanita aprica", "Amanita augusta", ...]。
2. shuffle($keys);：对这个只包含键名的索引数组$keys进行shuffle()操作。由于$keys本身是一个索引数组，shuffle()操作只会打乱其元素的顺序，不会影响其内容的完整性。
3. foreach ($keys as $key) { $new[$key] = $array[$key]; }：遍历打乱后的$keys数组。对于$keys中的每一个键名$key，我们都从原始数组$array中取出对应的值$array[$key]，并将其赋值给新数组$new中以$key为键的位置。这样就确保了每个原始键名与其对应的值保持关联，同时整体的顺序是随机的。
4. $array = $new;：最后，将原始数组$array的引用指向新创建的$new数组。这样，调用shuffle_assoc()函数后，原数组$array就会被替换为打乱了顺序但保留了键名的新数组。

使用 shuffle_assoc() 解决问题

现在，我们将原始示例代码中的shuffle()调用替换为shuffle_assoc()：

<?php
// ... (shuffle_assoc 函数定义，如上所示) ...

$speciesarray = array(
    "Amanita aprica"          => "species/Amanita_aprica.html",
    "Amanita augusta"         => "species/Amanita_augusta.html",
    "Amanita calyptratoides"  => "species/Amanita_calyptratoides.html",
    "Amanita calyptroderma"   => "species/Amanita_calyptroderma.html",
    "Amanita constricta"      => "species/Amanita_constricta.html",
    "Amanita gemmata"         => "species/Amanita_gemmata.html",
    "Amanita magniverrucata"  => "species/Amanita_magniverrucata.html",
    "Amanita muscaria"        => "species/Amanita_muscaria.html",
    "Amanita novinupta"       => "species/Amanita_novinupta.html",
    "Amanita ocreata"         => "species/Amanita_ocreata.html",
    "Amanita pachycolea"      => "species/Amanita_pachycolea.html",
    "Amanita pantherina"      => "species/Amanita_pantherina.html",
    "Amanita phalloides"      => "species/Amanita_phalloides.html",
    "Amanita porphyria"       => "species/Amanita_porphyria.html",
    "Amanita protecta"        => "species/Amanita_protecta.html",
    "Amanita pruittii"        => "species/Amanita_pruittii.html",
    "Amanita silvicola"       => "species/Amanita_silvicola.html",
    "Amanita smithiana"       => "species/Amanita_smithiana.html",
    "Amanita vaginata"        => "species/Amanita_vaginata.html",
    "Amanita velosa"          => "species/Amanita_velosa.html",
    "Amanita vernicoccora"    => "species/Amanita_vernicoccora.html"
);

// 使用自定义函数进行关联数组洗牌
shuffle_assoc($speciesarray); // 第一次打乱，保留键名
$speciesarray = array_slice($speciesarray, 0, 5, true); // 截取前5个，保留键名
reset($speciesarray);
$choice = key($speciesarray); // 获取第一个元素的键名

// 调试输出
print_r($speciesarray);
echo("<br/>");
print_r($choice);
?>

关键改进点：

• shuffle_assoc($speciesarray);：替换了原有的shuffle()调用，确保键名在第一次洗牌时就被保留。
• array_slice($speciesarray, 0, 5, true);：在array_slice()函数中，第四个参数设置为true至关重要。这指示array_slice()在切片时保留原始数组的键名，否则它也会默认重新索引为数字键。

现在，期望的输出将与实际输出一致：

Array ( [Amanita silvicola] => species/Amanita_silvicola.html [Amanita gemmata] => species/Amanita_gemmata.html [Amanita calyptratoides] => species/Amanita_calyptratoides.html [Amanita vaginata] => species/Amanita_vaginata.html [Amanita phalloides] => species/Amanita_phalloides.html )
Amanita silvicola

注意事项与总结

• 理解函数行为是关键： 在使用PHP内置数组函数时，务必查阅官方文档，了解其对键名处理的具体行为，尤其是在处理关联数组时。
• 自定义函数的必要性： 当内置函数无法满足特定需求（如保留关联键名）时，编写自定义函数是常见的解决方案。shuffle_assoc()提供了一个优雅且高效的方式来解决shuffle()函数重置键名的问题。
• array_slice() 的第四个参数： 在截取数组时，如果需要保留原始键名，切记将array_slice()的preserve_keys参数设置为true。
• 性能考量： shuffle_assoc()函数需要额外的步骤来提取键、打乱键和重构数组，这可能会比简单的shuffle()操作带来轻微的性能开销。然而，对于大多数非极端规模的数组操作，这种开销通常可以忽略不计，且其带来的功能正确性远比微小的性能差异更重要。

通过上述教程，我们深入理解了PHP shuffle() 函数在处理关联数组时的行为，并掌握了如何通过自定义shuffle_assoc()函数，结合array_keys()和循环重构数组的方法，实现在随机化数组元素的同时有效保留其关联键名。这对于需要维护数据标识符和值之间映射关系的PHP应用至关重要。

终于介绍完啦！小伙伴们，这篇关于《PHP数组洗牌保留键名方法》的介绍应该让你收获多多了吧！欢迎大家收藏或分享给更多需要学习的朋友吧~golang学习网公众号也会发布文章相关知识，快来关注吧！