PHP empty()和is_array()实现源码分析

事情起因于这样一段代码：

if(is_array($input) && !empty($input)){
// 做点事
}

leader认为应该先empty()判断，再is_array()判断，这种写法也更为多见。

而我还是觉得其实差不多。群里讨论之后，也没有确定性的结论，究竟哪一种更好。

于是乎，我去看了两者的源码实现。

1 is_array()的实现

is_array()是php内置函数，通过扩展方式实现的。打开php源码，ext/standard/type.c文件，打开后看到其实现：

/* {{{ proto bool is_array(mixed var)
Returns true if variable is an array
Warning: This function is special-cased by zend_compile.c and so is usually bypassed
*/
PHP_FUNCTION(is_array)
{
php_is_type(INTERNAL_FUNCTION_PARAM_PASSTHRU, IS_ARRAY);
}
/* }}} */

可见是调用php_is_type函数实现。通过注释及函数名，可以猜测：是通过获取php的变量类型是否为数组来实现的。

php变量zval结构如下：

typedef struct _zval_struct {
zvalue_value value;
zend_uint refcount;
zend_uchar type;
zend_uchar is_ref;
} zval;

以下是php_is_type函数的具体实现：

static inline void php_is_type(INTERNAL_FUNCTION_PARAMETERS, int type)
{
zval *arg;
ZEND_PARSE_PARAMETERS_START(1, 1)
Z_PARAM_ZVAL_DEREF(arg)
ZEND_PARSE_PARAMETERS_END_EX(RETURN_FALSE);
if (Z_TYPE_P(arg) == type) {
if (type == IS_OBJECT) {
zend_class_entry *ce = Z_OBJCE_P(arg);
if (ZSTR_LEN(ce->name) == sizeof(INCOMPLETE_CLASS) - 1
&& !memcmp(ZSTR_VAL(ce->name), INCOMPLETE_CLASS, sizeof(INCOMPLETE_CLASS) - 1)) {
RETURN_FALSE;
}
} else if (type == IS_RESOURCE) {
const char *type_name = zend_rsrc_list_get_rsrc_type(Z_RES_P(arg));
if (!type_name) {
RETURN_FALSE;
}
}
RETURN_TRUE;
} else {
RETURN_FALSE;
}
}

可以看到和猜测的一样：通过Z_TYPE_P宏获取变量类型，判断是否为IS_ARRAY返回。

2 empty()实现原理

empty不是一个函数，而是一个语言结构。语言结构是在PHP程序运行前编译好的，因此不能像之前那样简单地搜索PHP_FUNCTION empty或ZEND_FUNCTION empty查看其源码。要想看empty等语言结构的源码，先要理解PHP代码执行的机制。

PHP执行代码会经过4个步骤，其流程图如下所示：

在第一个阶段，即Scanning阶段，程序会扫描 zend_language_scanner.l 文件将代码文件转换成语言片段。

打开zend_language_scanner.l文件：

1409 <ST_IN_SCRIPTING>"empty" {
1410     RETURN_TOKEN(T_EMPTY);
1411 }

可见 empty 生成对应的token为 T_EMPTY

接下来就到了Parsing阶段，这个阶段，程序将T_EMPTY等Tokens转换成有意义的表达式，此时会做语法分析，Tokens的yacc保存在zend_language_parser.y文件中。

可以找到T_EMPTY的定义：

1257 internal_functions_in_yacc:
1258         T_ISSET '(' isset_variables ')' { $$ = $3; }
1259     |   T_EMPTY '(' expr ')' { $$ = zend_ast_create(ZEND_AST_EMPTY, $3); }
1260     |   T_INCLUDE expr
1261             { $$ = zend_ast_create_ex(ZEND_AST_INCLUDE_OR_EVAL, ZEND_INCLUD     E, $2); }
1262     |   T_INCLUDE_ONCE expr
1263             { $$ = zend_ast_create_ex(ZEND_AST_INCLUDE_OR_EVAL, ZEND_INCLUD     E_ONCE, $2); }

