什麼是魔術方法？如何在 Laravel 中使用

Laravel 9 保姆級視訊教學，想學不會都難！進入學習

Laravel將PHP應用到了一個全新的水平，為您打造下一個專案提供了出色的開發體驗（DX）。因此，一些人將其稱為「魔術」。

今天，我將向您展示Laravel的一個技巧，魔術方法。

什麼是魔術方法？

重要的是，要了解魔術方法並不是Laravel獨有的，而是可以在任何PHP應用中使用。Laravel恰好有一些最有趣的魔術方法用例。

魔術方法是在PHP中宣告的任何類中都可以使用的方法，它提供了在類中實現附加功能的方法。

這裡有一個很好的定義：

魔術方法永遠不會被程式設計師呼叫——實際上，PHP將在後臺呼叫該方法。這就是為什麼它們被稱為「魔術」方法——因為它們從來沒有被直接呼叫，它們允許程式設計師做一些非常強大的是事情。

總共有15中魔術方法：

class MyClass
{
    public function __construct() {}

    public function __destruct() {}

    public function __call() {}

    public function __callStatic() {}

    public function __get() {}

    public function __set() {}

    public function __isset() {}

    public function __unset() {}

    public function __sleep() {}

    public function __wakeup() {}

    public function __toString() {}

    public function __invoke() {}

    public function __set_state() {}

    public function __clone() {}

    public function __debuginfo() {}
}

如果您用PHP做過一些物件導向的程式設計，那麼您一定知道 __construct 方法，這是一個魔術方法。所以您一直在使用魔術方法。

您還注意到，所有的魔術的方法都是以「__」為字首的。

今天，我們不會深入研究這些方法，而只會深入瞭解整個Laravel程式碼庫中使用的那些有趣的方法。如果其他人對此感興趣，請隨時檢視下面的檔案?

PHP: Méthodes magiques - Manual

Laravel是如何使用的魔術方法

__get()

Laravel中的模型非常特別。它們不將屬性資料儲存為類的直接屬性，而是儲存在protected $attributes 屬性中，該屬性是模型所儲存的所有資料的相關陣列。

讓我們看看簡單的PHP類和Laravel模型存取屬性的區別。

<?php

/**
 * PHP中的普通使用者類（非Laravel）將只是一個具有上述屬性的類
 */
class NormalUser
{
    public $firstName = 'Alice';
}

$normalUser = new NormalUser;

$normalUser->firstName; // 將返回'Alice'

<?php

namespace App;

use Illuminate\Database\Eloquent\Model;

/**
 * Laravel中的一個user類
 */
class LaravelUser extends Model
{
    /**
     * 注意，我們將所有屬性資料儲存在一個單獨的陣列中
     */
    protected $attributes = [
        'firstName' => 'Alice',
    ];
}

$laravelUser = new LaravelUser;

$laravelUser->firstName; // 依然返回'Alice'

我們可以看到，上面的PHP和Laravel類的行為完全相同。

然而，在Laravel的例子中，屬性不像普通PHP那樣儲存，而是集中在一個名為$attributes的屬性中。我們仍然設法存取正確的資料，但是如何存取呢?

這一切都是可能的，這是因為_get魔術方法。讓我們自己嘗試實現一個簡單的例子。

<?php

class NormalUser
{
    /**
     * 像在Laravel中那樣宣告屬性
     */
    protected $attributes = [
        'firstName' => 'Alice',
    ];

    /**
     *  __get 函數接收一個引數
     * 它將會是你想要存取的屬性名
     * 在這個例子中是 $key = "firstName"
     */
    public function __get(string $key)
    {
        return $this->attributes[$key];
    }
}

$normalUser = new NormalUser;

$normalUser->firstName; // 將會返回 'Alice'

我們做到了！ ?

我們需要注意，只有在類中找不到具有匹配名稱的屬性時，才會呼叫魔術方法_get。這是一種後備方法，當PHP在類中找不到所存取的屬性時呼叫。因此，在下面的範例中，根本不會呼叫魔術方法_get。

<?php

class NormalUser
{
    public $firstName = 'Bob';

    protected $attributes = [
        'firstName' => 'Alice',
    ];

    public function __get($key)
    {
        return $this->attributes[$key];
    }
}

$normalUser = new NormalUser;

/**
 * 由於類中存在該屬性，將會返回 Bob
 * 所以該例子中沒有呼叫到魔術方法__get
 */
$normalUser->firstName;

有更多的事情在幕後發生。如果你想更多地瞭解 Laravel 的模型是如何確切地使用 __get 的，你可以檢視下面的原始碼。

laravel/framework

__set()

當試圖設定的屬性沒有在類中宣告時，使用魔術方法_set。讓我們再次看看normal PHP類和Laravel中model模型的區別。

<?php

class NormalUser
{
    public $firstName = 'Alice';
}

$normalUser = new NormalUser;

$normalUser->firstName = 'Bob';

