使用宏（Macro）来扩展 Laravel 的数据库请求构建器

file

习惯了编写 SQL 语句的开发人员可能对 Laravel 的 ORM / Query Builder 并不是很了解。当我们在需要用到查询构造器没有实现的方法时，通常会使用 select(DB::raw(...)) 来组装 SQL 表达式。

现在我们可以使用 Laravel 的 "Macros" 以更加灵活的方式来编写这些语句。我将要执行的操作命名为 "insertOrUpdateMany" ，它将使用单个方法来构建和执行自定义 SQL 语句。

定义宏：

为了保证代码的清晰可读性，我将绑定到宏的查询生成器实例和回调的参数 "$rows" 传递到一个新的宏实例。

use Illuminate\Database\Query\Builder;
use App\Macros\InsertOrUpdateMany;

Builder::macro('insertOrUpdateMany', function(array $rows){
    return with(new InsertOrUpdateMany($this, $rows))->execute();
});

我们可以将这些定义放在 Laravel 的服务提供者里。

使用 Macro

我们的 Macro 功能类似于 Laravel 自带的 insert() 函数，返回结果是数据库影响的行数：

$affectedRowCount = DB::table('users')->insertOrUpdateMany(array(
    array(
        'id' => 1,
        'name' => 'Test 1',
        'email' => 'test1@test.local',
        'password' => 'XXX'
    ),
    array('id' => 2,
        'name' => 'Test 2',
        'email' => 'test2@test.local',
        'password' => 'XXX'
    ),
    array(
        'id' => 3,
        'name' => 'Test 3',
        'email' => 'test3@test.local',
        'password' => 'XXX'
    ),
));

dd($affectedRowCount);

数据库查询类

数据库查询类 InsertOrUpdateMany 里将处理各种的 SQL 拼接和查询处理。类的构建函数里我们将获取到 Builder 和 PDO 连接，剩下的一切就变得很容易了，PDO 的 affectingStatement 直接就可返回数据库影响的行数。很容易吧，下面是完整的类代码：

InsertOrUpdateMany.php

<?php namespace BayAreaWebPro\SimpleCsv\Macros;
use Illuminate\Database\Query\Builder;
class InsertOrUpdateMany
{
    /**
     * @param \Illuminate\Database\Query\Builder $builder
     * @var \PDO $pdo
     * @var array $entries
     * @var array $columnsArray
     * @var string $columnsString
     * @var string $valuesString
     * @var string $updateString
     * @var string $sql
     */
    protected $builder, $pdo, $entries;
    private $columnsArray, $columnsString, $valuesString, $updateString, $sql;
    /**
     * InsertOrUpdateMany constructor.
     * @param \Illuminate\Database\Query\Builder $builder
     * @param array $entries
     * @return void
     */
    public function __construct(Builder $builder, array $entries)
    {
        $this->builder = $builder;
        $this->entries = $entries;
        $this->pdo = $this->builder->getConnection()->getPdo();
        $this->prepareValues();
        $this->assembleStatement();
    }
    /**
     * Prepare the values.
     * @return void
     */
    private function prepareValues()
    {
        //获取 Columns Array
        $this->columnsArray = $this->getColumnsArray();
        //构建 Columns 字串
        $this->columnsString = $this->collapse($this->columnsArray);
        //构建数据
        $this->valuesString = $this->collapse(array_map(function ($row) {
            return $this->encase($this->collapse($this->escape($row)));
        }, $this->entries));
        //构建更新的字串
        $this->updateString = $this->collapse(array_map(function ($value) {
            return "$value = VALUES($value)";
        }, $this->columnsArray));
    }
    /**
     * 组合 SQL 语句
     * @return void
     */
    private function assembleStatement()
    {
        $this->sql = "INSERT INTO {$this->builder->from} ({$this->columnsString}) VALUES {$this->valuesString} ON DUPLICATE KEY UPDATE {$this->updateString}";
    }
    /**
     * 获取表结构数组
     * @return array
     */
    private function getColumnsArray()
    {
        return array_keys(reset($this->entries));
    }
    /**
     * 处理数组
     * @param array $values
     * @return array
     */
    private function escape(array $values)
    {
        return array_map(function ($value) {
            return $value ? $this->pdo->quote($value) : 'NULL';
        }, $values);
    }
    /**
     * 合并数组
     * @param array $values
     * @return string
     */
    private function collapse(array $values)
    {
        return implode(',', $values);
    }
    /**
     * 封装字串
     * @param string $value
     * @return string
     */
    private function encase(string $value)
    {
        return '(' . $value . ')';
    }
    /**
     * 执行语句
     * @return int
     */
    public function execute()
    {
        return $this->builder->getConnection()->affectingStatement($this->sql);
    }
}