Laravel中Macroable巨集指令的用法-php教程-PHP中文網

這篇文章主要介紹了Laravel中Macroable宏指令的用法，有著一定的參考價值，現在分享給大家，有需要的朋友可以參考一下

百度百科的定義：
計算機科學裡的宏（Macro)，是一種批次處理的稱謂。一般說來，巨集是一種規則或模式，或稱語法替換，用於說明某一特定輸入（通常是字串）如何根據預先定義的規則轉換成對應的輸出（通常也是字串)。這種替換在預編譯時進行，稱作巨集展開。

我一開始接觸宏是在大學上電腦基礎課程時，老師講office時說的。那時老師介紹宏操作時沒太在意，只記得這一操作很強大，它能讓日常工作變得更容易。
今天我們講講Laravel中的巨集運算

首先完整的原始碼

<?php

namespace Illuminate\Support\Traits;

use Closure;
use ReflectionClass;
use ReflectionMethod;
use BadMethodCallException;

trait Macroable
{
    /**
     * The registered string macros.
     *
     * @var array
     */
    protected static $macros = [];

    /**
     * Register a custom macro.
     *
     * @param  string $name
     * @param  object|callable  $macro
     *
     * @return void
     */
    public static function macro($name, $macro)
    {
        static::$macros[$name] = $macro;
    }

    /**
     * Mix another object into the class.
     *
     * @param  object  $mixin
     * @return void
     */
    public static function mixin($mixin)
    {
        $methods = (new ReflectionClass($mixin))->getMethods(
            ReflectionMethod::IS_PUBLIC | ReflectionMethod::IS_PROTECTED
        );

        foreach ($methods as $method) {
            $method->setAccessible(true);

            static::macro($method->name, $method->invoke($mixin));
        }
    }

    /**
     * Checks if macro is registered.
     *
     * @param  string  $name
     * @return bool
     */
    public static function hasMacro($name)
    {
        return isset(static::$macros[$name]);
    }

    /**
     * Dynamically handle calls to the class.
     *
     * @param  string  $method
     * @param  array   $parameters
     * @return mixed
     *
     * @throws \BadMethodCallException
     */
    public static function __callStatic($method, $parameters)
    {
        if (! static::hasMacro($method)) {
            throw new BadMethodCallException("Method {$method} does not exist.");
        }

        if (static::$macros[$method] instanceof Closure) {
            return call_user_func_array(Closure::bind(static::$macros[$method], null, static::class), $parameters);
        }

        return call_user_func_array(static::$macros[$method], $parameters);
    }

    /**
     * Dynamically handle calls to the class.
     *
     * @param  string  $method
     * @param  array   $parameters
     * @return mixed
     *
     * @throws \BadMethodCallException
     */
    public function __call($method, $parameters)
    {
        if (! static::hasMacro($method)) {
            throw new BadMethodCallException("Method {$method} does not exist.");
        }

        $macro = static::$macros[$method];

        if ($macro instanceof Closure) {
            return call_user_func_array($macro->bindTo($this, static::class), $parameters);
        }

        return call_user_func_array($macro, $parameters);
    }
}

登入後複製

Macroable::macro方法

public static function macro($name, $macro)
{
    static::$macros[$name] = $macro;
}

登入後複製

很簡單的程式碼，根據參數的註釋，$macro可以傳一個閉包或對象，之所以可以傳對象，多虧了PHP中的魔術方法

class Father
{
    // 通过增加魔术方法**__invoke**我们就可以把对象当做闭包来使用了。
    public function __invoke()
    {
        echo __CLASS__;
    }
}

class Child
{
    use \Illuminate\Support\Traits\Macroable;
}

// 增加了宏指令之后，我们就能调用 Child 对象中不存在的方法了
Child::macro(&#39;show&#39;, new Father);
// 输出:Father
(new Child)->show();

登入後複製

Macroable::mixin方法

這個方法是把一個物件的方法的回傳結果注入到原始物件中

public static function mixin($mixin)
{
    // 通过反射获取该对象中所有公开和受保护的方法
    $methods = (new ReflectionClass($mixin))->getMethods(
        ReflectionMethod::IS_PUBLIC | ReflectionMethod::IS_PROTECTED
    );

    foreach ($methods as $method) {
        // 设置方法可访问，因为受保护的不能在外部调用
        $method->setAccessible(true);
        
        // 调用 macro 方法批量创建宏指令
        static::macro($method->name, $method->invoke($mixin));
    }
}

// 实际使用
class Father
{
    public function say()
    {
        return function () {
            echo &#39;say&#39;;
        };
    }

    public function show()
    {
        return function () {
            echo &#39;show&#39;;
        };
    }

    protected function eat()
    {
        return function () {
            echo &#39;eat&#39;;
        };
    }
}

class Child
{
    use \Illuminate\Support\Traits\Macroable;
}

// 批量绑定宏指令
Child::mixin(new Father);

$child = new Child;
// 输出:say
$child->say();
// 输出:show
$child->show();
// 输出:eat
$child->eat();

登入後複製

在上面的程式碼可以看出mixin可以將一個類別的方法綁定到巨集類別中。需要注意的就是，方法必須是傳回一個閉包類型。

Macroable::hasMacro方法

public static function hasMacro($name)
{
    return isset(static::$macros[$name]);
}

登入後複製

這個方法就比較簡單沒什麼複雜可言，就判斷是否存在宏指令。通常是使用宏指令之前判斷一下。

Macroable::__call和Macroable::__callStatic方法

正是由於這兩個方法，我們才能進行巨集操作，兩個方法除了執行方式不同，程式碼大同小異。這裡講一下__call

public function __call($method, $parameters)
{
    // 如果不存在这个宏指令，直接抛出异常
    if (! static::hasMacro($method)) {
        throw new BadMethodCallException("Method {$method} does not exist.");
    }

    // 得到存储的宏指令
    $macro = static::$macros[$method];

    // 闭包做一点点特殊的处理
    if ($macro instanceof Closure) {
        return call_user_func_array($macro->bindTo($this, static::class), $parameters);
    }

    // 不是闭包，比如对象的时候，直接通过这种方法运行，但是要确保对象有`__invoke`方法
    return call_user_func_array($macro, $parameters);
}


class Child
{
    use \Illuminate\Support\Traits\Macroable;

    protected $name = &#39;father&#39;;
}

// 闭包的特殊处理，需要做的就是绑定 $this, 如
Child::macro(&#39;show&#39;, function () {
    echo $this->name;
});

// 输出:father
(new Child)->show();

登入後複製

在上面的操作中我們綁定巨集時，在閉包中可以透過$this來呼叫Child的屬性，是因為在__call方法中我們使用Closure::bindTo方法。