发布于 由admin

Laravel Eloquent ORM：优雅的数据库操作

好的，各位观众老爷们，欢迎来到今天的Laravel Eloquent ORM专场！我是你们的老朋友，码农李狗蛋儿（当然，你们也可以叫我李老师，或者蛋哥😎），今天咱们就来聊聊这Laravel框架里最优雅、最迷人的部分——Eloquent ORM。

开场白：数据库操作的那些“不堪回首”

话说回来，在没有Eloquent之前，我们操作数据库那可是相当“刺激”的。手写SQL语句，bindParam绑定参数，一不小心就SQL注入，痛苦得想撞墙。那时候的程序员，每天都在跟各种数据库驱动打交道，什么PDO、MySQLi，简直就是一场噩梦。

想象一下，你要查询一个用户，可能要这样写：

<?php

// 原始的、令人头皮发麻的查询方式

$host = 'localhost';
$dbname = 'my_database';
$username = 'root';
$password = 'password';

try {
    $pdo = new PDO("mysql:host=$host;dbname=$dbname", $username, $password);
    $pdo->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);

    $id = 123; // 假设我们要查询ID为123的用户

    $sql = "SELECT * FROM users WHERE id = :id";
    $stmt = $pdo->prepare($sql);
    $stmt->bindParam(':id', $id, PDO::PARAM_INT);
    $stmt->execute();

    $user = $stmt->fetch(PDO::FETCH_ASSOC);

    if ($user) {
        echo "用户ID: " . $user['id'] . "n";
        echo "用户名: " . $user['name'] . "n";
        echo "邮箱: " . $user['email'] . "n";
    } else {
        echo "未找到用户n";
    }

} catch (PDOException $e) {
    echo "连接失败: " . $e->getMessage() . "n";
}

// 释放连接
$pdo = null;

?>

这段代码，光是想想就让人头皮发麻！要处理各种异常，要手动绑定参数，还要注意SQL注入的风险。简直是程序员的噩梦！

而现在，有了Eloquent，一切都变得不一样了！让我们一起走进Eloquent ORM的世界，感受它的优雅与强大！

第一幕：Eloquent ORM 闪亮登场

Eloquent ORM（Object-Relational Mapper），顾名思义，就是将数据库表映射为PHP对象。你可以像操作对象一样操作数据库，告别繁琐的SQL语句，简直就是程序员的福音！🥳

1. 什么是ORM？

简单来说，ORM就像一个翻译官，它把数据库里的数据翻译成我们可以直接使用的PHP对象，也把我们对PHP对象的操作翻译成数据库能够理解的SQL语句。这样，我们就可以专注于业务逻辑，而不用再为了复杂的SQL语句而烦恼了。

2. Eloquent 的优势

  • 优雅简洁： 代码更简洁，可读性更高。告别冗长的SQL语句，让你的代码看起来赏心悦目。
  • 安全可靠： 自动处理SQL注入，让你远离安全隐患。
  • 方便快捷： 提供丰富的API，方便进行各种数据库操作。
  • 易于维护： 代码结构清晰，易于维护和扩展。
  • 关系处理： 强大的关系处理能力，轻松处理表之间的关联关系。

第二幕：Eloquent 的基本用法

1. 创建 Model

首先，我们需要创建一个Model，它代表数据库中的一张表。在Laravel中，可以使用Artisan命令快速生成Model：

php artisan make:model User

这会在app/Models目录下创建一个User.php文件。

2. 定义 Model

打开User.php文件，我们可以定义一些属性：

<?php

namespace AppModels;

use IlluminateDatabaseEloquentModel;

class User extends Model
{
    // 指定关联的表名
    protected $table = 'users';

    // 指定主键
    protected $primaryKey = 'id';

    // 是否自动维护时间戳（created_at 和 updated_at）
    public $timestamps = true;

    // 允许批量赋值的字段
    protected $fillable = [
        'name',
        'email',
        'password',
    ];

    // 隐藏字段，不会在JSON响应中显示
    protected $hidden = [
        'password',
        'remember_token',
    ];

    // 类型转换
    protected $casts = [
        'email_verified_at' => 'datetime',
    ];
}
  • $table：指定关联的表名。如果Model的名称是单数形式，Laravel会自动将表名转换为复数形式。例如，Model名为User，则默认关联的表名为users。
  • $primaryKey：指定主键。默认情况下，主键是id。
  • $timestamps：是否自动维护时间戳。如果设置为true，Laravel会自动维护created_at和updated_at字段。
  • $fillable：允许批量赋值的字段。只有在这个数组中的字段才能通过create和update方法进行批量赋值。
  • $hidden：隐藏字段。这些字段不会在JSON响应中显示。
  • $casts：类型转换。可以将数据库中的字段转换为指定的类型。

3. 查询数据

有了Model，我们就可以开始查询数据了。

  • 查询所有数据：

    $users = User::all(); // 获取所有用户

  • 根据ID查询：

    $user = User::find(1); // 获取ID为1的用户
$user = User::findOrFail(1); // 获取ID为1的用户，如果找不到则抛出异常

  • 使用where条件查询：

    $users = User::where('email', 'like', '%@example.com%')->get(); // 查询邮箱包含@example.com的用户