第三阶段，将表达式编译成opcodes，可见empty对应的opcodes为ZEND_AST_EMPTY。

打开zend_compile.c文件：

7978         case ZEND_AST_ISSET:
7979         case ZEND_AST_EMPTY:
7980             zend_compile_isset_or_empty(result, ast);
7981             return;
7982         case ZEND_AST_SILENCE:
7983             zend_compile_silence(result, ast);
7984             return;

可见opcode执行的函数为zend_compile_isset_or_empty

void zend_compile_isset_or_empty(znode *result, zend_ast *ast) /* {{{ */
{
zend_ast *var_ast = ast->child[0];
znode var_node;
zend_op *opline = NULL;
ZEND_ASSERT(ast->kind == ZEND_AST_ISSET || ast->kind == ZEND_AST_EMPTY);
if (!zend_is_variable(var_ast) || zend_is_call(var_ast)) {
if (ast->kind == ZEND_AST_EMPTY) {
/* empty(expr) can be transformed to !expr */
zend_ast *not_ast = zend_ast_create_ex(ZEND_AST_UNARY_OP, ZEND_BOOL_NOT, var_ast);
zend_compile_expr(result, not_ast);
return;
} else {
zend_error_noreturn(E_COMPILE_ERROR,
"Cannot use isset() on the result of an expression "
"(you can use \"null !== expression\" instead)");
}
}
switch (var_ast->kind) {
case ZEND_AST_VAR:
.
.
.
result->op_type = opline->result_type = IS_TMP_VAR;
opline->extended_value |= ast->kind == ZEND_AST_ISSET ? ZEND_ISSET : ZEND_ISEMPTY;
}
/* }}} */

从这个函数最后一行可以看出，最终执行的还是ZEND_ISEMPTY。
第四步，执行opcodes，zend_vm_execute.h

6981 is_static_prop_return:
6982     if (opline->extended_value & ZEND_ISSET) {
6983         result = value && Z_TYPE_P(value) > IS_NULL &&
6984             (!Z_ISREF_P(value) || Z_TYPE_P(Z_REFVAL_P(value)) != IS_NULL);
6985     } else /* if (opline->extended_value & ZEND_ISEMPTY) */ {
6986         result = !value || !i_zend_is_true(value);
6987     }

可见，ZEND_ISEMPTY执行的是 i_zend_is_true函数。

$ grep -r ‘i_zend_is_true’ *
zend_operators.h:static zend_always_inline int i_zend_is_true(zval *op)

打开zend_operators.h，查看其实现：

static zend_always_inline int i_zend_is_true(zval *op)
{
int result = 0;
again:
switch (Z_TYPE_P(op)) {
case IS_TRUE:
result = 1;
break;
case IS_LONG:
if (Z_LVAL_P(op)) {
result = 1;
}
break;
case IS_DOUBLE:
if (Z_DVAL_P(op)) {
result = 1;
}
break;
case IS_STRING:
if (Z_STRLEN_P(op) > 1 || (Z_STRLEN_P(op) && Z_STRVAL_P(op)[0] != '0')) {
result = 1;
}
break;
case IS_ARRAY:
if (zend_hash_num_elements(Z_ARRVAL_P(op))) {
result = 1;
}
break;
case IS_OBJECT:
result = zend_object_is_true(op);
break;
case IS_RESOURCE:
if (EXPECTED(Z_RES_HANDLE_P(op))) {
result = 1;
}
break;
case IS_REFERENCE:
op = Z_REFVAL_P(op);
goto again;
break;
default:
break;
}
return result;
}

可见，empty的最终实现也是通过 Z_TYPE_P 获取变量类型，然后再进行判断的。
当$var为数组时，判断是否为空数组。

至此，终于弄明白empty()和is_array()的原理。

回到最初的问题，就那个使用场景而言，is_array()判断是多余的。

另外我的结论是：大部分使用场景下，应该用empty()先做判断。

因为底层原理都是通过zval结构体实现的，但empty是语法结构，而is_array()是函数，语法结构比函数调用开销是要小的。