[ Laravel 5.3 文档 ] 数据库 —— 查询构建器

1、简介

数据库查询构建器提供了一个方便的流接口用于创建和执行数据库查询。查询构建器可以用于执行应用中大部分数据库操作,并且能够在支持的所有数据库系统上工作。

Laravel 查询构建器使用 PDO 参数绑定来避免 SQL 注入攻击,不再需要过滤传递到绑定的字符串。

2、获取结果集

从一张表中取出所有行

我们可以从DB门面的table方法开始,table方法为给定表返回一个流式查询构建器实例,该实例允许你在查询上链接多个多约束条件并最终返回查询结果。在本例中,我们使用get方法获取表中所有记录:

<?php

namespace App\Http\Controllers;
 
use Illuminate\Support\Facades\DB;
use App\Http\Controllers\Controller;

class UserController extends Controller{
    /**
     * 显示用户列表
     *
     * @return Response
     */
    public function index()
    {
        $users = DB::table('users')->get();

        return view('user.index', ['users' => $users]);
    }
}

get方法返回包含结果集的Illuminate\Support\Collection,其中每一个结果都是PHP的StdClass对象实例。你可以像访问对象的属性一样访问字段的值:

foreach ($users as $user) {
    echo $user->name;
}

从一张表中获取一行/一列

如果你只是想要从数据表中获取一行数据,可以使用first方法,该方法将会返回单个StdClass对象:

$user = DB::table('users')->where('name', 'John')->first();
echo $user->name;

如果你不需要完整的一行,可以使用value方法从结果中获取单个值,该方法会直接返回指定列的值:

$email = DB::table('users')->where('name', 'John')->value('email');

获取数据列值列表

如果想要获取包含单个列值的数组,可以使用pluck方法,在本例中,我们获取角色标题数组:

$titles = DB::table('roles')->pluck('title');

foreach ($titles as $title) {
    echo $title;
}

在还可以在返回数组中为列值指定自定义键(该自定义键必须是该表的其它字段列名,否则会报错):

$roles = DB::table('roles')->pluck('title', 'name');
foreach ($roles as $name => $title) {
    echo $title;
}

组块结果集

如果你需要处理成千上百条数据库记录,可以考虑使用chunk方法,该方法一次获取结果集的一小块,然后传递每一小块数据到闭包函数进行处理,该方法在编写处理大量数据库记录的 Artisan 命令的时候非常有用。比如,我们可以将处理全部 users 表数据处理成一次处理 100 条记录的小组块:

DB::table('users')->orderBy('id')->chunk(100, function($users) {
    foreach ($users as $user) {
        //
    }
});

你可以通过从闭包函数中返回false来终止组块的运行:

DB::table('users')->orderBy('id')->chunk(100, function($users) {
    // 处理结果集...
    return false;
});

聚合函数

查询构建器还提供了多个聚合方法,如countmaxminavg和 sum,你可以在构造查询之后调用这些方法:

$users = DB::table('users')->count();
$price = DB::table('orders')->max('price');

当然,你可以联合其它查询子句和聚合函数来构建查询:

$price = DB::table('orders')
                ->where('finalized', 1)
                ->avg('price');

3、查询(Select)

指定查询子句

当然,我们并不总是想要获取数据表的所有列,使用select方法,你可以为查询指定自定义的select子句:

$users = DB::table('users')->select('name', 'email as user_email')->get();

distinct方法允许你强制查询返回不重复的结果集:

$users = DB::table('users')->distinct()->get();

如果你已经有了一个查询构建器实例并且希望添加一个查询列到已存在的select子句,可以使用addSelect方法:

$query = DB::table('users')->select('name');
$users = $query->addSelect('age')->get();

4、原生表达式

有时候你希望在查询中使用原生表达式,这些表达式将会以字符串的形式注入到查询中,所以要格外小心避免 SQL 注入。想要创建一个原生表达式,可以使用 DB::raw方法:

$users = DB::table('users')
                     ->select(DB::raw('count(*) as user_count, status'))
                     ->where('status', '<>', 1)
                     ->groupBy('status')
                     ->get();

5、连接(Join)

内连接(等值连接)

