PHP中区分类声明属性与动态属性的方法
本文详细介绍了在php中如何区分一个对象的属性是预先在类中声明的还是在运行时动态添加的。通过结合使用`get_class_vars()`和`get_object_vars()`这两个核心函数，并利用`array_diff_key()`进行比较，可以高效准确地识别出对象的动态属性，从而更好地理解和管理对象的内部状态。
在PHP中，对象的属性可以分为两种主要类型：在类定义中明确声明的属性（Declared Properties）和在对象实例化后动态添加的属性（Dynamic Properties）。理解这两种属性的区别对于编写健壮和可维护的代码至关重要，尤其是在进行对象内省或处理来自外部源的数据时。本教程将指导您如何通过编程方式识别这两种属性。
声明属性与动态属性的概念
- 声明属性（Declared Properties）：这些属性在类的定义内部使用public, protected, private等访问修饰符明确声明。它们是类结构的一部分，并且在对象实例化时通常具有默认值（即使是null）。
- 动态属性（Dynamic Properties）：这些属性不在类的定义中声明，而是在对象实例化后，通过直接赋值的方式在运行时添加到对象上的。PHP允许这种灵活性，但过度使用动态属性可能导致代码难以理解和维护，尤其是在PHP 8.2及更高版本中，动态属性的创建已被弃用并可能触发警告。
识别动态属性的方法
识别动态属性的核心思想是比较一个类的“默认”属性集合与一个特定对象实例的“当前”属性集合。
核心函数介绍
-
get_class_vars(string $class_name):
- 此函数返回一个由类的默认静态属性组成的关联数组。这里的“默认”指的是在类定义中声明的属性及其默认值。它不包括在对象实例化后动态添加的属性。
- 即使属性不是静态的，get_class_vars也会返回所有声明的非静态属性的默认值。
- 返回的数组键是属性名，值是其默认值。
-
get_object_vars(object $object):
- 此函数返回一个由指定对象的所有可访问属性组成的关联数组。这包括在类中声明的属性（及其当前值）以及在运行时动态添加的属性。
- 返回的数组键是属性名，值是其当前值。
-
get_class(object $object):
- 此函数返回给定对象所属的类的名称。这使得我们的解决方案可以适用于任何对象，而无需硬编码类名。
-
array_diff_key(array $array1, array $array2, ...):
- 此函数比较两个（或更多）数组的键，并返回在$array1中存在但不在任何其他数组中存在的键值对。
- 通过比较get_object_vars的结果与get_class_vars的结果，我们可以找出那些只存在于对象实例中（即动态添加的）而不在类声明中的属性。
实施步骤与示例
我们将通过一个具体的PHP代码示例来演示如何识别动态属性。
示例代码：
bar = 'declared_value'; // 为声明属性赋值 $obj->baz = 1; // 动态添加属性 $obj->qux = 'dynamic_value'; // 再次动态添加属性 echo "--- 原始对象信息 ---\n"; var_dump($obj); echo "\n"; // 步骤1: 获取类的所有声明属性及其默认值 // 注意：get_class_vars会返回所有声明的属性，包括protected和private $declared_properties_defaults = get_class_vars(get_class($obj)); echo "--- 类的声明属性及其默认值 (get_class_vars) ---\n"; print_r($declared_properties_defaults); echo "\n"; // 步骤2: 获取对象实例的所有可访问属性及其当前值 // 注意：get_object_vars在当前作用域（全局作用域）下，只会返回public属性 $all_object_properties = get_object_vars($obj); echo "--- 对象实例的所有可访问属性 (get_object_vars) ---\n"; print_r($all_object_properties); echo "\n"; // 步骤3: 识别动态属性 // 动态属性是存在于 $all_object_properties 中，但不存在于 $declared_properties_defaults 中的属性 $dynamic_properties = array_diff_key($all_object_properties, $declared_properties_defaults); echo "--- 识别出的动态属性 ---\n"; print_r($dynamic_properties); echo "\n"; // 进一步验证：识别声明属性 $actual_declared_properties = array_diff_key($all_object_properties, $dynamic_properties); echo "--- 识别出的实际声明属性 (当前值) ---\n"; print_r($actual_declared_properties); ?>
输出结果：
--- 原始对象信息 ---
object(Foo)#1 (5) {
["bar"]=>
string(14) "declared_value"
["protectedProp":protected]=>
string(9) "protected"
["privateProp":"Foo":private]=>
string(7) "private"
["baz"]=>
int(1)
["qux"]=>
string(13) "dynamic_value"
}
--- 类的声明属性及其默认值 (get_class_vars) ---
Array
(
[bar] =>
[protectedProp] => protected
[privateProp] => private
)
--- 对象实例的所有可访问属性 (get_object_vars) ---
Array
(
[bar] => declared_value
[baz] => 1
[qux] => dynamic_value
)
--- 识别出的动态属性 ---
Array
(
[baz] => 1
[qux] => dynamic_value
)
--- 识别出的实际声明属性 (当前值) ---
Array
(
[bar] => declared_value
)结果分析：
- get_class_vars(get_class($obj)) 返回了Foo类中声明的所有属性bar, protectedProp, privateProp及其默认值。
- get_object_vars($obj) 返回了对象$obj当前所有可访问的公共属性：bar (其当前值), baz和qux。请注意，由于是在全局作用域下调用，protectedProp和privateProp作为非公共属性，不会出现在get_object_vars的结果中。
- 通过array_diff_key($all_object_properties, $declared_properties_defaults)，我们成功地找出了$baz和$qux，它们是只存在于$all_object_properties中而不在$declared_properties_defaults中的属性，这正是动态属性的特征。
- 反过来，array_diff_key($all_object_properties, $dynamic_properties)则可以得到对象实例中当前声明属性的值。
注意事项
- 可见性限制：get_object_vars()只返回当前作用域可访问的属性。如果在类外部调用，它将只返回public属性。如果您需要在类内部识别所有类型的动态属性（包括与protected或private声明属性同名的动态属性），则应在类的方法中调用get_object_vars($this)。然而，get_class_vars()总是返回所有声明的属性，无论其可见性如何。
- PHP 8.2+ 动态属性弃用：从PHP 8.2开始，在不声明属性的情况下动态创建属性已被弃用。这意味着在默认情况下，尝试创建动态属性将发出Deprecation警告。在PHP 9.0中，这可能成为一个错误。如果您需要使用动态属性，可以通过在类上添加#[AllowDynamicProperties]属性来明确允许。
- 性能考虑：对于性能敏感的应用，频繁地进行属性内省操作可能会带来一定的开销。在大多数情况下，应尽量避免过度依赖动态属性，并优先使用声明属性来保持代码的清晰性和可预测性。
总结
通过本教程，您已经掌握了在PHP中区分对象的声明属性和动态属性的方法。利用get_class_vars()获取类的默认声明属性，get_object_vars()获取对象的所有当前属性，再结合array_diff_key()进行比较，可以高效准确地识别出动
态属性。这一技巧在需要进行对象内省、调试或实现特定设计模式时非常有用，但请务必注意PHP版本对动态属性的支持和相关最佳实践。
