PHP之预定义接口详解

这篇文章主要整理了PHP之预定义接口,在平时项目过程中比较常用的四个接口:IteratorAggregate(聚合式aggregate迭代器Iterator)、Countable、ArrayAccess、Iterator,需要的朋友可以参考下

在PHP中有好几个预定义的接口,比较常用的四个接口(IteratorAggregate(聚合式aggregate迭代器Iterator)、Countable、ArrayAccess、Iterator)分别给大家详细介绍下。

IteratorAggregate(聚合式aggregate迭代器Iterator)接口,代码如下:

  1. IteratorAggregate extends Traversable {
  2. abstract public Traversable getIterator(void)
  3. }

这个接口实现了一个功能——创建外部迭代器,具体怎么理解呢,当我们使用foreach对对象进行便遍历的时候,如果没有继承IteratorAggregate接口,遍历的是对象中所有的public属性(只能是public $var这种形式)。要是继承了IteratorAggregate,会使用类中实现的getIterator方法返回的对象,这里要注意返回的一定要是一个Traversable对象或者扩展自Traversable的对象,否则会抛出异常:

  1. //看个例子
  2. class My{
  3. private $_data = [
  4. 'a' => '燕睿涛',
  5. 'b' => 'yanruitao',
  6. 'c' => 'LULU',
  7. ];
  8. public function getIterator()
  9. {
  10. return new ArrayIterator($this->_data);
  11. }
  12. }
  13. $obj = new My;
  14. foreach ($obj as $key => $value) {
  15. echo "$key => $value\n";
  16. }
  17. //输出结果为空
  18. class My implements IteratorAggregate {
  19. private $_data = [
  20. 'a' => '燕睿涛',
  21. 'b' => 'yanruitao',
  22. 'c' => 'LULU',
  23. ];
  24. public function getIterator()
  25. {
  26. return new ArrayIterator($this->_data);
  27. }
  28. }
  29. $obj = new My;
  30. foreach ($obj as $key => $value) {
  31. echo "$key => $value\n";
  32. }
  33. //结果:
  34. a => 燕睿涛
  35. b => yanruitao
  36. c => LULU

Countable接口,代码如下:

  1. Countable {
  2. abstract public int count(void)
  3. }

这个接口用于统计对象的数量,具体怎么理解呢,当我们对一个对象调用count的时候,如果函数没有继承Countable将一直返回1,如果继承了Countable会返回所实现的count方法所返回的数字,看看下面的例子:

  1. class CountMe
  2. {
  3. protected $_myCount = 3;
  4. public function count()
  5. {
  6. return $this->_myCount;
  7. }
  8. }
  9. $countable = new CountMe();
  10. echo count($countable);
  11. //返回1
  12. class CountMe implements Countable
  13. {
  14. protected $_myCount = 3;
  15. public function count()
  16. {
  17. return $this->_myCount;
  18. }
  19. }
  20. $countable = new CountMe();
  21. echo count($countable);
  22. //返回3

ArrayAccess接口:

  1. ArrayAccess {
  2. abstract public boolean offsetExists(mixed $offset)
  3. abstract public mixed offsetGet(mixed $offset)
  4. public void offsetSet(mixed $offset, mixed $value)
  5. public void offsetUnset(mixed $offset)
  6. }
  7. class CountMe
  8. {
  9. protected $_myCount = 3;
  10. public function count()
  11. {
  12. return $this->_myCount;
  13. }
  14. }
  15. $countable = new CountMe();
  16. echo count($countable);
  17. //返回1
  18. class CountMe implements Countable
  19. {
  20. protected $_myCount = 3;
  21. public function count()
  22. {
  23. return $this->_myCount;
  24. }
  25. }
  26. $countable = new CountMe();
  27. echo count($countable);
  28. //返回3

ArrayAccess接口,代码如下:

  1. ArrayAccess {
  2. abstract public boolean offsetExists(mixed $offset)
  3. abstract public mixed offsetGet(mixed $offset)
  4. public void offsetSet(mixed $offset, mixed $value)
  5. public void offsetUnset(mixed $offset)
  6. }