查询构建器还可以用于编写基本的SQL“内连接”,你可以使用查询构建器实例上的join方法,传递给join方法的第一个参数是你需要连接到的表名,剩余的其它参数则是为连接指定的列约束,当然,正如你所看到的,你可以在单个查询中连接多张表:

$users = DB::table('users')
            ->join('contacts', 'users.id', '=', 'contacts.user_id')
            ->join('orders', 'users.id', '=', 'orders.user_id')
            ->select('users.*', 'contacts.phone', 'orders.price')
            ->get();

左连接

如果你是想要执行“左连接”而不是“内连接”,可以使用leftJoin方法。该方法和join方法的用法一样:

$users = DB::table('users')
            ->leftJoin('posts', 'users.id', '=', 'posts.user_id')
            ->get();

交叉连接

要执行“交叉连接”可以使用crossJoin方法,传递你想要交叉连接的表名到该方法即可。交叉连接在第一张表和被连接表之间生成一个笛卡尔积:

$users = DB::table('sizes')
            ->crossJoin('colours')
            ->get();

高级连接语句

你还可以指定更多的高级连接子句,传递一个闭包到join方法作为该方法的第二个参数,该闭包将会返回允许你指定join子句约束的JoinClause对象:

DB::table('users')
        ->join('contacts', function ($join) {
            $join->on('users.id', '=', 'contacts.user_id')->orOn(...);
        })
        ->get();

如果你想要在连接中使用“where”风格的子句,可以在查询中使用whereorWhere方法。这些方法将会将列和值进行比较而不是列和列进行比较:

DB::table('users')
        ->join('contacts', function ($join) {
            $join->on('users.id', '=', 'contacts.user_id')
                 ->where('contacts.user_id', '>', 5);
        })
        ->get();

6、联合(Union)

查询构建器还提供了“联合”两个查询的快捷方式,比如,你可以先创建一个查询,然后使用union方法将其和第二个查询进行联合:

$first = DB::table('users')
            ->whereNull('first_name');

$users = DB::table('users')
            ->whereNull('last_name')
            ->union($first)
            ->get();

unionAll方法也是有效的,并且和union有同样的使用方式。

7、Where子句

简单where子句

使用查询构建器上的where方法可以添加where子句到查询中,调用where最基本的方法需要传递三个参数,第一个参数是列名,第二个参数是任意一个数据库系统支持的操作符,第三个参数是该列要比较的值。

例如,下面是一个验证“votes”列的值是否等于100的查询:

$users = DB::table('users')->where('votes', '=', 100)->get();

为了方便,如果你只是简单比较列值和给定数值是否相等,可以将数值直接作为where方法的第二个参数:

$users = DB::table('users')->where('votes', 100)->get();

当然,你还可以使用其它操作符来编写where子句:

$users = DB::table('users')
            ->where('votes', '>=', 100)
            ->get();

$users = DB::table('users')
            ->where('votes', '<>', 100)
            ->get();

$users = DB::table('users')
            ->where('name', 'like', 'T%')
            ->get();

还可以传递条件数组到where函数:

$users = DB::table('users')->where([
    ['status', '=', '1'],
    ['subscribed', '<>', '1'],
])->get();

or语句

你可以通过方法链将多个where约束链接到一起,也可以添加or子句到查询,orWhere方法和where方法接收参数一样:

$users = DB::table('users')
                    ->where('votes', '>', 100)
                    ->orWhere('name', 'John')
                    ->get();

更多Where子句

whereBetween

whereBetween方法验证列值是否在给定值之间:

$users = DB::table('users')
                    ->whereBetween('votes', [1, 100])->get();

whereNotBetween

whereNotBetween方法验证列值不在给定值之间:

$users = DB::table('users')
                    ->whereNotBetween('votes', [1, 100])
                    ->get();

whereIn/whereNotIn

whereIn方法验证给定列的值是否在给定数组中:

$users = DB::table('users')
                    ->whereIn('id', [1, 2, 3])
                    ->get();

whereNotIn方法验证给定列的值不在给定数组中:

$users = DB::table('users')
                    ->whereNotIn('id', [1, 2, 3])
                    ->get();

