处理 PHP 7 返回类型的正确方法

Question

我正忙于创建应用程序，我想使用 PHP 7 返回类型。现在我在 php.net 上读到，在定义返回类型时，不允许返回 null，这是一个设计决定。

处理这个问题的正确方法是什么？

一个选项是 try...catch 块：

public function getMyObject() : MyObject
{ 
     return null;
}

try
{
    getMyObject();
}
catch(Exception $e)
{
    //Catch the exception
}

对此我感觉不太好，因为我的代码将是一个巨大的 try...catch 块，因为我需要为每个返回对象的方法编写一个 try...catch 块。

Null Object Pattern 是一个很好的解决方案，但我不喜欢为我的应用程序中的每个对象创建一个NullObject 的想法。 有正确的方法吗？

Answer 1

如果您的代码希望返回一个类的实例，在本例中为 MyObject，但它没有返回，那么这确实是一个异常，应该这样处理。

但是，你应该自己抛出这个异常。

public function getMyObject() : MyObject
{
    throw new MyCustomException("Cannot get my object");
}

然后您可以捕获该特定异常并进行相应处理。

Answer 2

对此我感觉不太好，因为我的代码将是一个巨大的 try/catch 块，因为我需要为每个返回对象的方法编写一个 try/catch 块。

替代方法（使用您的代码）将始终检查 null 的返回值，以免因使用 null 作为对象而出错。

使用异常更有表现力，并且可以让错误及早发现，这是一件好事。因此，要么确保您的方法始终返回一个对象，要么在它无法履行合同时抛出异常。否则返回类型没有实际值。

Answer 3

您可以使用Option 数据类型。

这是一种将Something 或Nothing 作为包装值的类型。

您可以找到更详细的描述 here 和 PHP here 中的开放实现之一

PS 请不要对这种逻辑使用异常、输出参数或附加方法，这是一个错误的工作工具。

Answer 4

目前这是不可能的，尽管如前所述，有 RFC 可能会解决未来版本的问题。

到目前为止，您的选择是：

1.从您的方法签名中删除返回类型：

public function getMyObject()
{ 
     return null;
}

2. 抛出并捕获异常（根据@NiettheDarkAbsol 的回答）：

public function getMyObject() : MyObject
{
    throw new MyCustomException("Cannot get my object");
}

3.重构为两种方法：

private $myObject;
//TODO think of a better method name
public function canGetMyObject() : bool
{
    $this->myObject = new myObject();
    return true;
}

public function getMyObject() : MyObject
{
    if(!$this->myObject){
        throw new MyCustomException("Cannot get my object");
    }
    return $this->myObject;
}

调用代码：

if($cls->canGetMyObject()){
    $myObject  = $cls->getMyObject();
}

4.使用bool返回类型和out参数：

public function tryGetMyObject(&$out) : bool
{
    $out = new myObject();
    return true;
}

调用代码：

$myObject = null;

if($cls->tryGetMyObject($myObject)){      
    $myObject->someMethod(); //$myObject is an instance of MyObject class
}

第 3 和第 4 选项仅在预期返回 null 且频繁出现的情况下才真正值得考虑，因此异常开销是一个因素。 可能你会发现这实际上并不经常适用，例外是前进的方向

Answer 5

从 PHP7.1 开始，您可以使用可为空的返回类型：

public function getMyObject(): ?MyObject {
  return null;
}

http://php.net/manual/en/migration71.new-features.php

Answer 6

我也想问。我认为这没什么意义。

如果我有以下示例代码来按名称查找用户：

<?php

class User
{
    protected $name;

    /**
     * User constructor.
     *
     * @param $name
     */
    public function __construct(string $name)
    {
        $this->name = $name;
    }

    /**
     * @return mixed
     */
    public function getName() : string
    {
        return $this->name;
    }
}


function findUserByName(string $name, array $users) : User {
    foreach ($users as $user) {
        if ($user->getName() == $name) {
            return $user;
        }
    }

    return null;
}


$users = [
    new User('John'), new User('Daniel')
];

$user = findUserByName('John', $users);

echo $user->getName()."\n";

$user2 = findUserByName('Micheal', $users);

我想告诉 Php 我可以获取 User 或 null。现在我需要将它始终包装在 try catch 块中，在这种情况下我认为声明返回类型没有多大意义。另一方面，如果我的 findUserByName 函数很复杂，我可能会意外返回，例如用户名而不是完整的用户对象，所以我想定义返回类型。

我认为更合理的是为函数定义多种返回类型。有时您创建返回一个对象或对象数组的函数，并且定义该函数应该返回例如User 或用户数组：User[]。

在 OP 情况下（也是我的情况），我们可以将返回类型声明为 User, null，这样就可以解决问题。