Laravel中简约却不简单的Macroable宏指令详解

前端之家收集整理的这篇文章主要介绍了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,$parameters);
}

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

Macroable::macro方法

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

很简单的代码,根据参数的注释,$macro可以传一个闭包或者对象,之所以可以传对象,多亏了PHP中的魔术方法

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

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

Macroable::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 'say';
};
}

public function show()
{
return function () {
echo 'show';
};
}

protected function eat()
{
return function () {
echo 'eat';
};
}
}

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方法

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

这个方法就比较简单没什么复杂可言,就判断是否存在宏指令。通常是使用宏指令之前判断一下。

* Macroable::__call和Macroable::__callStatic方法

正是由于这两个方法,我们才能进行宏操作,两个方法除了执行方式不同,代码大同小异。这里讲一下__call

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

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

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

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

protected $name = 'father';
}

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

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

在上面的操作中我们绑定宏时,在闭包中可以通过$this来调用Child的属性,是因为在__call方法中我们使用Closure::bindTo方法

官网对Closure::bindTo的解释:复制当前闭包对象,绑定指定的$this对象和类作用域。

Laravel 中对类增加宏指令

Laravel中很多类都使用了宏这个trait

比如Illuminate\Filesystem\Filesystem::class,我们想为这个类增加一个方法,但不会动到里面的代码

1. 我们只需要到App\Providers\AppServiceProvider::register方法增加宏指令(你也可以专门新建一个服务提供者专门处理)

2. 然后增加一条测试路由,测试我们新增加方法

3. 然后打开浏览器运行,你就会发现,我们的代码可以正常的运行了并输出结果了

总结

以上就是这篇文章的全部内容了,希望本文的内容对大家的学习或者工作具有一定的参考学习价值,如果有疑问大家可以留言交流,谢谢大家对编程之家的支持

猜你在找的Laravel相关文章