PHP中的反射機制-php教程-PHP中文網

反射通常被定義為程式在執行時檢查自身並修改其邏輯的能力。用不太專業的術語來說，反射是要求一個物件告訴您它的屬性和方法，並更改這些成員（甚至是私有成員）。在本課程中，我們將深入探討如何實現這一點，以及何時它可能有用。

#一點歷史

在程式設計時代的初期，出現了組合語言。用組譯語言編寫的程式駐留在電腦內部的實體暫存器。透過讀取寄存器可以隨時檢查其組成、方法和值。更重要的是，您可以在程式運行時透過簡單地修改這些暫存器來更改程式。它需要對正在運行的程式有一些深入的了解，但它本質上是反思性的。

與任何很酷的玩具一樣，使用反射，但不要濫用它。

隨著高階程式語言（如 C）的出現，這種反射性逐漸消失。後來它透過物件導向程式設計重新引入。

如今，大多數程式語言都可以使用反射。靜態型別語言（例如 Java）在反射方面幾乎沒有問題。然而，我發現有趣的是，任何動態類型語言（如 PHP 或 Ruby）都很大程度上是基於反射。如果沒有反射的概念，鴨子類型很可能無法實現。當您將物件傳送到另一個物件（例如參數）時，接收物件無法知道該物件的結構和類型。它所能做的就是使用反射來識別可以在接收的物件上呼叫和不能呼叫的方法。

一個簡單的例子

反射在 PHP 中很普遍。事實上，有幾種情況您可能會在不知情的情況下使用它。例如：

// Nettuts.php

require_once 'Editor.php';

class Nettuts {

	function publishNextArticle() {
		$editor = new Editor('John Doe');
		$editor->setNextArticle('135523');
		$editor->publish();
	}

}

登入後複製

還有：

// Editor.php

class Editor {

	private $name;
	public $articleId;

	function __construct($name) {
		$this->name = $name;
	}

	public function setNextArticle($articleId) {
		$this->articleId = $articleId;
	}

	public function publish() {
		// publish logic goes here
		return true;
	}

}

登入後複製

在此程式碼中，我們直接呼叫具有已知類型的本機初始化變數。在 publishNextArticle() 中建立編輯器，可以明顯看出 $editor 變數的類型為 Editor。這裡不需要反射，但是我們引入一個新類，名為Manager：

// Manager.php

require_once './Editor.php';
require_once './Nettuts.php';

class Manager {

	function doJobFor(DateTime $date) {
		if ((new DateTime())->getTimestamp() > $date->getTimestamp()) {
			$editor = new Editor('John Doe');
			$nettuts = new Nettuts();
			$nettuts->publishNextArticle($editor);
		}
	}

}

登入後複製

接下來，修改 Nettuts，如下：

// Nettuts.php

class Nettuts {

	function publishNextArticle($editor) {
		$editor->setNextArticle('135523');
		$editor->publish();
	}

}

登入後複製

現在，Nettuts 與 Editor 類別完全沒有關係。它不包含它的文件，它不初始化它的類，它甚至不知道它的存在。我可以將任何類型的物件傳遞到 publishNextArticle() 方法中，程式碼就可以工作。

PHP中的反射機制

#從這個類別圖中可以看到，Nettuts只與Manager有直接關係。 Manager 建立它，因此 Manager 依賴 Nettuts。但是 Nettuts 不再與 Editor 類別有任何關係，並且 Editor 僅與 Manager 相關。

在運行時，Nettuts 使用 Editor 對象，因此有 <> 和問號。在運行時，PHP 檢查接收到的物件並驗證它是否實作了 setNextArticle() 和 publish() 方法。

物件成員資訊

我們可以讓 PHP 顯示物件的詳細資訊。讓我們建立一個 PHPUnit 測試來幫助我們輕鬆測試我們的程式碼：

// ReflectionTest.php

require_once '../Editor.php';
require_once '../Nettuts.php';

class ReflectionTest extends PHPUnit_Framework_TestCase {

	function testItCanReflect() {
		$editor = new Editor('John Doe');
		$tuts = new Nettuts();
		$tuts->publishNextArticle($editor);
	}

}

登入後複製

現在，將 var_dump() 加入到 Nettuts:

// Nettuts.php

class NetTuts {

	function publishNextArticle($editor) {
		$editor->setNextArticle('135523');
		$editor->publish();
		var_dump(new ReflectionClass($editor));
	}

}

登入後複製

