分享每一天-如何利用 macro 方法来扩展 Laravel 的基础类的功能

如何利用 macro 方法来扩展 Laravel 的基础类的功能

Laravel 1880 0 创建时间：2020-09-30 11:41:30

macro扩展

#### 基本使用方法
我下面用 Collection 类来做示范。

要给 Collection 加一个扩充方法可以这样写：

```php
  <?php

Collection::macro("macro_name", function ($parameters) {
      // Your macro
  });
```

这样就很容易的就扩充了 Collection 的方法，而不需要进行复杂的继承。

我们再举个具体的例子，把所有 Collection 的字符数组全部变成大写。那么我们就这样写：

```php
<?php

Collection::macro('uppercase', function () {
    return collect($this->items)->map(function ($item) {
        return strtoupper($item);
    });
});

collect(["hello", "world"])->uppercase();
```

#### 关于 macro 内部的 $this

Collection $this 在 macro 的作用域必须注意，$this 不是指向你文件类的对象，而是指向你 marco 扩充的类。比如例子中的 $this 是指向 Collection 的。

这是因为在 Marcoable 的源代码中，是可以看到 static::$macros[$method]->bindTo($this, static::class) 这段代码。而 bindTo 是改变 $this 上下文指向的方法。

#### marco 的代码应该放在哪里？

marco 的代码应该放在哪里才能让整个项目都能使用， 这个问题其实困扰了我很久， 所以一直没有写这个教程。不过现在研究明白了。

要让 marco 扩充的类，保证整个项目都能使用， 需要创建一个 ServiceProvider，并把扩充的方法，放入 boot() 的方法中:

```php
  <?php
  namespace App\Providers;

use Collection;
  use Illuminate\Support\ServiceProvider;

class CollectionMacroServiceProvider extends ServiceProvider {

public function boot()
      {
         Collection::macro('uppercase', function () {
            return collect($this->items)->map(function ($item) {
                return strtoupper($item);
            });
        });
      }

}
```
然后我们就可以在 config/app.php 中的 providers 中下面加 App\ProvidersCollectionMacroServiceProvider::class 即可.

#### 哪些类可以使用 marco
- Response
- Request
- Collection
- HTML
- Form
- Filesystem
- Cache
- Str
- Arr
- Translator
等等，使用了 Marcoable 的 Traits，如果是自己编写的类，使用了 Marcoable，也可以这样扩充使用（写 Laravel 开源库的时候）

如何利用 macro 方法来扩展 Laravel 的基础类的功能

商品推荐

广告推荐

推荐文章