PHP 中的魔术方法

痛定思痛。 2022-03-08 07:10 347阅读 0赞

PHP 中魔术方法是以下两个划线 “\_\_” 开头的、具有特殊作用的一些方法，可以看作PHP的“语法糖”。

> 语法糖是指那些没有给计算机语言添加新功能，而只是对人类来说更 “甜蜜” 的语法。语法糖往往给程序员提供了更实用的编码方式或者一些技巧性的用法，有益于更好地编码风格，使代码更易读。不过其并没有给语言添加什么新的东西。PHP 里引用、SPL 等都属于语法糖。

## 1. \_\_construct 方法 ##

\_\_construct() 是一个标准的魔术方法，所以非常适合在使用对象之前做一些初始化工作。因此这个方法往往用于类进行初始化时执行一些初始化操作。给属性赋值、连接数据库等。

class Girlfriend{
        public $name;
        public $height;
        
        public function __construct($name, $height){
            $this->name = $name;
            $this->height = $height;
        }
    }
    
    $myGirl = new Girlfriend('Lucy', '170cm');

## 2. \_\_set 和 \_\_get 方法 ##

类的属性一半都设置为私有属性，再通过 public 的方法去修改这个属性，这种做法体现了 将数据与行为进行分离 的封装思想。

请看下面一段代码：

class Son{
        private $name;
        private $age;
        private $gender;
        
        public function __set($name, $value){
            $this->name = $value;
        }
        
        public function __get($name){
            if(!isset($this->$name)){
                echo $name . '未设置';
                $this->$name = '这是帮您设置的默认值';
            }
            return $this->$name;
        }
    }
    
    $whp = new Son();
    
    $whp->name = 'wangba';
    $whp->age = '10';
    $whp->gender = '男';
    
    echo '姓名：', $whp->name, ' 性别：', $whp->gender, ' 年龄：', $whp->age;

使用这两个魔术方法在对类的私有属性进行操作时，不需要显示地调用一个 public 的方法 ，显得更为方便。

## 3. \_\_call() 和 \_callStatic 方法 ##

当调用一个不可访问的方法（如未定义，或者不可见）时，\_\_call() 会被调用。其中 $method 参数是需要调用的方法名称。$arguments 参数是一个数组，包含着要传递给方法的参数，如下所示：

class Test{
        public function __call($method, $arguments){
            switch(count($arguments)){
                case 2:
                    echo $arguments[0] * $arguments[1], PHP_EOL;
                    break;
                case 3:
                    echo array_sum($arguments), PHP_EOL;
                    break;
                default:
                    echo '参数不对', PHP_EOL;
                    break;
            }
        }
    }
    
    $test = new Test();
    
    $test->sum(1);
    $test->sum(2, 3);

以上代码模拟了类似其他语言根据参数类型进行重载。Test 类中 sum 方法并不存在，当对象 $test 调用 sum 方法时，Test 类中的魔术方法 \_\_call 会被调用，参数即为 $test调用sum 时传的参数，例如第一次调用 $arguments = 1; 第二次调用 $arguments = array(2, 3);

跟 \_\_call 配套的魔术方法是 \_\_callStatic，当调用的静态方法不存在时 \_\_callStatic 将会被调用。

当然，使用魔术方法“防止调用不存在的方法而报错”，并不是魔术方法的本意。实际上，魔术方法是方法的动态创建成为可能，这在 MVC 等框架设计中是 很有用的语法。假设一个控制器调用了一个不存在的方法，那么只要定义了 \_\_call 魔术方法，就能友好的处理这种情况。

## 4. \_\_toString 和 \_\_debugInfo 方法 ##

当进行测试时，需要知道是否得出正确的数据。比如打印一个对象时，看看这个对象都有哪些属性，其值是神么。如果类定义了 \_\_toString 方法，就能在测试时，echo 打印对象体，对象就会自动调用他所属类定义的 \_\_toString 方法，格式化输出这个对象所包含的数据。如果没有这个方法，echo 一个对象将会报错。也可以用 print\_r() 或者是 var\_dump() 函数输出一个对象。当然， \_\_toString 是可以定制的，所提供的信息和样式更丰富，例如：

class Account{
        public $user = 1;
        private $pwd = 2;
        
        // 自定义格式化输出方法。
        public function __toString(){
            return "当前对象的用户名是：{$this->user}，密码是：{$this->pwd}";
        }
    }
    
    $a = new Account();
    
    echo $a, PHP_EOL;
    print_r($a);

为什么直接 echo 一个对象就会报语法错误，而如果这个对象实现 \_\_toString 方法后就可以直接输出呢？原因很简单，echo 本来可以打印一个对象，而且也实现了这个接口，但是 PHP 对其做了个限制，只有实现 \_\_toString 后才允许使用。从下面的 PHP 源代码里可以得到验证：

ZEND_VM_HANDLER(40, ZEND_ECHO, CONST|TMP|VAR|CV, ANY)
    {
    	zend_op *opline = EX(opline);
    	zend_free_op free_op1;
    	zval z_copy;
    	zval *z = GET_OP1_ZVAL_PTR(BP_VAR_R);
    
    	if (OP1_TYPE != IS_CONST &&
    	    Z_TYPE_P(z) == IS_OBJECT && Z_OBJ_HT_P(z)->get_method != NULL &&
    		zend_std_cast_object_tostring(z, &z_copy, IS_STRING TSRMLS_CC) == SUCCESS) {
    		zend_print_variable(&z_copy);
    		zval_dtor(&z_copy);
    	} else {
    		zend_print_variable(z);
    	}
    
    	FREE_OP1();
    	ZEND_VM_NEXT_OPCODE();
    }

PHP 在 echo 一个对象时，会判断变量类型是否为 string，如果不是 string 的话，则去寻找可以转换为 string 的方法。在寻找到对象中 \_\_toString方法时，调用 zend\_std\_cast\_object\_tostring 方法。