深入理解 PHP 的 7 個預定義介面
阿新 • • 發佈：2018-12-22
深入理解預定義介面
場景：平常工作中寫的都是業務模組，很少會去實現這樣的介面，但是在框架裡面用的倒是很多。
1. Traversable（遍歷）介面
該介面不能被類直接實現，如果直接寫了一個普通類實現了該遍歷介面，是會直接報致命的錯誤，提示使用Iterator（迭代器介面）或者IteratorAggregate（聚合迭代器介面）來實現，這兩個介面後面會介紹；所有通常情況下，我們只是會用來判斷該類是否可以使用foreach來進行遍歷；
class Test implements Traversable { } 上面這個是錯誤示範，該程式碼會提示這樣的錯誤： Fatal error: Class Test must implement interface Traversable as part of either Iterator or IteratorAggregate in Unknown on line 0 上面的大致意思是說如要實現這個介面，必須同Iterator或者IteratorAggregate來實現 正確的做法： 當我們要判斷一個類是否可以使用foreach來進行遍歷，只需要判斷是否是traversable的例項 class Test { } $test = new Test; var_dump($test instanceOf Traversable);
2. Iterator（迭代器）介面
迭代器介面其實實現的原理就是類似指標的移動，當我們寫一個類的時候，通過實現對應的5個方法：key（），current（），next（），rewind（），valid（），就可以實現資料的迭代移動，具體看以下程式碼
<?php class Test implements Iterator { private $key; private $val = [ 'one', 'two', 'three', ]; public function key() { return $this->key; } public function current() { return $this->val[$this->key]; } public function next() { ++$this->key; } public function rewind() { $this->key = 0; } public function valid() { return isset($this->val[$this->key]); } } $test = new Test; $test->rewind(); while($test->valid()) { echo $test->key . ':' . $test->current() . PHP_EOL; $test->next(); } ## 該輸出結果 ： 0: one 1: two 2: three 看了這個原理我們就知道，其實迭代的移動方式：rewind（）-> valid（）->key() -> current() -> next() -> valid（）-> key() ....-> valid(); 好的，理解了上面，我們開啟Iterator的介面，發現它是實現了Traversable（遍歷）介面的，接下來我們來證明下： var_dump($test instanceOf Traversable); 結果返回的是true，證明這個類的物件是可以進行遍歷的。 foreach （$test as $key => $value）{ echo $test->key . ':' . $test->current() . PHP_EOL; } 這個的結果跟while迴圈實現的模式是一樣的。
3. IteratorAggregate（聚合迭代器） 介面
聚合迭代器和迭代器的原理是一樣的，只不過聚合迭代器已經實現了迭代器原理，你只需要實現一個getIterator（）方法來實現迭代，具體看以下程式碼
<?php class Test implements IteratorAggregate { public $one = 1; public $two = 2; public $three = 3; public function __construct() { $this->four = 4; } public function getIterator() { return new AraayIterator($this); } } $test = (new Test())->getIterator(); $test->rewind(); while($test->valid()) { echo $test->key() . ' : ' . $test->current() . PHP_EOL; $test->next(); } 從上面的程式碼，我們可以看到我們將Test類的物件傳進去當做迭代器，通過while迴圈的話，我們必須通過呼叫getIterator（）方法獲取到迭代器物件，然後直接進行迭代輸出，而不需要去實現相關的key()等方法。 當然這個時候，我們肯定想知道是否可以直接從foreach進行迭代迴圈出去呢？那麼我們來列印一下結果 $test = new Test; var_dump($test instanceOf Traversable); 結果是輸出bool true，所以我們接下來是直接用foreach來實現一下。 $test = new Test; foreach($test as $key => $value) { echo $key . ' : ' . $value . PHP_EOL; } 接下來，我們看到是對物件進行迭代，這個時候我們是否可以陣列進行迭代呢？ class Test implements IteratorAggregate { public $data; public function __construct() { $this->data = [''one' => 1 , 'two' => 2]; } public function getIterator() { return new AraayIterator($this->data); } } 同理實現的方式跟對物件進行迭代是一樣的。
4. ArrayAccess（陣列式訪問）介面
通常情況下，我們會看到this['name']這樣的用法，但是我們知道，$this是一個物件，是如何使用陣列方式訪問的？答案就是實現了資料組訪問介面ArrayAccess，具體程式碼如下
<?php
class Test implements ArrayAccess
{
public $container;
public function __construct()
{
$this->container = [
'one' => 1,
'two' => 2,
'three' => 3,
];
}
public function offsetExists($offset)
{
return isset($this->container[$offset]);
}
public function offsetGet($offset)
{
return isset($this->container[$offset]) ? $this->container[$offset] : null;
}
public function offsetSet($offset, $value)
{
if (is_null($offset)) {
$this->container[] = $value;
} else {
$this->container[$offset] = $value;
}
}
public function offsetUnset($offset)
{
unset($this->container[$offset]);
}
}
$test = new Test;
var_dump(isset($test['one']));
var_dump($test['two']);
unset($test['two']);
var_dump(isset($test['two']));
$test['two'] = 22;
var_dump($test['two']);
$test[] = 4;
var_dump($test);
var_dump($test[0]);
當然我們也有經典的一個做法就是把物件的屬性當做陣列來訪問
class Test implements ArrayAccess
{
public $name;
public function __construct()
{
$this->name = 'gabe';
}
public function offsetExists($offset)
{
return isset($this->$offset);
}
public function offsetGet($offset)
{
return isset($this->$offset) ? $this->$offset : null;
}
public function offsetSet($offset, $value)
{
$this->$offset = $value;
}
public function offsetUnset($offset)
{
unset($this->$offset);
}
}
$test = new Test;
var_dump(isset($test['name']));
var_dump($test['name']);
var_dump($test['age']);
$test[1] = '22';
var_dump($test);
unset($test['name']);
var_dump(isset($test['name']));
var_dump($test);
$test[] = 'hello world';
var_dump($test);5. Serializable （序列化）介面
通常情況下，如果我們的類中定義了魔術方法，sleep(),wakeup()的話，我們在進行serialize()的時候，會先呼叫sleep()的魔術方法，我們通過返回一個數組，來定義對物件的哪些屬性進行序列化，同理，我們在呼叫發序列化unserialize()方法的時候，也會先呼叫的wakeup（）魔術方法，我們可以進行初始化，如對一個物件的屬性進行賦值等操作；但是如果該類實現了序列化介面，我們就必須實現serialize（）方法和unserialize()方法，同時sleep（）和 wakeup()兩個魔術方法都會同時不再支援，具體程式碼看如下；
<?php
class Test
{
public $name;
public $age;
public function __construct()
{
$this->name = 'gabe';
$this->age = 25;
}
public function __wakeup()
{
var_dump(__METHOD__);
$this->age++;
}
public function __sleep()
{
var_dump(__METHOD__);
return ['name'];
}
}
$test = new Test;
$a = serialize($test);
var_dump($a);
var_dump(unserialize($a));
//實現序列化介面，發現魔術方法失效了
class Test implements Serializable
{
public $name;
public $age;
public function __construct()
{
$this->name = 'gabe';
$this->age = 25;
}
public function __wakeup()
{
var_dump(__METHOD__);
$this->age++;
}
public function __sleep()
{
var_dump(__METHOD__);
return ['name'];
}
public function serialize()
{
return serialize($this->name);
}
public function unserialize($serialized)
{
$this->name = unserialize($serialized);
$this->age = 1;
}
}
$test = new Test;
$a = serialize($test);
var_dump($a);
var_dump(unserialize($a));6. Closure類
用於代表匿名函式的類，凡是匿名函式其實返回的都是Closure閉包類的一個例項，該類中主要有兩個方法，bindTo（）和bind（），通過檢視原始碼，可以發現兩個方法是殊途同歸，只不過是bind()是個靜態方法，具體用法看如下；
<?php
$closure = function () {
return 'hello world';
}
var_dump($closure);
var_dump($closure());通過上面的例子，可以看出第一個打印出來的是Closure的一個例項，而第二個就是打印出匿名函式返回的hello world字串；接下來是使用這個匿名類的方法，這兩個方法的目的都是把匿名函式繫結一個類上使用；
- bindTo()
<?php
namespace demo1;
class Test {
private $name = 'hello woeld';
}
$closure = function () {
return $this->name;
}
$func = $closure->bindTo(new Test);
$func();
// 這個是可以訪問不到私有屬性的，會報出無法訪問私有屬性
// 下面這個是正確的做法
$func = $closure->bindTo(new Test, Test::class);
$func();
namespace demo2;
class Test
{
private statis $name = 'hello world';
}
$closure = function () {
return self::$name;
}
$func = $closure->bindTo(null, Test::class);
$func();
- bind()
<?php
namespace demo1;
class Test
{
private $name = 'hello world';
}
$func = \Closure::bind(function() {
return $this->name;
}, new Test, Test::class);
$func();
namespace demo2;
class Test
{
private static $name = 'hello world';
}
$func = \Closure::bind(function() {
return self::$name;
}, null, Test::class);
$func()7. Generator （生成器）
Generator實現了Iterator，但是他無法被繼承，同時也生成例項。既然實現了Iterator，所以正如上文所介紹，他也就有了和Iterator相同的功能:rewind->valid->current->key->next...，Generator的語法主要來自於關鍵字yield。yield就好比一次迴圈的中轉站，記錄本次的活動軌跡，返回一個Generator的例項。Generator的優點在於，當我們要使用到大資料的遍歷，或者說大檔案的讀寫，而我們的記憶體不夠的情況下，能夠極大的減少我們對於記憶體的消耗，因為傳統的遍歷會返回所有的資料，這個資料存在記憶體上，而yield只會返回當前的值，不過當我們在使用yield時，其實其中會有一個處理記憶體的過程，所以實際上這是一個用時間換空間的辦法。
<?php
$start_time = microtime(true);
function xrange(int $num){
for($i = 0; $i < $num; $i++) {
yield $i;
}
}
$generator = xrange(100000);
foreach ($generator as $key => $value) {
echo $key . ': ' . $value . PHP_EOL;
}
echo 'memory: ' . memory_get_usage() . ' time: '. (microtime(true) - $start_time);輸出：memory: 388904 time: 0.12135100364685
<?php
$start_time = microtime(true);
function xrange(int $num){
$arr = [];
for($i = 0; $i < $num; $i++) {
array_push($arr, $i);
}
return $arr;
}
$arr = xrange(100000);
foreach ($arr as $key => $value) {
echo $key . ': ' . $value . PHP_EOL;
}
echo 'memory: ' . memory_get_usage() . ' time: '. (microtime(true) - $start_time);輸出：memory: 6680312 time: 0.10804104804993