什么是php反射機(jī)制以及利用php反射機(jī)制實(shí)現(xiàn)可插拔可擴(kuò)展的插件架構(gòu)

lin — Thu, 25 Aug 2011 16:06:34 +0000

反射是什么？
它是指在PHP運(yùn)行狀態(tài)中，擴(kuò)展分析PHP程序，導(dǎo)出或提取出關(guān)于類、方法、屬性、參數(shù)等的詳細(xì)信息，包括注釋。這種動(dòng)態(tài)獲取的信息以及動(dòng)態(tài)調(diào)用對(duì)象的方法的功能稱為反射API。

反射是操縱面向?qū)ο蠓缎椭性Ｐ偷腁PI，其功能十分強(qiáng)大，可幫助我們構(gòu)建復(fù)雜，可擴(kuò)展的應(yīng)用。其用途如：自動(dòng)加載插件，自動(dòng)生成文檔，甚至可用來擴(kuò)充PHP語言。php反射api由若干類組成，可幫助我們用來訪問程序的元數(shù)據(jù)或者同相關(guān)的注釋交互。借助反射我們可以獲取諸如類實(shí)現(xiàn)了那些方法，創(chuàng)建一個(gè)類的實(shí)例（不同于用new創(chuàng)建），調(diào)用一個(gè)方法（也不同于常規(guī)調(diào)用），傳遞參數(shù)，動(dòng)態(tài)調(diào)用類的靜態(tài)方法。
*
**
反射api是php內(nèi)建的oop技術(shù)擴(kuò)展，包括一些類，異常和接口，綜合使用他們可用來幫助我們分析其它類，接口，方法，屬性，方法和擴(kuò)展。這些oop擴(kuò)展被稱為反射，位于php源碼/ext/reflection目錄下。

可以使用反射api自省反射api本身（這可能就是反射最初的意思，自己"看"自己）：
Reflection::export(new ReflectionExtension('reflection'));
?>
幾乎所有的反射api都實(shí)現(xiàn)了reflector接口，所有實(shí)現(xiàn)該接口的類都有一個(gè)export方法，該方法打印出參數(shù)對(duì)象的相關(guān)信息。
使用get_declared_classes()獲取所有php內(nèi)置類，get_declared_interfaces();
get_defined_functions();
get_defined_vars(); get_defined_constants();可獲取php接口，方法，變量，常量信息。

**
***
反射初探：
//定義一個(gè)自定義類
class MyTestClass{

public function testFunc($para0='defaultValue0'){

}
}
//接下來反射它
foreach(get_declared_classes() as $class){
//實(shí)例化一個(gè)反射類
$reflectionClass = new ReflectionClass($class);
//如果該類是自定義類
if($reflectionClass->isUserDefined()){
//導(dǎo)出該類信息
Reflection::export($reflectionClass);
}
}
?>
以上片段實(shí)例如何查看自定義類的基本信息。
描述數(shù)據(jù)的數(shù)據(jù)被稱為元數(shù)據(jù)，用反射獲取的信息就是元數(shù)據(jù)信息，這些信息用來描述類，接口方法等等。（元---》就是原始之意，比如元模型就是描述模型的模型，比如UML元模型就是描述UML結(jié)構(gòu)的模型），元數(shù)據(jù)進(jìn)一步可分為硬元數(shù)據(jù)（hard matadata）和軟元數(shù)據(jù)（soft metadata）,前者由編譯代碼導(dǎo)出，如類名字，方法，參數(shù)等。
后者是人為加入的數(shù)據(jù)，如phpDoc塊，php中的屬性等。
***
****
現(xiàn)在商業(yè)軟件很多都是基于插件架構(gòu)的，比如eclipse，和visual studio，netbeans等一些著名IDE都是基于插件的GUI應(yīng)用。第三方或本方開發(fā)插件時(shí)，必須導(dǎo)入定義好的相關(guān)接口，然后實(shí)現(xiàn)這些接口，最后把實(shí)現(xiàn)的包放在指定目錄下，宿主應(yīng)用程序在啟動(dòng)時(shí)自動(dòng)檢測(cè)所有的插件實(shí)現(xiàn)，并加載它們。如果我們自己想實(shí)現(xiàn)這樣的架構(gòu)也是可能的。
//先定義UI接口
interface IPlugin {
//獲取插件的名字
public static function getName();
//要顯示的菜單項(xiàng)
function getMenuItems();
//要顯示的文章
function getArticles();
//要顯示的導(dǎo)航欄
function getSideBars();
}
//一下是對(duì)插件接口的實(shí)現(xiàn)
class SomePlugin implements IPlugin {
public function getMenuItems() {
//返回菜單項(xiàng)
return null;
}
public function getArticles() {
//返回我們的文章
return null;
}
public function getSideBars() {
//我們有一個(gè)導(dǎo)航欄
return array('SideBarItem');
}
//返回插件名
public static function getName(){
return "SomePlugin";
}
}
?>
php中也有使用插件的解決方案，不像eclipse。