$users = User::where('status', 1)
             ->where('created_at', '>', now()->subDays(30))
             ->orderBy('created_at', 'desc')
             ->limit(10)
             ->get(); // 查询近30天内创建的，状态为1的前10个用户，按创建时间倒序排列

  • First 或 FirstOrFail

    $user = User::where('email', '[email protected]')->first(); // 获取邮箱为[email protected]的第一个用户，如果不存在则返回null
$user = User::where('email', '[email protected]')->firstOrFail(); // 获取邮箱为[email protected]的第一个用户，如果不存在则抛出异常

4. 创建数据

  • 使用create方法：

    $user = User::create([
    'name' => 'John Doe',
    'email' => '[email protected]',
    'password' => bcrypt('password'), // 使用bcrypt加密密码
]);

  • 使用new方法：

    $user = new User();
$user->name = 'Jane Doe';
$user->email = '[email protected]';
$user->password = bcrypt('password');
$user->save();

5. 更新数据

  • 使用save方法：

    $user = User::find(1);
$user->name = 'Updated Name';
$user->email = '[email protected]';
$user->save();

  • 使用update方法：

    User::where('id', 1)->update([
    'name' => 'Updated Name',
    'email' => '[email protected]',
]);

6. 删除数据

  • 使用delete方法：

    $user = User::find(1);
$user->delete();

  • 使用destroy方法：

    User::destroy(1); // 删除ID为1的用户
User::destroy([1, 2, 3]); // 删除ID为1, 2, 3的用户

第三幕：Eloquent 的高级用法

Eloquent 的强大之处不仅仅在于简单的CRUD操作，它还提供了许多高级功能，让我们可以更加灵活地操作数据库。

1. 作用域（Scopes）

作用域允许我们定义一些常用的查询条件，并在Model中复用。

  • 全局作用域（Global Scopes）：

    全局作用域会自动应用到Model的所有查询中。例如，我们可以定义一个全局作用域，只查询状态为1的数据：

    <?php

namespace AppModels;

use IlluminateDatabaseEloquentModel;
use IlluminateDatabaseEloquentBuilder;
use IlluminateDatabaseEloquentScope;

class ActiveScope implements Scope
{
    public function apply(Builder $builder, Model $model)
    {
        $builder->where('status', 1);
    }
}

class User extends Model
{
    // ...

    protected static function booted()
    {
        static::addGlobalScope(new ActiveScope);
    }
}

    现在，当我们查询User模型时，会自动添加where('status', 1)条件。

  • 本地作用域（Local Scopes）：

    本地作用域允许我们定义一些自定义的查询方法。例如，我们可以定义一个active作用域，只查询状态为1的数据：

    <?php

namespace AppModels;

use IlluminateDatabaseEloquentModel;
use IlluminateDatabaseEloquentBuilder;

class User extends Model
{
    // ...

    public function scopeActive(Builder $query)
    {
        return $query->where('status', 1);
    }
}

    使用方法：

    $users = User::active()->get(); // 查询状态为1的用户

2. 访问器和修改器（Accessors & Mutators）

访问器和修改器允许我们在获取和设置Model属性时进行一些自定义操作。

  • 访问器（Accessors）：

    访问器允许我们在获取Model属性时进行一些自定义操作。例如，我们可以定义一个访问器，将用户的名字转换为大写：

    <?php

namespace AppModels;

use IlluminateDatabaseEloquentModel;

class User extends Model
{
    // ...

    public function getNameAttribute($value)
    {
        return strtoupper($value);
    }
}

    使用方法：

    $user = User::find(1);
echo $user->name; // 输出大写的用户名

  • 修改器（Mutators）：

    修改器允许我们在设置Model属性时进行一些自定义操作。例如，我们可以定义一个修改器，将用户的密码进行加密：

    <?php

namespace AppModels;

use IlluminateDatabaseEloquentModel;

class User extends Model
{
    // ...

    public function setPasswordAttribute($value)
    {
        $this->attributes['password'] = bcrypt($value);
    }
}

    使用方法：

    $user = new User();
$user->password = 'password'; // 密码会自动加密
$user->save();

3. 关系（Relationships）

Eloquent 提供了强大的关系处理能力，可以轻松处理表之间的关联关系。

  • 一对一（One To One）：

    例如，一个用户对应一个个人资料：

    <?php

namespace AppModels;

use IlluminateDatabaseEloquentModel;

class User extends Model
{
    // ...

    public function profile()
    {
        return $this->hasOne(Profile::class);
    }
}

class Profile extends Model
{
    // ...

    public function user()
    {
        return $this->belongsTo(User::class);
    }
}

    使用方法：

    $user = User::find(1);
$profile = $user->profile; // 获取用户的个人资料
$user = $profile->user; // 获取个人资料所属的用户

  • 一对多（One To Many）：

    例如，一个用户可以有多篇文章：

    <?php

namespace AppModels;

use IlluminateDatabaseEloquentModel;

class User extends Model
{
    // ...

    public function posts()
    {
        return $this->hasMany(Post::class);
    }
}