$normalUser->firstName; // Will return 'Bob'

<?php

namespace App;

use Illuminate\Database\Eloquent\Model;

class LaravelUser extends Model
{
    protected $attributes = [
        'firstName' => 'Alice',
    ];
}

$laravelUser = new LaravelUser;

$laravelUser->firstName = 'Bob';

$laravelUser->firstName; // Will return 'Bob' as well

如我們所見，在此範例中，我們仍然嘗試影響Bob的值，該值在類中實際上不存在但位於屬性$ attributes中。讓我們嘗試使用魔術方法__ set

<?php

class NormalUser
{
    public $attributes = [
        'firstName' => 'Alice',
    ];

    /**
     * The magic method __set receives the $name you want to affect the value on
     * and the value
     */
    public function __set($key, $value)
    {
        $this->attributes[$key] = $value;
    }
}

$normalUser = new NormalUser;

$normalUser->firstName = 'Bob';

/**
 * As we don't have the __get magic method define in this example for simplicity sake,
 * we will access the $attributes directly
 */
$normalUser->attributes['firstName']; // Will return 'Bob'

現在我們開始！我們在Laravel中成功實施了__ get和__ set魔術方法的基本用法！他們只需幾行程式碼就能完成！

請記住，這些魔術方法儘可能簡單，而不必涉及太多細節，因為除了那些還有更多而不僅僅是用例，如果您對它的工作原理感到好奇，我邀請您親自做一些探索！ (如果您有任何疑問，也可以隨時在Twitter上與我聯絡)

同樣，如果您想進一步挖掘，請在此處連結到原始碼

laravel/framework

讓我們繼續最後一個也是最有趣的一個事！ ?

__call() & __callStatic()

當呼叫的方法在類中找不到時，__call()會被呼叫。 在laravel中，該魔術方法方法使宏在 php 中成為可能。

我不會深入討論宏的所有細節，但如果您感興趣，這裡有一篇很好的文章解釋瞭如何在 Laravel 應用程式中使用它們?

The Magic of Laravel Macros

讓我們試著看看如何編寫一個簡單的宏範例。

<?php

class NormalUser
{
    public $firstName = 'Alice';

    public $lastName = 'Bob';
}

$normalUser = new NormalUser;

$normalUser->fullName(); // 由於沒有宣告 "fullName" 方法，這將會丟擲錯誤

使用 __call ，可以定義一個包含閉包函數的陣列，在我們開發時可以程式化地新增到應用裡。

<?php

class NormalUser
{
    public $firstName = 'Alice';

    public $lastName = 'Bob';

    /**
     * 將我們的宏初始化為一個空陣列，後面再賦值
     */
    public static $macros = [];

    /**
     * 定義一個新增新宏的方法
     * 第一個引數是我們想要定義的宏的名字
     * 第二個引數是呼叫宏時將會被執行的閉包函數
     */
    public static function addMacro($name, $macro) {
        static::$macros[$name] = $macro;
    }

    /**
     * "__call" 接收兩個引數,
     * $name 是被呼叫的函數名稱，比如 「fullName」
     * $arguments 是傳遞給函數的所有引數，這裡我們使用了一個空陣列，因為我們的函數不用傳參
     */
    public function __call(string $name, array $arguments) {
        /**
         * 通過名稱獲取到宏
         */
        $macro = static::$macros[$name];
        /**
         * 然後通過引數執行宏
         * 備註：呼叫之前，我們需要將閉包繫結到 「$this」，從而使宏方法在同樣的上下文中執行
         */
        return call_user_func_array($macro->bindTo($this, static::class), $arguments);
    }
}

$normalUser = new NormalUser;

$normalUser->fullName(); // 這裡會中斷，因為我們既沒有定義 「fullName」 宏，也沒有 「fullName」 方法存在。

/**
 * 新增 「fullName」 宏方法
 */
NormalUser::addMacro('fullName', function () {
    return $this->firstName.' '.$this->lastName;
});

$normalUser->fullName(); // 現在，返回 「Alice Bob」

宏要比那個複雜一些，但是我們設法使用 __call 魔術方法來建立一個宏的簡單工作版本。

除了對於靜態方法， __callStatic 和 __call 是完全一樣的。

如果你打算自己再深入研究，這裡有宏的特性原始碼。

laravel/framework

總結

所以說碼農們，當你第一次用 Laravel 會感覺它神奇是對的，但是通過深入檢視原始碼，你會理解魔法是如何在場景背後施展的。

就像現實生活中的魔法，沒有道理的事情是不會發生的，在程式碼中就更加是了。程式執行的背後總是有著一行程式碼在執行，只不過需要你去發現它。

英文原文地址：https://dev.to/stvnyung/laravel-greatest-trick-revealed-magic-methods-31om

譯文地址：https://learnku.com/laravel/t/40926

【相關推薦：】

以上就是什麼是魔術方法？如何在 Laravel 中使用的詳細內容，更多請關注TW511.COM其它相關文章！