執行測試，並觀察輸出中發生的奇蹟：

PHPUnit 3.6.11 by Sebastian Bergmann.

.object(ReflectionClass)#197 (1) {
  ["name"]=>
  string(6) "Editor"
}


Time: 0 seconds, Memory: 2.25Mb

OK (1 test, 0 assertions)

登入後複製

我們的反射類別有一個 name 屬性，設定為 $editor 變數的原始類型：Editor，但這並不是太多資訊。 Editor 的方法怎麼樣？

// Nettuts.php

class Nettuts {

	function publishNextArticle($editor) {
		$editor->setNextArticle('135523');
		$editor->publish();

		$reflector = new ReflectionClass($editor);
		var_dump($reflector->getMethods());
	}

}

登入後複製

在此程式碼中，我們將反射類別的實例指派給 $reflector 變量，以便我們現在可以觸發其方法。 ReflectionClass 公開了大量可用於取得物件資訊的方法。其中一個方法是 getMethods()，它傳回一個包含每個方法資訊的陣列。

PHPUnit 3.6.11 by Sebastian Bergmann.

.array(3) {
  [0]=>
  &object(ReflectionMethod)#196 (2) {
    ["name"]=>
    string(11) "__construct"
    ["class"]=>
    string(6) "Editor"
  }
  [1]=>
  &object(ReflectionMethod)#195 (2) {
    ["name"]=>
    string(14) "setNextArticle"
    ["class"]=>
    string(6) "Editor"
  }
  [2]=>
  &object(ReflectionMethod)#194 (2) {
    ["name"]=>
    string(7) "publish"
    ["class"]=>
    string(6) "Editor"
  }
}

Time: 0 seconds, Memory: 2.25Mb

OK (1 test, 0 assertions)

登入後複製

另一個方法，getProperties()，檢索物件的屬性（甚至是私有屬性！）：

PHPUnit 3.6.11 by Sebastian Bergmann.

.array(2) {
  [0]=>
  &object(ReflectionProperty)#196 (2) {
    ["name"]=>
    string(4) "name"
    ["class"]=>
    string(6) "Editor"
  }
  [1]=>
  &object(ReflectionProperty)#195 (2) {
    ["name"]=>
    string(9) "articleId"
    ["class"]=>
    string(6) "Editor"
  }
}

Time: 0 seconds, Memory: 2.25Mb

OK (1 test, 0 assertions)

登入後複製

從getMethod() 和getProperties() 傳回的陣列中的元素分別為ReflectionMethod 和ReflectionProperty 類型；這些物件非常有用：

// Nettuts.php

class Nettuts {

	function publishNextArticle($editor) {
		$editor->setNextArticle('135523');
		$editor->publish(); // first call to publish()

		$reflector = new ReflectionClass($editor);
		$publishMethod = $reflector->getMethod('publish');
		$publishMethod->invoke($editor); // second call to publish()
	}

}

登入後複製

這裡，我們使用 getMethod() 來檢索名稱為「publish」的單一方法；其結果是 ReflectionMethod 物件。然後，我們呼叫 invoke() 方法，並向其傳遞 $editor 對象，以便再次執行編輯器的 publish() 方法。

在我们的例子中，这个过程很简单，因为我们已经有一个 Editor 对象传递给 invoke()。在某些情况下，我们可能有多个 Editor 对象，这使我们可以自由选择使用哪个对象。在其他情况下，我们可能没有可以使用的对象，在这种情况下，我们需要从 ReflectionClass 获取一个对象。

我们来修改Editor的publish()方法来演示双重调用：

// Editor.php

class Editor {

	[ ... ]

	public function publish() {
		// publish logic goes here
		echo ("HERE\n");
		return true;
	}

}

登入後複製

新的输出：

PHPUnit 3.6.11 by Sebastian Bergmann.

.HERE
HERE

Time: 0 seconds, Memory: 2.25Mb

OK (1 test, 0 assertions)

登入後複製

操作实例数据

我们还可以在执行时修改代码。修改没有公共设置器的私有变量怎么样？让我们向 Editor 添加一个方法来检索编辑器的名称：

// Editor.php

class Editor {

	private $name;
	public $articleId;

	function __construct($name) {
		$this->name = $name;
	}

	[ ... ]

	function getEditorName() {
		return $this->name;
	}

}

登入後複製

这个新方法被称为 getEditorName()，并且仅返回私有 $name 变量的值。 $name 变量是在创建时设置的，我们没有公共方法可以让我们更改它。但我们可以使用反射来访问这个变量。您可能首先尝试更明显的方法：

