您好,欢迎访问一九零五行业门户网

给PHP增加函数强制类型返回

在开发过程中,函数的返回值类型应该是确定不变的,但php是弱类型的语言, 所以php是没有此类语法验证的,正因为如此,造成了很多坑坑。 比如下面的代码: ?phpfunction getarticles(...){ $arrdata = array(); if($exp1){ return $arrdata; }else if($exp2)
在开发过程中,函数的返回值类型应该是确定不变的,但php是弱类型的语言,
所以php是没有此类语法验证的,正因为如此,造成了很多坑坑。
比如下面的代码:

函数getarticles根据不同的条件返回不同类型的值,有bool、int、还有数组,正常情况这类函数是希望返回数组,然后拿数组去做一些其他操作,
可因为函数返回值类型不固定,调用时就很可能产生各种预想不到的坑,
因此我就想,既然不能规范,那直接强制好了。
函数/方法返回值可以强制类型,如 图
支持四种强制类型限制:int、array、bool、object,当返回值与函数声明中的类型不匹配时,抛出warning,本来想抛出error,但是觉得
太狠了,只能算是个异常,不能算错误,所以就用warning好了。
php本身是不支持 int function 这样的语法的,所以要支持,就先要搞定语法解析器,关于语法解析器,可以移步这里>>>查看
详情,这里就不讲了,
先修改语法扫描 zend/zend_language_scanner.l文件
增加如下代码:
int { return t_function_return_int;}bool { return t_function_return_object;}object { return t_function_return_object;}resource { return t_function_return_resource;}
意思很简单,扫描器扫描到到关键字 int、bool、object、resource、array时返回相应的t_function_* ,这是一个token,
scanner根据不同的token做不同的处理,token要先在zend/zend_language_parser.y文件中定义
增加如下代码
..........%token t_function_return_int%token t_function_return_bool%token t_function_return_string%token t_function_return_object%token t_function_return_resource1然后增加token处理逻辑:1function: t_function { $$.u.opline_num = cg(zend_lineno);$$.u.ea.var = 0; } | t_function_return_int t_function { $$.u.opline_num = cg(zend_lineno); $$.u.ea.var = is_long; } | t_function_return_bool t_function { $$.u.opline_num = cg(zend_lineno); $$.u.ea.var = is_bool; } | t_function_return_string t_function { $$.u.opline_num = cg(zend_lineno); $$.u.ea.var = is_string; } | t_function_return_object t_function { $$.u.opline_num = cg(zend_lineno); $$.u.ea.var = is_object; } | t_function_return_resource t_function { $$.u.opline_num = cg(zend_lineno); $$.u.ea.var = is_resource; } | t_array t_function { $$.u.opline_num = cg(zend_lineno); $$.u.ea.var = is_array; }
$$.u.ea.var 存储的是 函数返回类型,最后要拿他来跟返回值类型做匹配,
这样语法解释器就可以处理我们新的php语法了。
这还不够,还需要修改函数声明定义的处理逻辑
zend/zend_compile.c ::zend_do_begin_function_declaration
......zend_op_array op_array; char *name = function_name->u.constant.value.str.val; int name_len = function_name->u.constant.value.str.len; int function_type = function_token->u.ea.var; //保存函数类型,在语法解释器中增加的: $$.u.ea.var = is_long; int function_begin_line = function_token->u.opline_num;......op_array.function_name = name; op_array.fn_type = function_type; //将类型保存到op_array中, op_array.return_reference = return_reference; op_array.fn_flags |= fn_flags; op_array.pass_rest_by_reference = 0;..........
php是先解析php语法生成相应的opcode,将需要的环境、参数信息保存到execute_data全局变量中,最后在通过execute函数逐条执行opcode,
所以要做处理就要把函数的类型保存到opcode中:op_array.fn_type = function_type;
op_array是没有fn_type的,要修改op_array的结构,增加zend_uint fn_type;
(关于opcode你可以想象一下 从c转为汇编,我博客中也有相关文章,可以参考一下)
最后要修改opcode的毁掉函数,函数的返回 return 会生成token t_return,t_return会根据返回的类型调用不同的calback函数:
zend_return_spec_const_handlerzend_return_spec_tmp_handlerzend_return_spec_var_handler
它有三个callback,如果返回值是一个 const类型的数据,则 zend_return_spec_const_handler
返回值是临时数据,如 : return 1,则zend_return_spec_tmp_handler
返回值是一个变量,如 : return $a,则zend_return_spec_var_handler
所以要在这三个callback函数中增加处理逻辑:
在callback函数return之前增加如下代码
if((eg(active_op_array)->fn_type > 0) && z_type_p(retval_ptr) != eg(active_op_array)->fn_type){ php_error_docref0(null tsrmls_dc,e_warning, function name %s return a wrong type., eg(active_op_array)->function_name ); }
fn_type 去跟 返回值的类型作比较,如果没有匹配到,就会抛出这个warning。
我已经打了补丁,目前只支持php5.3版本,有需要的可以拿去玩一玩。
不清楚为什么官方不支持此语法,我觉得还是挺有必要的。
下载补丁:php-syntax.patch
续:
后来有找鸟哥(惠新宸:http://weibo.com/laruence) 聊过,
下面是他的回答:
“这个话题, 基本也是邮件组的月经贴了…. 1. 因为php是若类型, 很多类型可以互相转换, 那么到底要不要隐式转换, 你的实现是不转换, 这样的局限太大, 如果转换又涉及到各种转换规则. 2. 也不是不支持, 不过你的这个实现肯定是不够的(各种自定类,和继承类). 3. 以后如果要做jit, 可能会考虑支持.”
如此看来,这个问题官方也是比较纠结的,确实是我的思路是不强制转换,只需要抛出警告就行了,让开发人员自己决定是否转换,是不是更好?
原文出处:http://www.imsiren.com/archives/1123
其它类似信息

推荐信息