本篇文章給大家詳細介紹一下PHP中的反射機制。有一定的參考價值,有需要的朋友可以參考一下,希望對大家有所幫助。
PHP的反射機制提供了一套反射API,用來訪問和使用類、方法、屬性、參數(shù)和注釋等,比如可以通過一個對象知道這個對象所屬的類,這個類包含哪些方法,這些方法需要傳入什么參數(shù),每個參數(shù)是什么類型等等,不用創(chuàng)建類的實例也可以訪問類的成員和方法,就算類成員定義為 private也可以在外部訪問。
官方文檔提供了諸如 ReflectionClass、ReflectionMethod、ReflectionObject、ReflectionExtension
等反射類及相應(yīng)的API,用得最多的是 ReflectionClass
。
為了演示反射效果,首先創(chuàng)建一個類(假設(shè)定義了一個類 User),并實例化?;谶@個實例,反射類可以訪問 User 中的屬性和方法。
<?php /** * 用戶相關(guān)類 */ class User { public $username; private $password; public function __construct($username, $password) { $this->username = $username; $this->password = $password; } /** * 獲取用戶名 * @return string */ public function getUsername() { return $this->username; } /** * 設(shè)置用戶名 * @param string $username */ public function setUsername($username) { $this->username = $username; } /** * 獲取密碼 * @return string */ private function getPassword() { return $this->password; } /** * 設(shè)置密碼 * @param string $password */ private function setPassowrd($password) { $this->password = $password; } }
創(chuàng)建反射類實例
$refClass = new ReflectionClass(new User('liulu', '123456')); // 也可以寫成 $refClass = new ReflectionClass('User'); // 將類名User作為參數(shù),建立User類的反射類
反射屬性
$properties = $refClass->getProperties(); // 獲取User類的所有屬性,返回ReflectionProperty的數(shù)組 $property = $refClass->getProperty('password'); // 獲取User類的password屬性 //$properties 結(jié)果如下: Array ( [0] => ReflectionProperty Object ( [name] => username [class] => User ) [1] => ReflectionProperty Object ( [name] => password [class] => User ) ) //$property 結(jié)果如下: ReflectionProperty Object ( [name] => password [class] => User )
反射方法
$methods = $refClass->getMethods(); // 獲取User類的所有方法,返回ReflectionMethod數(shù)組 $method = $refClass->getMethod('getUsername'); // 獲取User類的getUsername方法 //$methods 結(jié)果如下: Array ( [0] => ReflectionMethod Object ( [name] => __construct [class] => User ) [1] => ReflectionMethod Object ( [name] => getUsername [class] => User ) [2] => ReflectionMethod Object ( [name] => setUsername [class] => User ) [3] => ReflectionMethod Object ( [name] => getPassword [class] => User ) [4] => ReflectionMethod Object ( [name] => setPassowrd [class] => User ) ) //$method 結(jié)果如下: ReflectionMethod Object ( [name] => getUsername [class] => User )
反射注釋
$classComment = $refClass->getDocComment(); // 獲取User類的注釋文檔,即定義在類之前的注釋 $methodComment = $refClass->getMethod('setPassowrd')->getDocComment(); // 獲取User類中setPassowrd方法的注釋 //$classComment 結(jié)果如下: /** * 用戶相關(guān)類 */ //$methodComment 結(jié)果如下: /** * 設(shè)置密碼 * @param string $password */
反射實例化
$instance = $refClass->newInstance('admin', 123, '***'); // 從指定的參數(shù)創(chuàng)建一個新的類實例 //$instance 結(jié)果如下: User Object ( [username] => admin [password:User:private] => 123 ) 注:雖然構(gòu)造函數(shù)中是兩個參數(shù),但是newInstance方法接受可變數(shù)目的參數(shù),用于傳遞到類的構(gòu)造函數(shù)。 $params = ['xiaoming', 'asdfg']; $instance = $refClass->newInstanceArgs($params); // 從給出的參數(shù)創(chuàng)建一個新的類實例 //$instance 結(jié)果如下: User Object ( [username] => xiaoming [password:User:private] => asdfg )
訪問、執(zhí)行類的公有方法——public
$instance->setUsername('admin_1'); // 調(diào)用User類的實例調(diào)用setUsername方法設(shè)置用戶名 $username = $instance->getUsername(); // 用過User類的實例調(diào)用getUsername方法獲取用戶名 echo $username . "n"; // 輸出 admin_1 // 也可以寫成 $refClass->getProperty('username')->setValue($instance, 'admin_2'); // 通過反射類ReflectionProperty設(shè)置指定實例的username屬性值 $username = $refClass->getProperty('username')->getValue($instance); // 通過反射類ReflectionProperty獲取username的屬性值 echo $username . "n"; // 輸出 admin_2 // 還可以寫成 $refClass->getMethod('setUsername')->invoke($instance, 'admin_3'); // 通過反射類ReflectionMethod調(diào)用指定實例的方法,并且傳送參數(shù) $value = $refClass->getMethod('getUsername')->invoke($instance); // 通過反射類ReflectionMethod調(diào)用指定實例的方法 echo $value . "n"; // 輸出 admin_3
訪問、執(zhí)行類的非公有方法——private、protected
try { // 正確寫法 $property = $refClass->getProperty('password'); // ReflectionProperty Object ( [name] => password [class] => User ) $property->setAccessible(true); // 修改 $property 對象的可訪問性 $property->setValue($instance, '987654321'); // 可以執(zhí)行 $value = $property->getValue($instance); // 可以執(zhí)行 echo $value . "n"; // 輸出 987654321 // 錯誤寫法 $refClass->getProperty('password')->setAccessible(true); // 臨時修改ReflectionProperty對象的可訪問性 $refClass->getProperty('password')->setValue($instance, 'password'); // 不能執(zhí)行,拋出不能訪問異常 $refClass = $refClass->getProperty('password')->getValue($instance); // 不能執(zhí)行,拋出不能訪問異常 $refClass = $instance->password; // 不能執(zhí)行,類本身的屬性沒有被修改,仍然是private } catch (Exception $e){ echo $e; } // 錯誤寫法 結(jié)果如下: ReflectionException: Cannot access non-public member User::password in xxx.php
小結(jié)
不管反射類中定義的屬性、方法是否為 public
,都可以獲取到。 直接訪問 protected
或則 private
的屬性、方法,會拋出異常。 訪問非公有成員需要調(diào)用指定的 ReflectionProperty
或 ReflectionMethod
對象 setAccessible(true)
方法。
推薦學(xué)習(xí):《PHP視頻教程》