Say No to Loop!

Paste_Image.png

本文会介绍下Eloquent\Collection,这个是什么呢?这是我们平常使用Eloquent中get,all返回的结果集。

collection缘来

我们首先来看一段简单的代码:

$books = Book::all();
$titles = [];
foreach ($books as $book){
  if ($book->pages_count > 8){
    $titles[] =  $book->title;
  }
}

这段代码意图其实非常明确,就是获取超过8的书名,再看下面一段代码:

$titles = [];
foreach ($books as $book){
  if ($book->publisher_id == 2){
    $titles[] =  $book->title;
  }
}

此处是获取作者是2的书名,所有这些代码都有同样的loop逻辑,我们完全可以抽取出来,于是就有了下面的函数:

function map($input, $func)
{
    $result = [];
    foreach ($input as $each)
    {
        $result[] = $func($each);
    }
    return $result;
}
map($books, function($book){
  if ($book->publisher_id == 2){
    return $book->title;
  }
});

这只是展示了一个简单的map模式,还有其他更多方便的集合操作方法,我们将其抽取出来,于是就出现了Collection,网上有个讲Collection的课程,不过太贵了,买不起。

其实Collection的总体思想感觉就是函数式编程,Tell, Don’t Ask,客户端在使用上不再是想着怎么做how,而是想着what to do,一直有个神一样存在的系列文章没去读,今天看到collection的文章,有了冲动去看的,文章地址:Category Theory for Programmers: The Preface,等最近看完orm系列就去看这个的。我们还是接着讲collection。

collection使用

在使用collection的原则上,我们遵守当代码出现loop的时候,我们就停下来想下,是否可以通过collection来解决。

first

三种使用方式

    public function testFirstReturnsFirstItemInCollection()
    {
        $c = new Collection(['foo', 'bar']);
        $this->assertEquals('foo', $c->first());
    }

    public function testFirstWithCallback()
    {
        $data = new Collection(['foo', 'bar', 'baz']);
        $result = $data->first(function ($value) {
            return $value === 'bar';
        });
        $this->assertEquals('bar', $result);
    }

    public function testFirstWithCallbackAndDefault()
    {
        $data = new Collection(['foo', 'bar']);
        $result = $data->first(function ($value) {
            return $value === 'baz';
        }, 'default');
        $this->assertEquals('default', $result);
    }

last

和first使用方式相同

    public function testLastReturnsLastItemInCollection()
    {
        $c = new Collection(['foo', 'bar']);
        $this->assertEquals('bar', $c->last());
    }

    public function testLastWithCallback()
    {
        $data = new Collection([100, 200, 300]);
        $result = $data->last(function ($value) {
            return $value < 250;
        });
        $this->assertEquals(200, $result);
        $result = $data->last(function ($value, $key) {
            return $key < 2;
        });
        $this->assertEquals(200, $result);
    }

    public function testLastWithCallbackAndDefault()
    {
        $data = new Collection(['foo', 'bar']);
        $result = $data->last(function ($value) {
            return $value === 'baz';
        }, 'default');
        $this->assertEquals('default', $result);
    }

map

map是对loop的抽离,对于集合中每个元素做完操作后,再返回新的元素。

    public function testMap()
    {
        $data = new Collection(['first' => 'taylor', 'last' => 'otwell']);
        $data = $data->map(function ($item, $key) {
            return $key.'-'.strrev($item);
        });
        $this->assertEquals(['first' => 'first-rolyat', 'last' => 'last-llewto'], $data->all());
    }

each

遍历元组进行操作,不返回元素操作后的结果,当遇到返回false的时候,结束遍历。

    public function testEach()
    {
        $c = new Collection($original = [1, 2, 'foo' => 'bar', 'bam' => 'baz']);

        $result = [];
        $c->each(function ($item, $key) use (&$result) {
            $result[$key] = $item;
        });
        $this->assertEquals($original, $result);

        $result = [];
        $c->each(function ($item, $key) use (&$result) {
            $result[$key] = $item;
            if (is_string($key)) {
                return false;
            }
        });
        $this->assertEquals([1, 2, 'foo' => 'bar'], $result);
    }

filter

