PHP对象属性检测：替代array_key_exists方法

本篇文章向大家介绍《PHP对象属性检测：array_key_exists替代方案》，主要包括，具有一定的参考价值，需要的朋友可以参考一下。

在PHP 7.4及更高版本中，将array_key_exists()函数用于对象属性检测的行为已被废弃并最终移除。本文将详细阐述这一变化的原因，并指导开发者如何正确使用property_exists()作为现代且推荐的替代方案，同时区分其与isset()的用途，确保代码的兼容性、健壮性与可维护性。

array_key_exists()与对象：历史、废弃与移除

在PHP 7.4.0版本之前，array_key_exists()函数除了用于检测数组键是否存在外，也曾意外地支持检测对象的属性是否存在。这种行为是出于向后兼容性考虑，但它混淆了数组和对象的概念，导致语义上的不清晰。为了使语言更加一致和严谨，PHP核心开发团队决定在PHP 7.4.0中废弃这一行为，并在PHP 8.0.0中彻底移除了对对象的支持。

这意味着，如果您的代码在PHP 7.4或更高版本中仍然使用array_key_exists()来检查对象的属性，将会收到废弃警告，并在PHP 8.0及更高版本中导致运行时错误。

property_exists()：检测对象属性的正确选择

为了专门且清晰地检测对象属性是否存在，PHP提供了property_exists()函数。这是处理对象属性存在性检查的官方且推荐的方法。

1. property_exists()的语法与参数顺序

property_exists()函数的语法如下：

property_exists(object|string $object, string $property): bool

• $object: 必需参数，可以是对象实例，也可以是类名（字符串形式）。
• $property: 必需参数，要检查的属性名称（字符串形式）。

重要提示： 请注意property_exists()的参数顺序与array_key_exists()是相反的。array_key_exists()是array_key_exists(key, array)，而property_exists()是property_exists(object, property)。

2. 代码示例：从array_key_exists()到property_exists()的迁移

假设我们有一个JSON数据，将其解码为数组，然后转换为对象，并需要检查某个键（属性）是否存在：

原始（PHP 7.4+可能出现警告/错误）代码：

<?php
$jsonData = '{ "name": "Alice", "age": 30, "city": "New York" }';
$unsortedData = json_decode($jsonData, true); // 解码为关联数组

// 将数组转换为对象
$object = (object) $unsortedData;

$key = 'age'; // 假设要检查的属性
$keyData = "false";

// 在PHP 7.4+中，这里会收到array_key_exists()用于对象的废弃警告或错误
if(array_key_exists($key, $object))
{
    $keyData = "true";
}

echo "使用 array_key_exists() 检查 '$key' 的结果: " . $keyData . PHP_EOL;

$key = 'country'; // 检查不存在的属性
$keyData = "false";
if(array_key_exists($key, $object))
{
    $keyData = "true";
}
echo "使用 array_key_exists() 检查 '$key' 的结果: " . $keyData . PHP_EOL;
?>

修正后的代码（使用property_exists()）：

<?php
$jsonData = '{ "name": "Alice", "age": 30, "city": "New York" }';
$unsortedData = json_decode($jsonData, true);

// 将数组转换为对象
$object = (object) $unsortedData;

$key = 'age'; // 假设要检查的属性
$keyData = "false";

// 使用 property_exists() 检查对象属性
// 注意参数顺序：先对象，后属性名
if(property_exists($object, $key))
{
    $keyData = "true";
}

echo "使用 property_exists() 检查 '$key' 的结果: " . $keyData . PHP_EOL; // 输出: true

$key = 'country'; // 检查不存在的属性
$keyData = "false";
if(property_exists($object, $key))
{
    $keyData = "true";
}
echo "使用 property_exists() 检查 '$key' 的结果: " . $keyData . PHP_EOL; // 输出: false
?>

isset()与property_exists()的区别

虽然property_exists()是检查对象属性是否存在的最直接方法，但开发者有时会考虑使用isset()。理解两者的区别至关重要：

• property_exists($object, $property):

  • 检查对象中是否存在指定的属性，无论该属性的值是null还是其他任何值。
  • 它不关心属性的可访问性（公共、受保护、私有），只要属性被定义就返回true。
  • 即使属性被设置为null，只要它存在，property_exists()也会返回true。

• isset($object->property):

  • 检查对象中是否存在指定的公共属性，并且该属性的值不为null。
  • 如果属性不存在，或者属性存在但其值为null，isset()都会返回false。
  • isset()只能检查可访问的属性（通常是public属性）。对于protected或private属性，直接使用isset($object->property)会触发错误或警告。

示例对比：

<?php
class MyClass {
    public $publicProperty = 'value';
    public $nullProperty = null;
    protected $protectedProperty = 'protected';
    private $privateProperty = 'private';
}

$obj = new MyClass();

// 1. 检查存在的非null公共属性
echo "property_exists(\$obj, 'publicProperty'): " . (property_exists($obj, 'publicProperty') ? 'true' : 'false') . PHP_EOL; // true
echo "isset(\$obj->publicProperty): " . (isset($obj->publicProperty) ? 'true' : 'false') . PHP_EOL;       // true

// 2. 检查存在的null公共属性
echo "property_exists(\$obj, 'nullProperty'): " . (property_exists($obj, 'nullProperty') ? 'true' : 'false') . PHP_EOL;     // true
echo "isset(\$obj->nullProperty): " . (isset($obj->nullProperty) ? 'true' : 'false') . PHP_EOL;             // false (因为值为null)

// 3. 检查不存在的属性
echo "property_exists(\$obj, 'nonExistentProperty'): " . (property_exists($obj, 'nonExistentProperty') ? 'true' : 'false') . PHP_EOL; // false
// echo "isset(\$obj->nonExistentProperty): " . (isset($obj->nonExistentProperty) ? 'true' : 'false') . PHP_EOL; // 会产生警告：Undefined property

// 4. 检查受保护或私有属性 (property_exists可以，isset不可以)
echo "property_exists(\$obj, 'protectedProperty'): " . (property_exists($obj, 'protectedProperty') ? 'true' : 'false') . PHP_EOL; // true
// echo "isset(\$obj->protectedProperty): " . (isset($obj->protectedProperty) ? 'true' : 'false') . PHP_EOL; // 错误：Cannot access protected property
?>

总结与最佳实践

为了确保代码的现代性、兼容性和健壮性，当您需要检查一个对象是否拥有某个属性时，请始终使用property_exists()函数。

• 对于数组键的存在性检查，继续使用array_key_exists()。
• 对于对象属性的存在性检查，请使用property_exists()。
• 如果您需要检查一个对象属性是否存在且其值不为null，并且该属性是可访问的，那么可以使用isset($object->property)。但请注意其对null值和访问权限的限制。

遵循这些最佳实践将帮助您编写出更清晰、更易于维护且与PHP最新版本兼容的代码。

好了，本文到此结束，带大家了解了《PHP对象属性检测：替代array_key_exists方法》，希望本文对你有所帮助！关注golang学习网公众号，给大家分享更多文章知识！