使用我們的插件：1.先使用get_declared_classes()獲取所有已加載類。2.遍歷所有類，判斷其是否實(shí)現(xiàn)了我們自定義的插件接口IPlugin。3.獲取所有的插件實(shí)現(xiàn)。4.在宿主應(yīng)用中與插件交互
下面這個(gè)方法幫助我們找到實(shí)現(xiàn)了插件接口的所有類：
function findPlugins() {
$plugins = array();
foreach(get_declared_classes() as $class) {
$reflectionClass = new ReflectionClass($class);
//判斷一個(gè)類是否實(shí)現(xiàn)了IPlugin接口
if($reflectionClass->implementsInterface('IPlugin')) {
$plugins[] = $reflectionClass;
}
}
return $plugins;
}
注意到所有的插件實(shí)現(xiàn)是作為反射類實(shí)例返回的，而不是類名本身，或是類的實(shí)例。因?yàn)槿绻褂梅瓷鋪碚{(diào)用方法還需要一些條件判斷。

判斷一個(gè)類是否實(shí)現(xiàn)了某個(gè)方法使用反射類的hasMethod（）方法。
接下來我們把所有的插件菜單項(xiàng)放在一個(gè)菜單上。
function integratePlugInMenus() {
$menu = array();
//遍歷所有的插件實(shí)現(xiàn)
foreach(findPlugins() as $plugin) {
//判斷插件是否實(shí)現(xiàn)了getMenuItems方法
if($plugin->hasMethod('getMenuItems')) {
/*實(shí)例化一個(gè)方法實(shí)例（注意當(dāng)你將類和方法看成概念時(shí)，它們就可以有實(shí)例，就像"人"這個(gè)概念一樣），該方法返回的是ReflectionMethod的實(shí)例*/
$reflectionMethod = $plugin->getMethod('getMenuItems');
//如果方法是靜態(tài)的
if($reflectionMethod->isStatic()) {
//調(diào)用靜態(tài)方法，注意參數(shù)是null而不是一個(gè)反射類實(shí)例
$items = $reflectionMethod->invoke(null);
} else {
//如果方法不是靜態(tài)的，則先實(shí)例化一個(gè)反射類實(shí)例所代表的類的實(shí)例。
$pluginInstance = $plugin->newInstance();
//使用反射api來調(diào)用一個(gè)方法，參數(shù)是通過反射實(shí)例化的對(duì)象引用
$items = $reflectionMethod->invoke($pluginInstance);
}
//合并所有的插件菜單項(xiàng)為一個(gè)菜單。
$menu = array_merge($menu, $items);
}
}
return $menu;
}
這里主要用到的反射方法實(shí)例的方法調(diào)用：
public mixed invoke(stdclass object, mixed args=null);
請(qǐng)一定搞清楚我們常規(guī)方法的調(diào)用是這種形式：$objRef->someMethod($argList...);
因?yàn)槭褂昧朔瓷?，這時(shí)你在想調(diào)用一個(gè)方法時(shí)形式變?yōu)椋?br /> $reflectionMethodRef->invoke($reflectionClassRef,$argList...);
如果使用反射調(diào)用方法，我們必須實(shí)例化一個(gè)反射方法的實(shí)例，如果是實(shí)例方法還要有一個(gè)實(shí)例的引用，可能還需傳遞必要的參數(shù)。當(dāng)調(diào)用一個(gè)靜態(tài)方法時(shí)，顯式傳入null作為第一參數(shù)。
對(duì)插件類實(shí)現(xiàn)的其他方法有類似的處理邏輯，這里不再敷述。
以下是我的一個(gè)簡單測(cè)試：
/**
* 定義一個(gè)插件接口
* */
interface IPlugIn
{
/**
* getSidebars()
*
* @return 返回側(cè)導(dǎo)航欄
*/
public function getSidebars();
/**
* GetName()
*
* @return 返回類名
*/
public static function GetName();
}