// Nettuts.php

class Nettuts {

	function publishNextArticle($editor) {
		var_dump($editor->getEditorName());

		$reflector = new ReflectionClass($editor);
		$editorName = $reflector->getProperty('name');
		$editorName->getValue($editor);

	}

}

登入後複製

尽管这会在 var_dump() 行输出值，但在尝试通过反射检索该值时会引发错误：

PHPUnit 3.6.11 by Sebastian Bergmann.

Estring(8) "John Doe"


Time: 0 seconds, Memory: 2.50Mb

There was 1 error:

1) ReflectionTest::testItCanReflect
ReflectionException: Cannot access non-public member Editor::name

[...]/Reflection in PHP/Source/NetTuts.php:13
[...]/Reflection in PHP/Source/Tests/ReflectionTest.php:13
/usr/bin/phpunit:46

FAILURES!
Tests: 1, Assertions: 0, Errors: 1.

登入後複製

为了解决这个问题，我们需要请求 ReflectionProperty 对象授予我们访问私有变量和方法的权限：

// Nettuts.php

class Nettuts {

	function publishNextArticle($editor) {
		var_dump($editor->getEditorName());

		$reflector = new ReflectionClass($editor);
		$editorName = $reflector->getProperty('name');
		$editorName->setAccessible(true);
		var_dump($editorName->getValue($editor));
	}

}

登入後複製

调用 setAccessible() 并传递 true 可以解决问题：

PHPUnit 3.6.11 by Sebastian Bergmann.

.string(8) "John Doe"
string(8) "John Doe"


Time: 0 seconds, Memory: 2.25Mb

OK (1 test, 0 assertions)

登入後複製

如您所见，我们已成功读取私有变量。第一行输出来自对象自己的 getEditorName() 方法，第二行来自反射。但是改变私有变量的值又如何呢？使用 setValue() 方法：

// Nettuts.php

class Nettuts {

	function publishNextArticle($editor) {
		var_dump($editor->getEditorName());

		$reflector = new ReflectionClass($editor);
		$editorName = $reflector->getProperty('name');
		$editorName->setAccessible(true);
		$editorName->setValue($editor, 'Mark Twain');
		var_dump($editorName->getValue($editor));
	}

}

登入後複製

就是这样。此代码将“John Doe”更改为“Mark Twain”。

PHPUnit 3.6.11 by Sebastian Bergmann.

.string(8) "John Doe"
string(10) "Mark Twain"


Time: 0 seconds, Memory: 2.25Mb

OK (1 test, 0 assertions)

登入後複製

间接反射的使用

PHP 的一些内置功能间接使用反射，其中一个是 call_user_func() 函数。

回调

call_user_func() 函数接受一个数组：第一个元素指向对象，第二个元素指向方法的名称。您可以提供一个可选参数，然后将其传递给被调用的方法。例如：

// Nettuts.php

class Nettuts {

	function publishNextArticle($editor) {
		var_dump($editor->getEditorName());

		$reflector = new ReflectionClass($editor);
		$editorName = $reflector->getProperty('name');
		$editorName->setAccessible(true);
		$editorName->setValue($editor, 'Mark Twain');
		var_dump($editorName->getValue($editor));

		var_dump(call_user_func(array($editor, 'getEditorName')));
	}

}

登入後複製

以下输出表明代码检索了正确的值：

PHPUnit 3.6.11 by Sebastian Bergmann.

.string(8) "John Doe"
string(10) "Mark Twain"
string(10) "Mark Twain"


Time: 0 seconds, Memory: 2.25Mb

OK (1 test, 0 assertions)

登入後複製

使用变量的值

间接反射的另一个示例是通过变量中包含的值来调用方法，而不是直接调用它。例如：

// Nettuts.php

class Nettuts {

	function publishNextArticle($editor) {
		var_dump($editor->getEditorName());

		$reflector = new ReflectionClass($editor);
		$editorName = $reflector->getProperty('name');
		$editorName->setAccessible(true);
		$editorName->setValue($editor, 'Mark Twain');
		var_dump($editorName->getValue($editor));

		$methodName = 'getEditorName';
		var_dump($editor->$methodName());
	}

}

登入後複製

此代码产生与前面示例相同的输出。 PHP 只是用它所代表的字符串替换该变量并调用该方法。当您想通过使用类名变量来创建对象时，它甚至可以工作。