Laravel 中简约而不简单的 Macroable 宏指令 1
百度百科的定义:
计算机科学里的宏(Macro),是一种批量处理的称谓。一般说来,宏是一种规则或模式,或称语法替换 ,用于说明某一特定输入(通常是字符串)如何根据预定义的规则转换成对应的输出(通常也是字符串)。这种替换在预编译时进行,称作宏展开。
- 我一开始接触宏是在大学上计算机基础课程时,老师讲office时说的。那时老师介绍宏操作时没太在意,只记得这一操作很强大,它能使日常工作变得更容易。
- 今天我们讲讲Laravel中的宏操作
首先完整的源码
<?phpnamespace 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
,我们想为这个类增加一个方法,但不会动到里面的代码。
- 我们只需要到
App\Providers\AppServiceProvider::register
方法增加宏指令(你也可以专门新建一个服务提供者专门处理)
- 然后增加一条测试路由,测试我们新增加的方法
- 然后打开浏览器运行,你就会发现,我们的代码可以正常的运行了并输出结果了
原文地址
Laravel 中简约而不简单的 Macroable 宏指令 1相关推荐
- Laravel 中简约而不简单的 Macroable 宏指令
百度百科的定义: 计算机科学里的宏(Macro),是一种批量处理的称谓.一般说来,宏是一种规则或模式,或称语法替换 ,用于说明某一特定输入(通常是字符串)如何根据预定义的规则转换成对应的输出(通常也是 ...
- laravel中防止表单重复提交的综合解决方案
[本文转载自Hyes]http://www.hao124.net/article/14 怎样防止表单重复提交,通过搜索引擎能搜到很多结果,但很零散,系统性不强,正好前几天做了这个功能,决定记录下来. ...
- Laravel中一些要记住 的写法
Laravel中一些要记住 的写法 模型篇: 1.根据数据库部分URL返回完整的URL public function getImageUrlAttribute(){// 如果 image 字段本身就 ...
- laravel token ajax,Laravel中ajax post操作需要传递csrf token的最优化解决方式
在Laravel框架中为了防止csrf攻击,规定只要是post操作都要传递_token值,如果是普通表单那么只要在form中添加@csrf代码就可以了,如果采用ajax方式提交post请求时,最简单的 ...
- php validate form,laravel 中validate验证规则 利用FormRequest进行数据验证
namespace App\Http\Requests; use Illuminate\Foundation\Http\FormRequest; class AddCartRequest extend ...
- php 两个类 相互调用_如何在 PHP 和 Laravel 中使用 Traits
事实上,PHP 作为一门编程语言存在的问题之一,就是你只能使用单继承.这意味着一个类只能从另一个类中继承.例如,可能希望从几个不同的类继承方法,以防止代码重复.在 PHP 5.4 中 一个新的语言特性 ...
- Laravel中优雅的验证日期需要大于今天
我们有时会碰到一个场景,比如买车票,需要进行查询车票剩余,这时候需要一个日期范围,开始日期必须大于等于今天,结束日期必须大于等于开始日期. Version Laravel 5.5.40 PHP 7.1 ...
- php调用trait方法,PHP Laravel中的Trait使用方法
Trait是一种在单继承语言(如PHP)中重用代码的机制.Trait旨在通过使开发人员能够在生活在不同类层次结构中的多个独立类中自由地重用方法集来减少单继承的某些限制.Traits和类组合的语义以降低 ...
- laravel中artisan工具(命令)的使用详解
artisan工具,首先,这个是一个php文件,它放在我们laravel框架的根目录 Artisan工具简介 Artisan 是 Laravel 中自带的命令行工具的名称.它提供了一些对您的应用开发有 ...
最新文章
- 分享一些 WINDOWS 资源站点(备用)
- 找出最大和第二大的数PHP,2020-09-01 十大经典排序算法总结php为例
- 桌面快捷键和桌面livefolder
- asterisk的NAT配置
- /bin/bash^M: bad interpreter: No such file or directory
- 疫情之后,人工智能该如何走?
- java 之 单例模式(大话设计模式)
- ADO.NET Entity Framework 学习(1)
- 批处理(bat)xcopy详解
- 网络安全术语表(英文-缩写-中文-定义)
- php万能密码在线视频讲解,万能密码
- 大数据,云计算,人工智能之间的关系
- cubieboard笔记
- 【fk_index】外键中有无索引的区别
- call cs iub wireshark analysis
- Hi3531D加载TVP7002驱动模块——新手全过程记录
- 【记录】深度学习之蒸馏法训练网络
- 揭秘:“苏宁拼购基地”落地全国的原因
- 微信公众号的缩略图/封面图下载方法详细介绍
- maven打包报内存不足,配置maven vm options