php extension 开发之 RETURN

> 我们知道在php扩展开发中，给一个方法返回值，我们一般采用宏 RETURN_LONG、RETURN_FALSE、RETURN_TURE、RETURN_DOUBLE 、RETURN_NULL 他们这些宏到底扮演了什么角色，咱们以RETURN_LONG()为例分析一下。

### RETURN_XXX()

从一个简单的例子说起，写一个扩展函数 get_ini_258() 。这个函数无参，调用直接返回整型258

```php
<?php
    $num = get_int_258();
    echo $num; // 输出258
```

C扩展实现如下:

```c
PHP_FUNCTION(get_int_258){
    ZEND_PARSE_PARAMETERS_NONE();
    RETURN_LONG(258);
}
```

通过上节PHP_FUNCTION的宏分析后，等价下面。
> 注 我们都是通过修改return_value，来决定函数的返回值

```c
void zif_get_size(zend_execute_data *execute_data, zval *return_value){
        ZEND_PARSE_PARAMETERS_NONE();
        RETURN_LONG(258);
}
```

这节我们分析一下，RETURN_LONG()这个宏究竟干了些什么

```c
#define RETURN_LONG(l)                  { RETVAL_LONG(l); return; }
```

RETURN_LONG(258); 等价于 RETVAL_LONG(258); return;

```c
#define RETVAL_LONG(l)                  ZVAL_LONG(return_value, l)
```
RETVAL_LONG(258); return; 等价于 ZVAL_LONG(return_value, 258)；return;

```c
#define ZVAL_LONG(z, l) {               \
        zval *__z = (z);                \
        Z_LVAL_P(__z) = l;              \
        Z_TYPE_INFO_P(__z) = IS_LONG;   \
    }

```

到了这里，我们了解到 RETURN_LONG()宏，其实是 RETVAL_LONG()加了一个 return;
而RETVAL_LONG()宏是调用ZVAL_LONG()宏，修改return_value。

再看下 Z_LVAL_P() 与 Z_TYPE_INFO_P() 这两个宏，我们就大概知道了。他是修改zval的相关属性，达到的返回整型258
```c
#define Z_LVAL(zval)                (zval).value.lval
#define Z_LVAL_P(zval_p)            Z_LVAL(*(zval_p))
....
#define Z_TYPE_INFO(zval)           (zval).u1.type_info
#define Z_TYPE_INFO_P(zval_p)       Z_TYPE_INFO(*(zval_p))
....

```

分析到最后
这些代码
```c
PHP_FUNCTION(get_int_258){
    ZEND_PARSE_PARAMETERS_NONE();
    RETURN_LONG(258);
}
```
等价于如下(若有怀疑，用下面的代码，也可以正常编译通过哦，效果是一样的)
```c
void zif_get_int_258(zend_execute_data *execute_data, zval *return_value){
      ZEND_PARSE_PARAMETERS_NONE();
      return_value->value.lval = 258;
      return_value->u1.v.type = IS_LONG;
      return; 
 }
```

再来回头看下zval 结构体的申明

```
struct _zval_struct {
    zend_value value; 
    union u1;
    union u2;
}
```
**value** 来存放具体的值
**u1** 主要用来标明此变量的类型(整型，浮点型)
**u2** 用来存放 php编译过程中的语法，语法解析所用的信息还有此变量的在类中的一些属性如 public,private,protected等

注 如果 **u1.v.type 中的值标记为 整型或者浮点型**，直接取**value.lval** 或 **value.dval**的值

```c
typedef union _zend_value {
    zend_long         lval;             /* long value */
    double            dval;             /* double value */
    zend_refcounted  *counted;
    zend_string      *str;
    zend_array       *arr;
    zend_object      *obj;
    ...
```

即然我们知道了，其中的原理，建义咱们在开发扩展的过程，尽量也别这么写
```c
void zif_get_int_258(zend_execute_data *execute_data, zval *return_value){
      ZEND_PARSE_PARAMETERS_NONE();
      return_value->value.lval = 258;
      return_value->u1.v.type = IS_LONG;
      return; 
 }
```
因为随着php版本的迭代，他的zval结构体发生变化，咱们得重新修改代码。如果用宏，官方一定会调整对应的宏来做版本适配。
这样咱们就不用修改扩展代码了。还是写成这样比较明智。
```c
PHP_FUNCTION(get_int_258){
    ZEND_PARSE_PARAMETERS_NONE();
    RETURN_LONG(258);
}
```

php extension 开发之 RETURN_XXX()