/*下面是對(duì)插件的實(shí)現(xiàn)，其實(shí)應(yīng)該放在不同的文件中，甚至是不同的包中*/
class MyPlugIn implements IPlugIn
{
public function getSidebars()
{
//構(gòu)造自己的導(dǎo)航欄
$sideBars = '

';
return $sideBars;
}
public static function GetName()
{
return 'MyPlugIn';
}
}
//第二個(gè)插件實(shí)現(xiàn)；
class MyPlugIn2 implements IPlugIn
{
public function getSidebars()
{
//構(gòu)造自己的導(dǎo)航欄
$sideBars = '

';
return $sideBars;
}
public static function GetName()
{
return 'MyPlugIn2';
}
}

//在宿主程序中使用插件
class HostApp
{

public function initAll()
{
// 初始化各個(gè)部分
echo "yiqing95.";
$this->renderAll();
}
//渲染GUI格部分
function renderAll(){
$rsltSidebars="

";
foreach($this->integrateSidebarsOfPlugin() as $sidebarItem){
$rsltSidebars.="";
}
$rsltSidebars.="

$sidebarItem

echo $rsltSidebars;
}
/*加載所有的插件實(shí)現(xiàn)：*/
protected function findPlugins()
{
$plugins = array();
foreach (get_declared_classes() as $class) {
$reflectionClass = new ReflectionClass($class);
if ($reflectionClass->implementsInterface('IPlugin')) {
$plugins[] = $reflectionClass;
}
}
return $plugins;
}
/**加載組裝所有插件實(shí)現(xiàn)***/
protected function integrateSidebarsOfPlugin()
{
$sidebars = array();
foreach ($this->findPlugins() as $plugin) {
if ($plugin->hasMethod('getSidebars')) {
$reflectionMethod = $plugin->getMethod('getSidebars');
if ($reflectionMethod->isStatic()) {
$items = $reflectionMethod->invoke(null);
} else {
$pluginInstance = $plugin->newInstance();
$items = $reflectionMethod->invoke($pluginInstance) ;
}
}
//$sidebars = array_merge($sidebars, $items);
$sidebars[]=$items;
}
return $sidebars;
}

}
//運(yùn)行程序：
$entryClass =new HostApp();
$entryClass->initAll();
?>
****
××××
$reflectionClass = new ReflectionClass("IPlugIn");
echo $reflectionClass-> getDocComment();
這段代碼可以幫助我們獲取類的文檔注釋，一旦我們獲取了類的注釋內(nèi)容我們就可以擴(kuò)展我們的類功能，比如先獲取注釋，然后分析注釋使用docblock tokenizer 『pecl擴(kuò)展』，或使用自帶的Tokenizer類又或者使用正則表達(dá)式，字符串函數(shù)來解析注釋文檔，你可以在注釋中加入任何東西，包括指令，在使用反射調(diào)用前可判斷這些通過注釋傳遞的指令或數(shù)據(jù)：
//"分析相關(guān)的注釋數(shù)據(jù)"
analyse($reflectionClass-> getDocComment());//analyse是自己定義的！??！
//根據(jù)分析的結(jié)果來執(zhí)行方法，或者傳遞參數(shù)等
if(xxxx){
$reflectionMethod->invoke($pluginInstance) ;
}
?>
因?yàn)樽⑨尞吘故亲址?，可以使用任何字符串解析技術(shù)，提取有用的信息，再根據(jù)這些信息來調(diào)用方法，就是說程序的邏輯不光可由方法實(shí)現(xiàn)決定，還可能由注釋決定（前提是你使用了反射，注釋格式嚴(yán)格有要求）。
××××
*****
反射api和其他類一樣可被繼承擴(kuò)展，所以我們可以為這些api添加自己的功能。結(jié)合自定義注釋標(biāo)記。就是以@開頭的東東，標(biāo)注（Java中稱為annotation），.net中稱為屬性attribute（或稱為特性）。然后擴(kuò)展Reflection類，就可以實(shí)現(xiàn)強(qiáng)大的擴(kuò)展功能了。
值得一提的是工廠方法設(shè)計(jì)模式（GOF之一），也常使用反射來實(shí)例化對(duì)象，下面是示例性質(zhì)的偽碼：
Class XXXFactory{
function getInstance($className){
$reflectionClass =new ReflectionClass($className);
return $reflectionClass->newInstance();
}
//使用接口的那個(gè)類實(shí)現(xiàn)，可能來自配置文件
function getInstance(){
$pathOfConfig = "xxx/xx/XXXImplement.php";
$className= Config->getItem($pathOfClass,'SomeClassName');
return $this->getInstance($className);
}
}
*****

最優(yōu)良人 » 反射機(jī)制

什么是php反射機(jī)制以及利用php反射機(jī)制實(shí)現(xiàn)可插拔可擴(kuò)展的插件架構(gòu)