这个接口的作用是让我们可以像访问数组一样访问对象,这个怎么说好呢,我猜其实就是php在词法分析的时候如果碰到了数组的方式使用对象,就回去对象中查找是否有实现ArrayAccess如果有的话,进行对应的操作(set、unset、isset、get),这样我们就可以在类里面放置一个array,让类实现数组方式的基本操作,下面看个例子:

  1. class myObj
  2. {
  3. }
  4. $obj = new myObj;
  5. $obj['name'];
  6. //Fatal error: Cannot use object of type myObj as array in
  7. class myObj implements ArrayAccess
  8. {
  9. public function offsetSet($offset, $value)
  10. {
  11. echo "offsetSet : {$offset} => {$value}\n";
  12. }
  13. public function offsetExists($offset)
  14. {
  15. echo "offsetExists : {$offset}\n";
  16. }
  17. public function offsetUnset($offset)
  18. {
  19. echo "offsetUnset : {$offset}\n";
  20. }
  21. public function offsetGet($offset)
  22. {
  23. echo "offsetGet : {$offset}\n";
  24. }
  25. }
  26. $obj = new myObj;
  27. $obj[1] = '燕睿涛';
  28. isset($obj['name']);
  29. unset($obj['name']);
  30. $obj['yrt'];
  31. //输出结果:
  32. offsetSet : 1 => 燕睿涛
  33. offsetExists : name
  34. offsetUnset : name
  35. offsetGet : yrt
  36. class myObj implements ArrayAccess
  37. {
  38. private $_data = [];
  39. public function offsetSet($offset, $value)
  40. {
  41. $this->_data[$offset] = $value;
  42. }
  43. public function offsetExists($offset)
  44. {
  45. return isset($this->_data[$offset]);
  46. }
  47. public function offsetUnset($offset)
  48. {
  49. unset($this->_data[$offset]);
  50. }
  51. public function offsetGet($offset)
  52. {
  53. return $this->_data[$offset];
  54. }
  55. }
  56. $obj = new myObj;
  57. $obj['yrt'] = '燕睿涛';
  58. var_dump($obj['yrt']);
  59. var_dump(isset($obj['yrt']));
  60. unset($obj['yrt']);
  61. var_dump(isset($obj['yrt']));
  62. var_dump($obj['yrt']);
  63. //输出:
  64. string(9) "燕睿涛"
  65. bool(true)
  66. bool(false)
  67. Notice: Undefined index: yrt //最后一个会报出Notice

上面的对象只能是基本的数组操作,连遍历都不行,结合之前的IteratorAggregate可以进行foreach:

  1. class myObj implements ArrayAccess, IteratorAggregate
  2. {
  3. private $_data = [];
  4. public function getIterator()
  5. {
  6. return new ArrayIterator($this->_data);
  7. }
  8. ......
  9. }
  10. $obj = new myObj;
  11. $obj['yrt'] = '燕睿涛';
  12. $obj[1] = '燕睿涛';
  13. $obj['name'] = '燕睿涛';
  14. $obj['age'] = 23;
  15. foreach ($obj as $key => $value) {
  16. echo "{$key} => {$value}\n";
  17. }
  18. //输出:
  19. yrt => 燕睿涛
  20. 1 => 燕睿涛
  21. name => 燕睿涛
  22. age => 23

Iterator接口:

  1. Iterator extends Traversable {
  2. abstract public mixed current(void)
  3. abstract public scalar key(void)
  4. abstract public void next(void)
  5. abstract public void rewind(void)
  6. abstract public boolean valid(void)
  7. }

可在内部迭代自己的外部迭代器或类的接口,这是官方文档给出的解释,看着还是不好理解,其实我感觉这个接口实现的功能和trratorAggregate(文档:创建外部迭代器接口,接口直接返回一个迭代器)类似,不过这个在类的定义里面自己实现了,看个例子:

  1. class myObj implements Iterator{
  2. private $_data = [];
  3. public function __construct(Array $arr)
  4. {
  5. $this->_data = $arr;
  6. }
  7. public function current()
  8. {
  9. return current($this->_data);
  10. }
  11. public function key()
  12. {
  13. return key($this->_data);
  14. }
  15. public function next()
  16. {
  17. next($this->_data);
  18. }
  19. public function rewind()
  20. {
  21. reset($this->_data);
  22. }
  23. public function valid()
  24. {
  25. return $this->key() !== NULL;
  26. }
  27. }
  28. $t = [
  29. 'yrt' => '燕睿涛',
  30. 'name' => '燕睿涛',
  31. false,
  32. '燕睿涛'
  33. ];
  34. $obj = new myObj($t);
  35. foreach ($obj as $key => $value) {
  36. echo "{$key} => ".var_export($value, true)."\n";
  37. }
  38. //输出:
  39. yrt => '燕睿涛'
  40. name => '燕睿涛'
  41. 0 => false
  42. 1 => '燕睿涛'

上面这个参考了鸟哥的一篇文章关于一笔试题(Iterator模式),不过鸟哥的那个判断valid有点瑕疵,当碰到值北来就是false的时候就会截断

总结:说了这么多好像还是没有体会到他们的用处,建议看看Yii2的源码,源码里面大量使用了这些东西,看了之后,你会慢慢觉得“哦~好像还真是挺有用的。。。。”