数据库:入门指南
简介
几乎每个现代 Web 应用程序都会与数据库交互。Laravel 使这种交互变得非常简单,它支持多种数据库,并提供了原生 SQL、流畅的查询构造器和 Eloquent ORM 三种方式来与数据库进行交互。目前,Laravel 为以下五个数据库提供了一方支持:
此外,通过 mongodb/laravel-mongodb 包(由 MongoDB 官方维护)也可以支持 MongoDB。更多信息请查看 Laravel MongoDB 文档。
配置
Laravel 数据库服务的配置文件位于应用程序的 config/database.php 文件中。在此文件中,你可以定义所有的数据库连接,并指定默认使用哪个连接。此文件中的大多数配置选项都由应用程序的环境变量值驱动。该文件中提供了 Laravel 支持的大多数数据库系统的示例。
默认情况下,Laravel 的示例环境配置已准备好与 Laravel Sail 一起使用,Sail 是在本地机器上开发 Laravel 应用程序的 Docker 配置。但是,你可以根据本地数据库的需要自由修改数据库配置。
SQLite 配置
SQLite 数据库包含在文件系统上的一个文件中。你可以使用终端中的 touch 命令创建一个新的 SQLite 数据库:touch database/database.sqlite。创建数据库后,你可以通过将数据库的绝对路径放在 DB_DATABASE 环境变量中,轻松配置环境变量以指向此数据库:
DB_CONNECTION=sqlite
DB_DATABASE=/绝对/路径/to/database.sqlite默认情况下,SQLite 连接启用了外键约束。如果你想禁用它们,应将 DB_FOREIGN_KEYS 环境变量设置为 false:
DB_FOREIGN_KEYS=falseNOTE
如果你使用 Laravel 安装程序创建 Laravel 应用程序并选择 SQLite 作为数据库,Laravel 将自动为你创建一个 database/database.sqlite 文件并运行默认的数据库迁移。
Microsoft SQL Server 配置
要使用 Microsoft SQL Server 数据库,你应确保已安装 sqlsrv 和 pdo_sqlsrv PHP 扩展以及它们可能需要的任何依赖项,例如 Microsoft SQL ODBC 驱动程序。
使用 URL 进行配置
通常,数据库连接使用多个配置值进行配置,例如 host、database、username、password 等。这些配置值中的每一个都有自己对应的环境变量。这意味着在生产服务器上配置数据库连接信息时,你需要管理多个环境变量。
一些托管数据库提供商(如 AWS 和 Heroku)提供了一个单一的数据库“URL”,其中包含数据库的所有连接信息,作为一个字符串。一个示例数据库 URL 可能如下所示:
mysql://root:password@127.0.0.1/forge?charset=UTF-8这些 URL 通常遵循标准模式约定:
driver://username:password@host:port/database?options为方便起见,Laravel 支持将这些 URL 作为使用多个配置选项配置数据库的替代方法。如果存在 url(或相应的 DB_URL 环境变量)配置选项,则将使用它来提取数据库连接和凭据信息。
读/写连接
有时你可能希望将数据库连接用于 SELECT 语句,将另一个连接用于 INSERT、UPDATE 和 DELETE 语句。Laravel 使这变得轻而易举,无论你使用原生查询、查询构造器还是 Eloquent ORM,都将始终使用正确的连接。
要了解应如何配置读/写连接,让我们看一下此示例:
'mysql' => [
'driver' => 'mysql',
'read' => [
'host' => [
'192.168.1.1',
'196.168.1.2',
],
],
'write' => [
'host' => [
'192.168.1.3',
],
],
'sticky' => true,
'port' => env('DB_PORT', '3306'),
'database' => env('DB_DATABASE', 'laravel'),
'username' => env('DB_USERNAME', 'root'),
'password' => env('DB_PASSWORD', ''),
'unix_socket' => env('DB_SOCKET', ''),
'charset' => env('DB_CHARSET', 'utf8mb4'),
'collation' => env('DB_COLLATION', 'utf8mb4_unicode_ci'),
'prefix' => '',
'prefix_indexes' => true,
'strict' => true,
'engine' => null,
'options' => extension_loaded('pdo_mysql') ? array_filter([
(PHP_VERSION_ID >= 80500 ? \Pdo\Mysql::ATTR_SSL_CA : \PDO::MYSQL_ATTR_SSL_CA) => env('MYSQL_ATTR_SSL_CA'),
]) : [],
],注意,配置数组中添加了三个键:read、write 和 sticky。read 和 write 键的值是包含单个键 host 的数组。read 和 write 连接的其余数据库选项将从主 mysql 配置数组中合并。
如果你希望覆盖主 mysql 数组中的值,只需要将条目放在 read 和 write 数组中。因此,在此示例中,192.168.1.1 将用作“读”连接的主机,而 192.168.1.3 将用作“写”连接的主机。主 mysql 数组中的数据库凭据、前缀、字符集以及所有其他选项将在两个连接之间共享。当 host 配置数组中存在多个值时,将为每个请求随机选择一个数据库主机。
sticky 选项
sticky 选项是一个 可选 值,可用于允许在当前请求周期内立即读取已写入数据库的记录。如果启用了 sticky 选项,并且在当前请求周期内对数据库执行了“写”操作,则任何进一步的“读”操作都将使用“写”连接。这确保了在请求周期内写入的任何数据都可以在同一请求中立即从数据库读回。由你决定这是否是你的应用程序所需的行为。
运行 SQL 查询
配置数据库连接后,可以使用 DB Facade 运行查询。DB Facade 为每种类型的查询提供了方法:select、update、insert、delete 和 statement。
运行 Select 查询
要运行基本的 SELECT 查询,可以在 DB Facade 上使用 select 方法:
<?php
namespace App\Http\Controllers;
use Illuminate\Support\Facades\DB;
use Illuminate\View\View;
class UserController extends Controller
{
/**
* 显示所有应用程序用户的列表。
*/
public function index(): View
{
$users = DB::select('select * from users where active = ?', [1]);
return view('user.index', ['users' => $users]);
}
}传递给 select 方法的第一个参数是 SQL 查询,第二个参数是需要绑定到查询的任何参数绑定。通常,这些是 where 子句约束的值。参数绑定提供了针对 SQL 注入的保护。
select 方法将始终返回结果的 array。数组中的每个结果都是一个 PHP stdClass 对象,表示数据库中的一条记录:
use Illuminate\Support\Facades\DB;
$users = DB::select('select * from users');
foreach ($users as $user) {
echo $user->name;
}选择标量值
有时你的数据库查询可能产生单个标量值。Laravel 允许你使用 scalar 方法直接检索此值,而无需从记录对象中获取查询的标量结果:
$burgers = DB::scalar(
"select count(case when food = 'burger' then 1 end) as burgers from menu"
);选择多个结果集
如果你的应用程序调用返回多个结果集的存储过程,你可以使用 selectResultSets 方法检索存储过程返回的所有结果集:
[$options, $notifications] = DB::selectResultSets(
"CALL get_user_options_and_notifications(?)", $request->user()->id
);使用命名绑定
你可以使用命名绑定来执行查询,而不是使用 ? 来表示参数绑定:
$results = DB::select('select * from users where id = :id', ['id' => 1]);运行 Insert 语句
要执行 insert 语句,可以使用 DB Facade 上的 insert 方法。与 select 类似,它接受 SQL 查询作为第一个参数,绑定作为第二个参数:
use Illuminate\Support\Facades\DB;
DB::insert('insert into users (id, name) values (?, ?)', [1, 'Marc']);运行 Update 语句
update 方法应用于更新数据库中的现有记录。该方法返回受语句影响的行数:
use Illuminate\Support\Facades\DB;
$affected = DB::update(
'update users set votes = 100 where name = ?',
['Anita']
);运行 Delete 语句
delete 方法应用于从数据库中删除记录。与 update 一样,该方法将返回受影响的行数:
use Illuminate\Support\Facades\DB;
$deleted = DB::delete('delete from users');运行常规语句
某些数据库语句不返回任何值。对于这些类型的操作,你可以使用 DB Facade 上的 statement 方法:
DB::statement('drop table users');运行非预处理语句
有时你可能想要执行 SQL 语句而不绑定任何值。你可以使用 DB Facade 的 unprepared 方法来完成此操作:
DB::unprepared('update users set votes = 100 where name = "Dries"');WARNING
由于非预处理语句不绑定参数,它们可能容易受到 SQL 注入攻击。你绝不允许在非预处理语句中包含用户可控的值。
事务中的隐式提交
在事务中使用 DB Facade 的 statement 和 unprepared 方法时,必须小心避免导致隐式提交的语句。这些语句将导致数据库引擎间接提交整个事务,从而使 Laravel 无法感知数据库的事务级别。此类语句的一个示例是创建数据库表:
DB::unprepared('create table a (col varchar(1) null)');请参考 MySQL 手册,了解触发隐式提交的所有语句列表。
使用多个数据库连接
如果你的应用程序在 config/database.php 配置文件中定义了多个连接,你可以通过 DB Facade 提供的 connection 方法访问每个连接。传递给 connection 方法的连接名称应对应于 config/database.php 配置文件中列出的连接之一,或使用 config 辅助函数在运行时配置的连接:
use Illuminate\Support\Facades\DB;
$users = DB::connection('sqlite')->select(/* ... */);你可以使用连接实例上的 getPdo 方法访问连接的原始底层 PDO 实例:
$pdo = DB::connection()->getPdo();监听查询事件
如果你想指定一个闭包,该闭包在应用程序执行的每个 SQL 查询时被调用,可以使用 DB Facade 的 listen 方法。此方法对于记录查询或调试很有用。你可以在服务提供者的 boot 方法中注册查询监听器闭包:
<?php
namespace App\Providers;
use Illuminate\Database\Events\QueryExecuted;
use Illuminate\Support\Facades\DB;
use Illuminate\Support\ServiceProvider;
class AppServiceProvider extends ServiceProvider
{
/**
* 注册任何应用程序服务。
*/
public function register(): void
{
// ...
}
/**
* 引导任何应用程序服务。
*/
public function boot(): void
{
DB::listen(function (QueryExecuted $query) {
// $query->sql;
// $query->bindings;
// $query->time;
// $query->toRawSql();
});
}
}监控累计查询时间
现代 Web 应用程序的一个常见性能瓶颈是查询数据库所花费的时间。幸运的是,当 Laravel 在单个请求中查询数据库花费的时间过长时,它可以调用你选择的闭包或回调。首先,向 whenQueryingForLongerThan 方法提供查询时间阈值(以毫秒为单位)和闭包。你可以在服务提供者的 boot 方法中调用此方法:
<?php
namespace App\Providers;
use Illuminate\Database\Connection;
use Illuminate\Support\Facades\DB;
use Illuminate\Support\ServiceProvider;
use Illuminate\Database\Events\QueryExecuted;
class AppServiceProvider extends ServiceProvider
{
/**
* 注册任何应用程序服务。
*/
public function register(): void
{
// ...
}
/**
* 引导任何应用程序服务。
*/
public function boot(): void
{
DB::whenQueryingForLongerThan(500, function (Connection $connection, QueryExecuted $event) {
// 通知开发团队...
});
}
}数据库事务
你可以使用 DB Facade 提供的 transaction 方法在数据库事务中运行一组操作。如果在事务闭包中抛出异常,事务将自动回滚并重新抛出异常。如果闭包成功执行,事务将自动提交。使用 transaction 方法时,你无需担心手动回滚或提交:
use Illuminate\Support\Facades\DB;
DB::transaction(function () {
DB::update('update users set votes = 1');
DB::delete('delete from posts');
});处理死锁
transaction 方法接受一个可选的第二个参数,该参数定义了发生死锁时应重试事务的次数。尝试耗尽后,将抛出异常:
use Illuminate\Support\Facades\DB;
DB::transaction(function () {
DB::update('update users set votes = 1');
DB::delete('delete from posts');
}, attempts: 5);手动使用事务
如果你想手动启动一个事务并对回滚和提交拥有完全控制权,可以使用 DB Facade 提供的 beginTransaction 方法:
use Illuminate\Support\Facades\DB;
DB::beginTransaction();你可以通过 rollBack 方法回滚事务:
DB::rollBack();最后,你可以通过 commit 方法提交事务:
DB::commit();NOTE
DB Facade 的事务方法控制着查询构造器和 Eloquent ORM 的事务。
连接到数据库 CLI
如果你想连接到数据库的 CLI,可以使用 db Artisan 命令:
php artisan db如果需要,你可以指定一个数据库连接名称来连接到非默认连接的数据库:
php artisan db mysql检查你的数据库
使用 db:show 和 db:table Artisan 命令,你可以深入了解你的数据库及其相关表。要查看数据库的概览,包括其大小、类型、打开连接数以及表的摘要,可以使用 db:show 命令:
php artisan db:show你可以通过 --database 选项向命令提供数据库连接名称,以指定应检查哪个数据库连接:
php artisan db:show --database=pgsql如果你想在命令输出中包含表行数和数据库视图详细信息,可以分别提供 --counts 和 --views 选项。在大型数据库上,检索行数和视图详细信息可能会很慢:
php artisan db:show --counts --views此外,你可以使用以下 Schema 方法来检查你的数据库:
use Illuminate\Support\Facades\Schema;
$tables = Schema::getTables();
$views = Schema::getViews();
$columns = Schema::getColumns('users');
$indexes = Schema::getIndexes('users');
$foreignKeys = Schema::getForeignKeys('users');如果你想检查的数据库连接不是应用程序的默认连接,可以使用 connection 方法:
$columns = Schema::connection('sqlite')->getColumns('users');表概览
如果你想获取数据库中单个表的概览,可以执行 db:table Artisan 命令。此命令提供数据库表的常规概览,包括其列、类型、属性、键和索引:
php artisan db:table users监控你的数据库
使用 db:monitor Artisan 命令,如果你的数据库管理的打开连接数超过指定数量,你可以指示 Laravel 调度一个 Illuminate\Database\Events\DatabaseBusy 事件。
首先,你应该将 db:monitor 命令设置为每分钟运行一次。该命令接受你想要监控的数据库连接配置的名称,以及在触发事件之前应容忍的最大打开连接数:
php artisan db:monitor --databases=mysql,pgsql --max=100仅调度此命令不足以触发通知警报你打开连接的数量。当命令遇到打开连接数超过阈值的数据库时,将调度一个 DatabaseBusy 事件。你应该在应用程序的 AppServiceProvider 中监听此事件,以便向你或你的开发团队发送通知:
use App\Notifications\DatabaseApproachingMaxConnections;
use Illuminate\Database\Events\DatabaseBusy;
use Illuminate\Support\Facades\Event;
use Illuminate\Support\Facades\Notification;
/**
* 引导任何应用程序服务。
*/
public function boot(): void
{
Event::listen(function (DatabaseBusy $event) {
Notification::route('mail', 'dev@example.com')
->notify(new DatabaseApproachingMaxConnections(
$event->connectionName,
$event->connections
));
});
}