遍历集合,只将符合条件的留下,集合中元素的性质不会变,如果集合中是product,返回的也是product,不会像map那样,返回price

    public function testFilter()
    {
        $c = new Collection([['id' => 1, 'name' => 'Hello'], ['id' => 2, 'name' => 'World']]);
        $this->assertEquals([1 => ['id' => 2, 'name' => 'World']], $c->filter(function ($item) {
            return $item['id'] == 2;
        })->all());

        $c = new Collection(['', 'Hello', '', 'World']);
        $this->assertEquals(['Hello', 'World'], $c->filter()->values()->toArray());

        $c = new Collection(['id' => 1, 'first' => 'Hello', 'second' => 'World']);
        $this->assertEquals(['first' => 'Hello', 'second' => 'World'], $c->filter(function ($item, $key) {
            return $key != 'id';
        })->all());
    }

reduce

reduce将一个集合中的元素做遍历,返回为一个单子的元素

public function testReduce()
{
    $data = new Collection([1, 2, 3]);
    $this->assertEquals(6, $data->reduce(function ($carry, $element) {
        return $carry += $element;
    }));
}

flatten

flatten意为平坦,可以将任意嵌套的array变为同层级的,通过参数depth,可以指定平坦的层级

public function testFlatten()
{
    // Flat arrays are unaffected
    $c = new Collection(['#foo', '#bar', '#baz']);
    $this->assertEquals(['#foo', '#bar', '#baz'], $c->flatten()->all());

    // Nested arrays are flattened with existing flat items
    $c = new Collection([['#foo', '#bar'], '#baz']);
    $this->assertEquals(['#foo', '#bar', '#baz'], $c->flatten()->all());

    // Sets of nested arrays are flattened
    $c = new Collection([['#foo', '#bar'], ['#baz']]);
    $this->assertEquals(['#foo', '#bar', '#baz'], $c->flatten()->all());

    // Deeply nested arrays are flattened
    $c = new Collection([['#foo', ['#bar']], ['#baz']]);
    $this->assertEquals(['#foo', '#bar', '#baz'], $c->flatten()->all());
}
public function testFlattenWithDepth()
{
  // No depth flattens recursively
  $c = new Collection([['#foo', ['#bar', ['#baz']]], '#zap']);
  $this->assertEquals(['#foo', '#bar', '#baz', '#zap'], $c->flatten()->all());

  // Specifying a depth only flattens to that depth
  $c = new Collection([['#foo', ['#bar', ['#baz']]], '#zap']);
  $this->assertEquals(['#foo', ['#bar', ['#baz']], '#zap'], $c->flatten(1)->all());

  $c = new Collection([['#foo', ['#bar', ['#baz']]], '#zap']);
  $this->assertEquals(['#foo', '#bar', ['#baz'], '#zap'], $c->flatten(2)->all());
}

FlatMap

flatMap类似于做了先map后flat的操作

public function testFlatMap()
{
    $data = new Collection([
        ['name' => 'taylor', 'hobbies' => ['programming', 'basketball']],
        ['name' => 'adam', 'hobbies' => ['music', 'powerlifting']],
    ]);
    $data = $data->flatMap(function ($person) {
        return $person['hobbies'];
    });
    $this->assertEquals(['programming', 'basketball', 'music', 'powerlifting'], $data->all());
}

zip

吧两个结构一样的array像拉拉链一样做合并

public function testZip()
{
    $c = new Collection([1, 2, 3]);
    $c = $c->zip(new Collection([4, 5, 6]));
    $this->assertInstanceOf(Collection::class, $c);
    $this->assertInstanceOf(Collection::class, $c[0]);
    $this->assertInstanceOf(Collection::class, $c[1]);
    $this->assertInstanceOf(Collection::class, $c[2]);
    $this->assertCount(3, $c);
    $this->assertEquals([1, 4], $c[0]->all());
    $this->assertEquals([2, 5], $c[1]->all());
    $this->assertEquals([3, 6], $c[2]->all());

    $c = new Collection([1, 2, 3]);
    $c = $c->zip([4, 5, 6], [7, 8, 9]);
    $this->assertCount(3, $c);
    $this->assertEquals([1, 4, 7], $c[0]->all());
    $this->assertEquals([2, 5, 8], $c[1]->all());
    $this->assertEquals([3, 6, 9], $c[2]->all());

    $c = new Collection([1, 2, 3]);
    $c = $c->zip([4, 5, 6], [7]);
    $this->assertCount(3, $c);
    $this->assertEquals([1, 4, 7], $c[0]->all());
    $this->assertEquals([2, 5, null], $c[1]->all());
    $this->assertEquals([3, 6, null], $c[2]->all());
}

pluck

pluck接受两个参数,如果传递了第二个参数,则以第二个参数为key

public function testPluckWithArrayAndObjectValues()
{
    $data = new Collection([(object) ['name' => 'taylor', 'email' => 'foo'], ['name' => 'dayle', 'email' => 'bar']]);
    $this->assertEquals(['taylor' => 'foo', 'dayle' => 'bar'], $data->pluck('email', 'name')->all());
    $this->assertEquals(['foo', 'bar'], $data->pluck('email')->all());
}

更详细的可以参考https://laravel.tw/docs/5.2/collections

一些建议

我们使用collection的取值的时候,如果没有对应的值,我们可以提供default值,此时可以在default中直接抛出异常

return $this->checkers->first(function ($i, $checker) use ( $file) {
    return $checker->canCheck($file);
}, function () {
    throw new Exception("No matching style checker found!");
});

我们有时候为了连贯操作,即使前一个出错了,我们也不希望返回一个null object,我们希望能返回一个空对象,但是这个对象实现了一个空操作,意图如下:

$this->getObject($input)->check();

此处getObject($input)可能返回是一个实现了check操作的空对象,这时候就可以使用Macroable trait 的东西。

public function testMacroable()
{
    // Foo() macro : unique values starting with A
    Collection::macro('foo', function () {
        return $this->filter(function ($item) {
            return strpos($item, 'a') === 0;
        })
            ->unique()
            ->values();
    });

    $c = new Collection(['a', 'a', 'aa', 'aaa', 'bar']);

    $this->assertSame(['a', 'aa', 'aaa'], $c->foo()->all());
}

更多内容大家可以去看文章Refactoring to Collection — Notes

参考

Refactoring to Collection — Notes

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

我来说两句

0 条评论
登录 后参与评论

相关文章

  • 通过Eloquent实现Repository模式

    Eloquent采用了ActiveRecord的模式,这也让Eloquent招致了好多批评,让我们去看现在Eloquent/Model.php文件, 该文件已经...

    zhuanxu
  • The Clean Architecture in PHP 读书笔记(五)The Clean Architecture in PHP 读书笔记(五)

    上篇最重要的是介绍了去耦的工具之一依赖注入,本篇将继续介绍去耦工具:接口和适配器,本文是The Clean Architecture in PHP的第5篇。

    zhuanxu
  • The Clean Architecture in PHP 读书笔记(八)

    上篇简要介绍了Clean Architecture和union architecture,并给出clean architecture的一些共同点:框架无关,可测...

    zhuanxu
  • PHP设计模式之抽象工厂模式

    工厂模式系列中的重头戏来了,没错,那正是传闻中的抽象工厂模式。初次听到这个名字的时候你有什么感觉?反正我是感觉这货应该是非常高大上的,毕竟包含着“抽象”两个字。...

    硬核项目经理
  • php关于闭包(匿名函数)的理解

    匿名函数(Anonymous functions),也叫闭包函数(closures),允许 临时创建一个没有指定名称的函数。最经常用作回调函数(callback...

    梦_之_旅
  • 这些利用大数据做工业设备监测的公司,你都应该关注一下

    【数据猿导读】 本次,小猿君向大家介绍几家工业领域利用大数据做设备监测的公司,通过这冰山一角窥探“大数据”如何在工业领域实现价值落地和大数据如何改变“第四次工业...

    数据猿
  • 数据安全在交付中的思考 |洞见

    2017年7月,Equifax用户数据泄露事件使得1亿4千300万个人信息(包括社会保障号码、出生日期、地址、驾照编号)和20万9千个用户的信用卡数据被盗。该事...

    ThoughtWorks
  • iOS坐标系探究

    APP 在渲染视图时,需要在坐标系中指定绘制区域。这个概念看似乎简单,事实并非如此。

    落影
  • 【每日算法Day 69】面试经典题:分发糖果问题

    老师想给孩子们分发糖果,有 个孩子站成了一条直线,老师会根据每个孩子的表现,预先给他们评分。

    godweiyang
  • 再读Golang中的异常处理 顶

    注意:如果一个没有recover的goroutine发生了panic,那么整个进程都会挂掉

    BGBiao

扫码关注云+社区

领取腾讯云代金券