class Post extends Model
{
    // ...

    public function user()
    {
        return $this->belongsTo(User::class);
    }
}

    使用方法：

    $user = User::find(1);
$posts = $user->posts; // 获取用户的所有文章
$user = $post->user; // 获取文章所属的用户

  • 多对多（Many To Many）：

    例如，一个用户可以有多个角色，一个角色可以被多个用户拥有：

    <?php

namespace AppModels;

use IlluminateDatabaseEloquentModel;

class User extends Model
{
    // ...

    public function roles()
    {
        return $this->belongsToMany(Role::class);
    }
}

class Role extends Model
{
    // ...

    public function users()
    {
        return $this->belongsToMany(User::class);
    }
}

    使用方法：

    $user = User::find(1);
$roles = $user->roles; // 获取用户的所有角色
$users = $role->users; // 获取拥有该角色的所有用户

  • 多态关系（Polymorphic Relationships）：

    多态关系允许一个模型可以关联到多个其他模型。例如，一个评论可以关联到文章、视频或图片：

    <?php

namespace AppModels;

use IlluminateDatabaseEloquentModel;

class Comment extends Model
{
    // ...

    public function commentable()
    {
        return $this->morphTo();
    }
}

class Post extends Model
{
    // ...

    public function comments()
    {
        return $this->morphMany(Comment::class, 'commentable');
    }
}

class Video extends Model
{
    // ...

    public function comments()
    {
        return $this->morphMany(Comment::class, 'commentable');
    }
}

class Image extends Model
{
    // ...

    public function comments()
    {
        return $this->morphMany(Comment::class, 'commentable');
    }
}

    使用方法：

    $post = Post::find(1);
$comments = $post->comments; // 获取文章的所有评论

$comment = Comment::find(1);
$commentable = $comment->commentable; // 获取评论所属的模型（可以是文章、视频或图片）

4. 懒加载与预加载（Lazy Loading & Eager Loading）

  • 懒加载（Lazy Loading）：

    懒加载是指在需要访问关联关系时才进行查询。例如，当我们查询一个用户时，不会立即查询用户的个人资料，而是在访问$user->profile时才进行查询。

    懒加载的优点是可以减少初始查询的负担，但如果需要频繁访问关联关系，会导致大量的数据库查询，影响性能。

  • 预加载（Eager Loading）：

    预加载是指在初始查询时就将关联关系一起查询出来。例如，当我们查询一个用户时，可以同时查询用户的个人资料：

    $users = User::with('profile')->get(); // 查询所有用户，并预加载个人资料

    预加载的优点是可以减少数据库查询次数，提高性能，但会增加初始查询的负担。

5. 模型事件（Model Events）

Eloquent 提供了模型事件，允许我们在Model的不同生命周期阶段执行一些自定义操作。

  • 常用的模型事件：

    • creating：在创建Model之前触发。
    • created：在创建Model之后触发。
    • updating：在更新Model之前触发。
    • updated：在更新Model之后触发。
    • saving：在保存Model之前触发。
    • saved：在保存Model之后触发。
    • deleting：在删除Model之前触发。
    • deleted：在删除Model之后触发。
    • restoring：在恢复Model之前触发。
    • restored：在恢复Model之后触发。

  • 使用方法：

    <?php

namespace AppModels;

use IlluminateDatabaseEloquentModel;

class User extends Model
{
    // ...

    protected static function booted()
    {
        static::creating(function ($user) {
            $user->uuid = Str::uuid(); // 在创建用户之前生成UUID
        });

        static::updating(function ($user) {
            // 在更新用户之前执行一些操作
        });
    }
}

第四幕：Eloquent 的最佳实践

  • 合理使用fillable和guarded属性，防止批量赋值漏洞。
  • 使用bcrypt函数加密密码。
  • 合理使用作用域，提高代码复用性。
  • 使用访问器和修改器，简化数据处理逻辑。
  • 使用关系处理，简化表之间的关联操作。
  • 根据实际情况选择懒加载或预加载，优化性能。
  • 使用模型事件，在Model的生命周期中执行自定义操作。
  • 使用数据库事务，保证数据的一致性。
  • 使用数据库迁移，方便数据库结构的维护和升级。
  • 编写单元测试，保证代码的质量。

总结：Eloquent ORM，你值得拥有！

各位，今天我们一起深入了解了Laravel Eloquent ORM的方方面面。从基本用法到高级技巧，从代码示例到最佳实践，希望大家对Eloquent ORM有了更深刻的理解。

Eloquent ORM不仅仅是一个数据库操作工具，更是一种编程思想，一种优雅的解决方案。它可以让我们告别繁琐的SQL语句，专注于业务逻辑，提高开发效率，让我们的代码更加简洁、可读、易于维护。

所以，还在等什么呢？赶紧用起来吧！相信我，一旦你用上了Eloquent ORM，就会爱上它！💖

最后的最后，希望今天的分享对大家有所帮助。如果大家有什么问题，欢迎在评论区留言，我会尽力解答。谢谢大家！🙏

发表回复

您的邮箱地址不会被公开。 必填项已用 * 标注