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

转载  更新时间:2018年07月10日 15:11:48   作者:施国鹏   我要评论

这篇文章主要给大家介绍了关于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('show', 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 '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方法

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 = '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如何开启跨域功能示例详解

    laravel如何开启跨域功能示例详解

    这篇文章主要给大家介绍了关于laravel如何开启跨域功能的相关资料,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面跟着小编来一起学习学习吧。
    2017-08-08
  • php用正则表达式匹配URL的简单方法

    php用正则表达式匹配URL的简单方法

    使用正则表达式匹配URL的简单方法,提供测试代码
    2013-11-11
  • PHP实现动态web服务器方法

    PHP实现动态web服务器方法

    这篇文章主要通过PHP技术实现动态web服务器的方法,有需要的朋友可以借鉴。
    2015-07-07
  • 分享一个Laravel好用的Cache宏

    分享一个Laravel好用的Cache宏

    这篇文章主要介绍了分享一个Laravel好用的Cache宏的方法的相关资料,需要的朋友可以参考下
    2015-03-03
  • php pthreads多线程的安装与使用

    php pthreads多线程的安装与使用

    这篇文章主要介绍了php pthreads多线程的安装与使用 的相关资料,需要的朋友可以参考下
    2016-01-01
  • PHP实现多条件查询实例代码

    PHP实现多条件查询实例代码

    在我们的网站设计过程中,经常会用到多条件查询,本文的源码是一个二手房屋查询的例子。在本例中,我们要实现能够通过地理位置,物业类型,房屋价格,房屋面积及信息发布日期等多个条件查询到客户所需的资料。
    2010-07-07
  • PHP用户注册邮件激活账户的实现代码

    PHP用户注册邮件激活账户的实现代码

    我们在注册一个网站的账户时,通常都会收到一封含点击链接激活的邮件,本篇文章主要介绍了PHP邮件激活账户的实现代码,有兴趣的可以了解一下
    2017-05-05
  • CI框架中libraries,helpers,hooks文件夹详细说明

    CI框架中libraries,helpers,hooks文件夹详细说明

    CodeIgniter 是一个小巧但功能强大的 PHP 框架,作为一个简单而“优雅”的工具包,它可以为 PHP 程序员建立功能完善的 Web 应用程序。今天我们来看看CI框架中几个文件夹都是干什么用的
    2014-06-06
  • 跟我学Laravel之快速入门

    跟我学Laravel之快速入门

    本文是本系列教程中的第一篇,主要介绍一些 Laravel 基础部分,但是还有更让人兴奋的东西要学。这是后面文章我们要进一步深入的
    2014-10-10
  • PHP+javascript制作带提示的验证码源码分享

    PHP+javascript制作带提示的验证码源码分享

    经常看的别人网站上输完验证码,可以直接判断正确与否,感觉体验非常不错,赶紧给自己网站也加上,源码分享给大家
    2014-05-05

最新评论