whereNull/whereNotNull

whereNull方法验证给定列的值为NULL:

$users = DB::table('users')
                    ->whereNull('updated_at')
                    ->get();

whereNotNull方法验证给定列的值不是NULL:

$users = DB::table('users')
                    ->whereNotNull('updated_at')
                    ->get();

whereDate / whereMonth / whereDay / whereYear

whereDate方法用于比较字段值和日期:

$users = DB::table('users')
            ->whereDate('created_at', '2016-10-10')
            ->get();

whereMonth方法用于比较字段值和一年中的指定月份:

$users = DB::table('users')
            ->whereMonth('created_at', '10')
            ->get();

whereDay方法用于比较字段值和一月中的制定天:

$users = DB::table('users')
            ->whereDay('created_at', '10')
            ->get();

whereYear方法用于比较字段值和指定年:

$users = DB::table('users')
            ->whereYear('created_at', '2016')
            ->get();

whereColumn

whereColumn方法用于验证两个字段是否相等:

$users = DB::table('users')
                ->whereColumn('first_name', 'last_name')
                ->get();

还可以传递一个比较运算符到该方法:

$users = DB::table('users')
            ->whereColumn('updated_at', '>', 'created_at')
            ->get();

还可以传递多条件数组到whereColumn方法,这些条件通过and操作符进行连接:

$users = DB::table('users')
            ->whereColumn([
                ['first_name', '=', 'last_name'],
                ['updated_at', '>', 'created_at']
            ])->get();

参数分组

有时候你需要创建更加高级的where子句,比如“where exists”或者嵌套的参数分组。Laravel查询构建器也可以处理这些。作为开始,让我们看一个在括号中进行分组约束的例子:

DB::table('users')
        ->where('name', '=', 'John')
        ->orWhere(function ($query) {
            $query->where('votes', '>', 100)
                  ->where('title', '<>', 'Admin');
        })
        ->get();

正如你所看到的,传递闭包到orWhere方法构造查询构建器来开始一个约束分组,该闭包将会获取一个用于设置括号中包含的约束的查询构建器实例。上述语句等价于下面的SQL:

select * from users where name = 'John' or (votes > 100 and title <> 'Admin')

where exists子句

whereExists方法允许你编写where existSQL子句,whereExists方法接收一个闭包参数,该闭包获取一个查询构建器实例从而允许你定义放置在“exists”子句中的查询:

DB::table('users')
            ->whereExists(function ($query) {
                $query->select(DB::raw(1))
                      ->from('orders')
                      ->whereRaw('orders.user_id = users.id');
            })
            ->get();

上述查询等价于下面的SQL语句:

select * from users
where exists (
    select 1 from orders where orders.user_id = users.id
)

JSON Where子句

Laravel还支持在提供JSON字段类型的数据库(目前是MySQL 5.7和Postgres)上使用操作符->查询JSON字段类型:

$users = DB::table('users')
                ->where('options->language', 'en')
                ->get();
$users = DB::table('users')
                ->where('preferences->dining->meal', 'salad')
                ->get();

8、排序、分组、限定

orderBy

orderBy方法允许你通过给定字段对结果集进行排序,orderBy的第一个参数应该是你希望排序的字段,第二个参数控制着排序的方向——asc或desc:

$users = DB::table('users')
                ->orderBy('name', 'desc')
                ->get();

inRandomOrder

inRandomOrder方法可用于对查询结果集进行随机排序,比如,你可以用该方法获取一个随机用户:

$randomUser = DB::table('users')
                ->inRandomOrder()
                ->first();

groupBy / having / havingRaw

groupByhaving方法用于对结果集进行分组,having方法和where方法的用法类似:

$users = DB::table('users')
                ->groupBy('account_id')
                ->having('account_id', '>', 100)
                ->get();

havingRaw方法可用于设置原生字符串作为having子句的值,例如,我们可以这样找到所有售价大于$2500的部分:

$users = DB::table('orders')
                ->select('department', DB::raw('SUM(price) as total_sales'))
                ->groupBy('department')
                ->havingRaw('SUM(price) > 2500')
                ->get();

skip / take

