常用知识 - 用数组语法访问对象属性

  1. 实现原理
  2. 示例代码：
  3. 正确代码
  4. 总结

  • 作者：KK

  • 发表日期：2016.8.10

访问一个对象的属性，语法是$obj->属性名称，但其实可以使用$obj['属性名称']来访问属性

实现原理

对象要实现ArrayAccess接口,其中要实现的方法有

  • public boolean offsetExists ( mixed $offset ) 实现isset($obj['key'])的判断

  • public mixed offsetGet ( mixed $offset ) 实现$value = $obj['key']取值

  • public void offsetSet ( mixed $offset , mixed $value ) 实现$obj['key'] = 'value' 实现向指定的key赋值

  • public void offsetUnset ( mixed $offset ) 实现unset($obj['key']) 实现把指定的key销毁

示例代码：

以下代码不是正常的逻辑，只是为了展示如何实现数组方式的属性操作而已

class User implements ArrayAccess{
	public $name = '';
	public $age = 0;
	
	public function offsetExists($key){
		return (bool)$this->{$key}; //name非空为当作存在吧
	}
	
	public function offsetGet($key){
		return $this->{$key}; //直接把name返回吧，管它取什么key
	}
	
	public function offsetSet($key, $value){
		$this->{$key} = $value; //任何key的数据赋值都存给name吧
	}
	
	public function offsetUnset($key){
		$this->{$key} = ''; //将name设为空
	}
}

$user = new User();
echo '<h1>name的测试</h1>';
echo 'name键为空：' . $user['name'] . '<br/>';
echo 'name属性为空：' . $user->name . '<br/>';
$user['name'] = 'jay';
echo 'name键的值：' . $user['name'] . '<br/>';
echo 'name属性的值：' . $user->name . '<br/><br/>';

echo isset($user['name']) ? 'name键存在<br/>' : 'name键不存在<br/>';
echo $user->name ? 'name属性有值<br/>' : 'name属性没值<br/>';
$user['name'] = '';
echo isset($user['name']) ? 'name键存在<br/>' : 'name键不存在<br/>';
echo $user->name ? 'name属性有值<br/>' : 'name属性没值<br/>';



echo '<br/><br/><h1>age的测试</h1>';
echo 'age键为空：' . $user['age'] . '<br/>';
echo 'age属性为空：' . $user->age . '<br/>';
$user['age'] = 99;
echo 'age键的值：' . $user['age'] . '<br/>';
echo 'age属性的值：' . $user->age . '<br/><br/>';

echo isset($user['age']) ? 'age键存在<br/>' : 'age键不存在<br/>';
echo $user->age ? 'age属性有值<br/>' : 'age属性没值<br/>';
$user['age'] = '';
echo isset($user['age']) ? 'age键存在<br/>' : 'age键不存在<br/>';
echo $user->age ? 'age属性有值<br/>' : 'age属性没值<br/>';

正确代码

通常如果要实现用数组语法访问对象属性，那么赋值和取值时一般不是向对象的属性取值，而是向一个私有的数据容器（下例中的$_data）取值赋值：

class User implements ArrayAccess{
	private $_data = [];
	
	public function offsetExists($key){
		return isset($this->_data[$key]);
	}
	
	public function offsetGet($key){
		return $this->_data[$key];
	}
	
	public function offsetSet($key, $value){
		$this->_data[$key] = $value;
	}
	
	public function offsetUnset($offset){
		unset($this->_data[$key]);
	}
	
	
	
	public function test(){
		echo 'method';
	}
}

$user = new User();
$user->test();
$user['xx'] = 1111;
echo $user['xx'];
echo '<br/><br/>' . $user['yyy']; //undefined

总结

一般平时写代码不经常用到这个知识，多数用于框架的封装和一些特殊场合，但你偶尔会遇到这类代码，此时知道它原理就好了，不要误认为那是个数组，其实是个对象

实际中可以看到的就是Yii2这个框架的ORM实现是应用了这个技术的，实现了既可将模型转换成JSON，也能调用模型的业务逻辑，代码类似这样：

$user = User::findOne(['email' => 'admin@xx.com']); //查询表记录并返回ORM模型对象
if(!$user->allow('manage_user')){
	throw new \Exception('您无法删除用户');
}

//表字段：id,name,email,permissions
//echo $user['name'];
Yii::$app->response->format = \yii\web\Reponse::FORMAT_JSON;
Yii::$app->response->data = $user;
//Yii::$app->response->data = $user->toArray(['id', 'name']); //返回一个包含指定key的数组

则前端收到一个JSON类似这样：

{"id":1,"name":"Jay","email":"admin@xx.com"...}

但要注意，这个对象还不能放在for循环里进行遍历哦！，要用在for循环上就要实现Iterator接口了