轉載自:https://tlanyan.me/argument-type-declare-in-php/
PHP7開始支持標量類型聲明,強類型語言的味道比較濃。使用這個特性的過程中踩過兩次坑:一次是聲明boolean類型參數,最近一次是聲明double類型參數,都導致運行時出錯。爲避免以後繼續犯類似錯誤,這幾天翻閱了官方文檔。本文是看完後對PHP函數的類型聲明使用做的總結。
從語法上,PHP的函數定義經過了幾個時期:
遠古時代(PHP 4)
定義一個函數非常的簡單,使用 function name(args) {body}
的語法聲明。不能指定參數和返回值類型,參數和返回值類型有無限種可能。這是到目前爲止最常見的函數聲明方式。
數組和引用類型參數值聲明(PHP 5)
數組(array)、類(class)、接口(interface)、函數(callable)可以用在函數聲明中。從5.6開始,支持常量(包括類常量)爲默認參數,以及參數數組(以省略號…爲前綴)。例如
function sum(...$numbers) { $sum = 0; foreach ($numbers as $number) { $sum += $number; } return $sum; } |
注意:如果參數的值可能爲null,null必須爲參數的默認值,否則調用時會出錯。例如:
function foo(array $arr = null) { ... } |
標量類型和返回值聲明(PHP 7)
函數正式支持標量類型(int, bool, float,string)和返回值類型(可聲明類型同參數)聲明。從這個版本開始,除了語法差異,函數聲明形式上可以做到像強類型語言。
遺憾是如果函數返回值有可能是null,就不能指定返回值類型。例如:
function getModel() : Foo { if ($this->_model === null) { $this->_model = xxxx; // get from db or otherelse } return $this->_model; // 如果$this->_model仍是null,運行出錯 } |
參數和返回值可爲null以及void返回類型聲明(PHP 7.1)
當參數和返回值類型有可能是null時,類型前以問號(?)修飾,可以解決null值問題(與默認參數不衝突);類型聲明新增iterable,同時還支持void類型返回值。例如:
function getModel(?int $id) : ?Foo { if ($id !== null) { $this->_model = xxxx; } else { $this->_model = yyyy; } return $this->_model; } // 調用 $foo->getModel(null); $foo->getModel(100); // 函數聲明瞭參數並且沒有提供默認參數,調用時不傳入參數會引發錯誤 // 將函數聲明改成 getModel(?int $id = 100) {},可以不傳參數 $foo->getModel(); |
當函數返回值爲void時,函數體的不能return任何東西(return void;
的寫法也是錯誤的!),或者可以省略return語句。
function test(array $arr) : void { if (!count($arr) { return; } // 不要return; array_walk($arr, function ($elem) {xxxx}); } |
回顧以上歷史變更,可以看到在PHP 7.1中函數類型聲明已經十分完善(雖然實踐中用的不多)。注意,文章說的是參數和返回值類型聲明,PHP不保證運行過程中參數類型不變,即下面的代碼是合法的:
function foo(array $arr) : array { // change $arr from array to int $arr = 3; return []; } |
從這點上看,PHP還是弱類型語言,不能做靜態編譯。
再說說實踐中踩到的坑。根據官方文檔,函數參數和返回值類型聲明可用的類型有:
- 類/接口
- self,只能用在自身的方法上
- array
- bool
- callable
- int
- float
- string
- iterable
- void(僅用在返回值)
注意列表中並沒有boolean和double類型!除非你定義了這兩個類型,否則用在參數和返回值中是錯誤的!
這也是PHP有點蛋疼的地方。平常使用時的double和float兩個關鍵字幾乎等同,例如doubleval是floatval的別名,is_double是is_float的別名,轉換時用(double)和(float)效果相同。但在用在類型聲明就不一樣,同樣的情況出現在bool和boolean身上。
總結
目前PHP 7.2穩定版已經發布,建議在新項目中儘量使用PHP 7.1及後續版本。爲了寫出清晰和可維護的代碼,推薦聲明類型。建議引用類型或者string才使用null值,int/float等標量類型的參數儘量不要用null。func_get_argc等函數,如非必要,儘量不使用。