Laravel 避免 Trying to get property of non-object 錯誤的六種方法 [新增第六種 data_get]

在使用鏈式操作的時候，例如：

return $user->avatar->url;

如果 $user->avatar 為 null，就會引起 (E_ERROR) Trying to get property 'url' of non-object 錯誤。

1. 常規方法是使用 isset 加以判斷：

if(isset($user->avatar->url))
    return $user->avatar->url;
else
    return 'defaultUrl';

如果在 blade 模板的 echo 中，可以使用：

{{ $user->avatar->url or 'defaultUrl' }}

上述程式碼會被 Blade 引擎解析為：

echo e(isset($user->avatar->url) ? $user->avatar->url : 'defaultUrl');

Laravel 5.7 已經取消了這個特性。詳見：https://github.com/laravel/framework/pull/23532 。感謝 @jltxwesley 提醒。

2. PHP7 可以使用 ?? (NULL 合併操作符) :

// 如果 $user->avatar->url 為 null, 返回 'defaultUrl'
return $user->avatar->url ?? 'defaultUrl';

3. Laravel 5.5 及以上可以使用 optional 輔助函式：

/**
 * 如果給定的物件是 null ， 那麼屬性和方法會簡單地返回 null 而不是產生一個錯誤：
 */
return optional($user->avatar)->url;

詳見 https://learnku.com/docs/laravel/5.7/helpers/1320#method-optional

Laravel 5.7 中，optional 函式還可以接受 匿名函式 作為第二個引數：

/**
 * 如果第一個引數不為 null, 則呼叫閉包
 * 詳見 https://laravel\com/docs/5.7/helpers#method-optional
 */
return optional(User::find($id), function ($user) {
    return new DummyUser;
});

4. 使用 object_get 輔助函式

return object_get($user->avatar, 'url', 'default');

這個函式原意是用來已 . 語法來獲取物件中的屬性，例如：

return object_get($user, 'avatar.url', 'default');

也可以達到避免 non-object 錯誤的效果。

if (! function_exists('object_get')) {
    /**
     * Get an item from an object using "dot" notation.
     *
     * @param  object  $object
     * @param  string  $key
     * @param  mixed   $default
     * @return mixed
     */
    function object_get($object, $key, $default = null)
    {
        if (is_null($key) || trim($key) == '') {
            return $object;
        }

        foreach (explode('.', $key) as $segment) {
            if (! is_object($object) || ! isset($object->{$segment})) {
                return value($default);
            }

            $object = $object->{$segment};
        }

        return $object;
    }
}

詳見 https://github.com/laravel/framework/blob/master/src/Illuminate/Support/helpers.php#L673

感謝 @lovecn 提供姿勢！

5. 使用 data_get 輔助函式

return data_get($user, 'avatar.url', 'default');

或

return data_get($user, ['avatar', 'url'], 'default');

以 . 語法來獲取物件屬性或陣列元素。

if (! function_exists('data_get')) {
    /**
     * Get an item from an array or object using "dot" notation.
     *
     * @param  mixed   $target
     * @param  string|array  $key
     * @param  mixed   $default
     * @return mixed
     */
    function data_get($target, $key, $default = null)
    {
        if (is_null($key)) {
            return $target;
        }
        $key = is_array($key) ? $key : explode('.', $key);
        while (! is_null($segment = array_shift($key))) {
            if ($segment === '*') {
                if ($target instanceof Collection) {
                    $target = $target->all();
                } elseif (! is_array($target)) {
                    return value($default);
                }
                $result = [];
                foreach ($target as $item) {
                    $result[] = data_get($item, $key);
                }
                return in_array('*', $key) ? Arr::collapse($result) : $result;
            }
            if (Arr::accessible($target) && Arr::exists($target, $segment)) {
                $target = $target[$segment];
            } elseif (is_object($target) && isset($target->{$segment})) {
                $target = $target->{$segment};
            } else {
                return value($default);
            }
        }
        return $target;
    }
}

詳見 https://github.com/laravel/framework/blob/master/src/Illuminate/Support/helpers.php#L450

感謝 @Hachiko 提供姿勢！

6.除此之外，還可以使用 Null Object Pattern(空物件模式):

《點燈坊:如何實現 Null Object Pattern ?》

感謝群裡大佬 @盒子 和 @Outshine 提供的姿勢。:kissing: :kissing: :kissing: