PHP函数类型声明总结

tlanyan · · 142 次点击 · · 开始浏览    
这是一个创建于 的文章,其中的信息可能已经有所发展或是发生改变。

转载请注明出处: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还是弱类型语言,不能做静态编译。

再说说实践中踩到的坑。根据官方文档,函数参数和返回值类型声明可用的类型有:

  1. 类/接口
  2. self,只能用在自身的方法上
  3. array
  4. bool
  5. callable
  6. int
  7. float
  8. string
  9. iterable
  10. 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等函数,如非必要,尽量不使用。

参考

  1. http://php.net/manual/en/functions.arguments.php
  2. http://php.net/manual/en/migration70.new-features.php
  3. http://php.net/manual/en/migration71.new-features.php

本文来自:开源中国博客

感谢作者:tlanyan

查看原文:PHP函数类型声明总结

142 次点击  
加入收藏 微博
暂无回复
添加一条新回复 (您需要 登录 后才能回复 没有账号 ?)
  • 请尽量让自己的回复能够对别人有帮助
  • 支持 Markdown 格式, **粗体**、~~删除线~~、`单行代码`
  • 支持 @ 本站用户;支持表情(输入 : 提示),见 Emoji cheat sheet