php:給php增加函式強制型別返回

發表於2016-04-09

在開發過程中，函式的返回值型別應該是確定不變的，但PHP是弱型別的語言，所以PHP是沒有此類語法驗證的，正因為如此，造成了很多坑坑。

比如下面的程式碼：

<?php
function getArticles(...){
    $arrData = array();
    if($exp1){
      return $arrData;
    }else if($exp2){
      return 1;
    }else{
      return false;
    }

}
$arrData =getArticles(...);
foreach($arrData as $record){
//do something.
....
}
?>

<?php

function getArticles(...){

$arrData = array();

if($exp1){

return $arrData;

}else if($exp2){

return 1;

}else{

return false;

}

$arrData =getArticles(...);

foreach($arrData as $record){

//do something.

....

}

函式getArticles根據不同的條件返回不同型別的值，有bool、int、還有陣列，正常情況這類函式是希望返回陣列，然後拿陣列去做一些其他操作，可因為函式返回值型別不固定，呼叫時就很可能產生各種預想不到的坑，因此我就想，既然不能規範，那直接強制好了。

函式/方法返回值可以強制型別：

int function a(){
    ......
    return 1;
}

bool function b(){
    ......
    return false;
}

array function c(){
    ......
    return array();
}

object function d(){
    ......
    return new a();
}

int function a(){

......

return 1;

}

bool function b(){

......

return false;

}

array function c(){

......

return array();

}

object function d(){

......

return new a();

}

支援四種強制型別限制：int、array、bool、object，當返回值與函式宣告中的型別不匹配時，丟擲warning，本來想丟擲error，但是覺得太狠了，只能算是個異常，不能算錯誤，所以就用warning好了。

PHP本身是不支援 int function 這樣的語法的，所以要支援，就先要搞定語法解析器，關於語法解析器，可以移步這裡»>檢視詳情，這裡就不講了，
先修改語法掃描 Zend/zend_language_scanner.l檔案

增加如下程式碼：

<ST_IN_SCRIPTING>"int" {
    return T_FUNCTION_RETURN_INT;
}
<ST_IN_SCRIPTING>"bool" {
    return T_FUNCTION_RETURN_OBJECT;
}
<ST_IN_SCRIPTING>"object" {
    return T_FUNCTION_RETURN_OBJECT;
}
<ST_IN_SCRIPTING>"resource" {
    return T_FUNCTION_RETURN_RESOURCE;
}

<ST_IN_SCRIPTING>"int" {

return T_FUNCTION_RETURN_INT;

}

<ST_IN_SCRIPTING>"bool" {

return T_FUNCTION_RETURN_OBJECT;

}

<ST_IN_SCRIPTING>"object" {

return T_FUNCTION_RETURN_OBJECT;

}

<ST_IN_SCRIPTING>"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_RESOURCE
1

然後增加token處理邏輯：

1
function:
        T_FUNCTION { <span class="MathJax_Preview">\(.u.opline_num = CG(zend_lineno);\)</span>.u.EA.var  = 0; }
    |   T_FUNCTION_RETURN_INT T_FUNCTION {
            <span class="MathJax_Preview">\(.u.opline_num = CG(zend_lineno);
            \)</span>.u.EA.var = IS_LONG;
    }
    |   T_FUNCTION_RETURN_BOOL T_FUNCTION {
            <span class="MathJax_Preview">\(.u.opline_num = CG(zend_lineno);
            \)</span>.u.EA.var = IS_BOOL;
    }
    |   T_FUNCTION_RETURN_STRING T_FUNCTION {
            <span class="MathJax_Preview">\(.u.opline_num = CG(zend_lineno);
            \)</span>.u.EA.var = IS_STRING;
    }
    |   T_FUNCTION_RETURN_OBJECT T_FUNCTION {
            <span class="MathJax_Preview">\(.u.opline_num = CG(zend_lineno);
            \)</span>.u.EA.var = IS_OBJECT;
    }
    |   T_FUNCTION_RETURN_RESOURCE T_FUNCTION {
            <span class="MathJax_Preview">\(.u.opline_num = CG(zend_lineno);
            \)</span>.u.EA.var = IS_RESOURCE;
    }
    |   T_ARRAY T_FUNCTION {
            <span class="MathJax_Preview">\(.u.opline_num = CG(zend_lineno);
            \)</span>.u.EA.var = IS_ARRAY;
    }

..........

%token T_FUNCTION_RETURN_INT

%token T_FUNCTION_RETURN_BOOL

%token T_FUNCTION_RETURN_STRING

%token T_FUNCTION_RETURN_OBJECT

%token T_FUNCTION_RETURN_RESOURCE

然後增加token處理邏輯：

function:

T_FUNCTION { $$.u.opline_num = CG(zend_lineno);$$.u.EA.var = 0; }

| T_FUNCTION_RETURN_INT T_FUNCTION {