想要限定查询返回的结果集的数目,或者在查询中跳过给定数目的结果,可以使用skiptake方法:

$users = DB::table('users')->skip(10)->take(5)->get();

作为替代方法,还可以使用limitoffset方法:

$users = DB::table('users')
                ->offset(10)
                ->limit(5)
                ->get();

9、条件子句

有时候你可能想要某些条件为true的时候才讲条件子句应用到查询。例如,你可能只想给定值在请求中存在的情况下才应用where语句,这可以通过when方法实现:

$role = $request->input('role');

$users = DB::table('users')
                ->when($role, function ($query) use ($role) {
                    return $query->where('role_id', $role);
                })
                ->get();

when方法只有在第一个参数为true的时候才执行给定闭包,如果第一个参数为false,则闭包不执行。

你可以传递另一个闭包作为when方法的第三个参数,该闭包会在第一个参数为false的情况下执行。为了演示这个特性如何使用,我们来配置一个查询的默认排序:

$sortBy = null;

$users = DB::table('users')
                ->when($sortBy, function ($query) use ($sortBy) {
                        return $query->orderBy($sortBy);
                    }, function ($query) {
                        return $query->orderBy('name');
                    })
                ->get();

10、插入(Insert)

查询构建器还提供了insert方法用于插入记录到数据表。insert方法接收数组形式的字段名和字段值进行插入操作:

DB::table('users')->insert(
    ['email' => 'john@example.com', 'votes' => 0]
);

你甚至可以一次性通过传入多个数组来插入多条记录,每个数组代表要插入数据表的记录:

DB::table('users')->insert([
    ['email' => 'taylor@example.com', 'votes' => 0],
    ['email' => 'dayle@example.com', 'votes' => 0]
]);

自增ID

如果数据表有自增ID,使用insertGetId方法来插入记录并返回ID值:

$id = DB::table('users')->insertGetId(
    ['email' => 'john@example.com', 'votes' => 0]
);

注:当使用PostgresSQLinsertGetId方法默认自增列被命名为id,如果你想要从其他“序列”获取ID,可以将序列名作为第二个参数传递到insertGetId方法。

11、更新(Update)

当然,除了插入记录到数据库,查询构建器还可以通过使用update方法更新已有记录。update方法和insert方法一样,接收字段名和字段值的键值对数组包含要更新的列,你可以通过where子句来对update查询进行约束:

DB::table('users')
            ->where('id', 1)
            ->update(['votes' => 1]);

更新JSON字段

更新JSON字段的时候,需要使用->语法访问JSON对象上相应的值,该操作只能用于支持JSON字段类型的数据库:

DB::table('users')
            ->where('id', 1)
            ->update(['options->enabled' => true]);

增加/减少

查询构建器还为增减给定字段名对应数值提供方便。相较于编写update语句,这是一条捷径,提供了更好的体验和测试接口。

这两个方法都至少接收一个参数:需要修改的列。第二个参数是可选的,用于控制列值增加/减少的数目。

DB::table('users')->increment('votes');
DB::table('users')->increment('votes', 5);
DB::table('users')->decrement('votes');
DB::table('users')->decrement('votes', 5);

在操作过程中你还可以指定额外的列进行更新:

DB::table('users')->increment('votes', 1, ['name' => 'John']);

12、删除(Delete)

当然,查询构建器还可以通过delete方法从表中删除记录:

DB::table('users')->delete();
DB::table('users')->where('votes', '>', 100)->delete();

如果你希望清除整张表,也就是删除所有列并将自增ID置为0,可以使用truncate方法:

DB::table('users')->truncate();

13、悲观锁

查询构建器还提供了一些方法帮助你在select语句中实现“悲观锁”。可以在查询中使用sharedLock方法从而在运行语句时带一把”共享锁“。共享锁可以避免被选择的行被修改直到事务提交:

DB::table('users')->where('votes', '>', 100)->sharedLock()->get();

此外你还可以使用lockForUpdate方法。“for update”锁避免选择行被其它共享锁修改或删除:

DB::table('users')->where('votes', '>', 100)->lockForUpdate()->get();

学院君

学院君 has written 554 articles

资深PHP工程师,Laravel学院院长