神奇的 Laravel 宏指令Macro

2020-12-02 20:40 PHP架构之路

可曾有过想要的一项功能在 Laravel 中,但它又不是真实存在的?让我来给你介绍一下 Laravel 宏指令。宏指令允许你添加自定义功能到 Laravel 的内部组件里去。

让我们以一个简单的 Request 门面方法为例。

Request::macro('introduce', function ($name) {    echo 'Hello ' . $name . '!';});

Request::introduce('Caleb'); // outputs "Hello Caleb!"

一个更加实用的 Request 宏指令是用于检测当前的 TLD(顶级域:.com,.net,.org,.etc…)。

Request::macro('tldIs', function ($tld) {    return Str::is('*.' . $tld, $this->root());});

Request::tldIs('com') // returns true for app.comRequest::tldIs('dev') // returns false for app.com

你会注意到 Laravel 自动绑定 $this 到 Request 的上线文中,而不是在一个已经定义宏的类里。比如:

class AppServiceProvider{    public function boot(){        Request::macro('context', function () {            return get_class($this);        }    }...

Request::context(); // returns 'Illuminate\Http\Request'// instead of 'App\AppServiceProvider'

让我们看一个更高级的示例。此宏有条件地基于当前 TLD 在模型上添加一个 where 语句。

Builder::macro('whenTldMatches', function($tld, $callback) {    if (Request::tldIs($tld)) {        call_user_func($callback->bindTo($this));    }    return $this;});

SomeModel::whenTldMatches('org', function () { $this->where('id', '>', 5);})->get();

// applies ->where() 在 app.org 上应用,而不在 app.com 上应用

我们应该在哪里定义它们?

服务提供者为为您的应用程序定义宏的好地方。App\Providers\AppServiceProvider boot() 是 I 一个很好的注入点,但是它很快就变得臃肿。

下一步是创建一个 App\Providers\MacrosServiceProvider 并注册在 config/app.php 里。如果某宏与之相关,我可能会创建一个 App\Providers\TldAwareServiceProvider 来容纳所有与 TLD 相关的宏。

哪些组件是 Macroable?

宏可以再任何具有 Macroable 特性的类上定义。下面是一个 Macroable 的门面和类的列表

门面

CacheFileLangRequestResponseRouteURLIlluminate Classes

Illuminate\Cache\RepositoryIlluminate\Console\Scheduling\EventIlluminate\Database\Eloquent\BuilderIlluminate\Database\Eloquent\RelationIlluminate\Database\Query\BuilderIlluminate\Filesystem\FilesystemIlluminate\Foundation\Testing\TestResponseIlluminate\Http\RedirectResponseIlluminate\Http\RequestIlluminate\Http\UploadedFileIlluminate\Routing\ResponseFactoryIlluminate\Routing\RouterIlluminate\Routing\UrlGeneratorIlluminate\Support\ArrIlluminate\Support\CollectionIlluminate\Support\StrIlluminate\Translation\TranslatorIlluminate\Validation\Rule

动手

如果您发现自己在整个系统中对 Laravel 组件重复执行逻辑,请考虑使用宏以实现更好的表达和重用。



原文作者:Summer

本文章转载自公众号:gh_cf127618c49e

首页 - PHP 相关的更多文章: