Laravel Collections

myjob 的个人博客 / 328 / 0 / 创建于 4年前 / 更新于 4年前

循环语句

在对数组 items 进行操作时，我们避免不了使用循环语句去处理我们的逻辑。

如，我们想拿到所有用户的邮箱地址，也许我们这么写：

function getUserEmails($users) {    
    // 1. 创建空数组用于保存结果
    $emails = [];    
    // 2. 初始化变量 $i，用于遍历所有用户
    for ($i = 0; $i < count($users); $i++) {        
        $emails[] = $$users[$i]->email;
    }    
    return $emails;
}

又如，我们要对数组每个元素 *3 计算：

function cheng3($data) {    
    for ($i = 0; $i < count($data); $i++) {        
        $data[$i] *= 3;
    }
}

又如，我们要把贵的商品挑出来：

function expensive($products) {    
    $expensiveProducts = [];    
    foreach ($products as $product) { 
        if ($product->price > 100) { 
            $expensiveProducts[] = $product; 
        } 
    }    return $expensiveProducts;
}

对数组的操作，这类例子太多了，终究都是通过循环来对数组的每个元素进行操作。

而我们重构的思路就是：把循环的地方封装起来，这样最大的避免我们在写业务逻辑时，自己去写循环语句

第一个例子，主要的业务逻辑在于这条语句，获取每个用户的邮箱：$emails[] = $$users[$i]->email;将其他代码封装成如下 map 函数：

function map($items, $func) { 
    $results = [];    
    foreach ($items as $item) { 
        $results[] = $func($item); 
    }    return $results;
}

这样使用该 map 函数进行重构就简单：

function getUserEmails($users) {    
    return $this->map($users, function ($user) {        
        return $user->email;
    });
}

相比较刚开始的写法，明显简单多了，而且也避免了不必要的变量。一样的，对第二个例子进行重构，将循环语句封装成 each 函数：

function each($items, $func) {    
    foreach ($items as $item) {        
        $func($item);
    } 
}

这个 each 和 map 函数最大的区别在于，each 函数是对每个元素的处理逻辑，且没有返回新的数组。

使用 each 函数就比较简单：

function cube($data) {    
    $this->each($data, function ($item) {       
        return $item * 3;
    });
}

同样的对第三个例子进行重构，重构的对象在于价格的筛选判断上

if ($product->price > 100) { 
    $expensiveProducts[] = $product; 
}

我们参考 map 函数进行重构：

function filter($items, $func) { 
    $result = [];    
    foreach ($items as $item) { 
        if ($func($item)) { 
            $result[] = $item; 
        } 
    }    return $result;
}

当满足于 $func($item)条件的 item 都放入 $result 数组中。

使用就很简单：

return $this->filter($products, function ($product) {    
    return $product->price > 100;
});

这里的 filter 函数和 map 函数的区别在于，map 函数是获取原有数组对应的属性集或者计算产生的新数组；而 filter 更多的是通过筛选符合条件的 item，构成的数组。

构造 Collection 类

我们把这些 map、each、filter 方法整合在一起构成一个 Collection 类

class Collection {    
    protected $items;    
    public function __construct($items) {        
        $this->items = $items;
    }    
    function map($items, $func) {        
        $results = [];        
        foreach ($items as $item) {            
            $results[] = $func($item);
        }        
        return $results;
    }    
    function each($items, $func) {        
        foreach ($items as $item) {            
            $func($item);
        }
    }    

    function filter($items, $func) {        
        $result = [];        
        foreach ($items as $item) {            
            if ($func($item)) {                
                $result[] = $item;
            }
        }        
        return $result;
    }    

    public function toArray() {        
        return $this->items;
    }

}

当然到目前为止，自己封装的 Collection 雏形就已经有了，但还是达不到可以通用的水平。所以我们需要看看别人是怎么写的—— Laravel 使用的