Eloquent查询优化与搜索技巧详解

文章小白一枚，正在不断学习积累知识，现将学习到的知识记录一下，也是将我的所得分享给大家！而今天这篇文章《Eloquent 条件查询与搜索优化技巧》带大家来了解一下##content_title##，希望对大家的知识积累有所帮助，从而弥补自己的不足，助力实战开发！

本文探讨在 Laravel Eloquent 中如何优雅地实现条件字段选择，即根据 title 和 original_title 字段的值动态生成一个新字段。我们将介绍两种主要方法：利用 Eloquent Accessor 进行模型层面的处理，以及在必要时使用 DB::raw 进行数据库层面的计算。此外，还将涵盖如何在这些字段上执行条件搜索。

在开发过程中，我们经常会遇到需要根据现有字段的条件逻辑来生成一个新字段的需求。例如，在一个模型中存在 title 和 original_title 两个字段，我们希望在查询结果中获得一个统一的 coolTitle 字段，其值优先取 title，如果 title 为空（或 null），则取 original_title。尽管使用 DB::raw 可以直接在数据库层面实现这一逻辑，但有时我们希望有更“Eloquent 风格”的解决方案。

一、使用 Eloquent Accessor 实现模型层面的条件字段选择

Eloquent Accessor（访问器）是 Laravel 提供的一种优雅方式，用于在模型实例被访问时自动修改或计算属性。它非常适合在数据从数据库取出后进行二次处理，以生成新的派生属性，而无需修改原始数据库查询。

1. 定义 Accessor

在您的 Activity 模型中，定义一个名为 getCoolTitleAttribute 的方法。Eloquent 会自动将 cool_title 属性的访问映射到这个方法。

// app/Models/Activity.php

namespace App\Models;

use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;

class Activity extends Model
{
    use HasFactory;

    /**
     * 获取活动的统一标题 (coolTitle)。
     * 如果 title 存在且非空，则使用 title；否则使用 original_title。
     *
     * @return string|null
     */
    public function getCoolTitleAttribute(): ?string
    {
        // 这里的 'title' 和 'original_title' 是模型实例的属性
        // 可以根据实际情况判断空字符串或 null
        return $this->attributes['title'] ?? $this->attributes['original_title'];
        // 或者更严格的空字符串检查：
        // return !empty($this->attributes['title']) ? $this->attributes['title'] : $this->attributes['original_title'];
    }

    /**
     * 如果希望在模型序列化为 JSON 时自动包含此属性，
     * 可以将其添加到 $appends 数组中。
     *
     * @var array
     */
    protected $appends = ['cool_title'];
}

2. 使用 Accessor

一旦定义了 Accessor，您就可以像访问模型其他属性一样访问 cool_title。

$activity = Activity::find(1);

// 访问 coolTitle 属性
echo $activity->cool_title; // 会自动调用 getCoolTitleAttribute 方法

// 如果查询结果是集合
$activities = Activity::all();
foreach ($activities as $activity) {
    echo $activity->cool_title . "\n";
}

// 当模型被序列化为 JSON 时（例如在 API 响应中），
// 如果 $appends 数组中包含了 'cool_title'，它也会被自动包含。
return response()->json($activity);

优点：

• 代码整洁： 将业务逻辑封装在模型内部，符合面向对象原则。
• 可读性强： 避免了复杂的 SQL 片段，提高了代码可读性。
• 易于维护： 逻辑集中管理，方便修改和测试。

缺点：

• 性能开销： 字段计算发生在数据从数据库取出后，对于大量数据或需要高性能的场景，可能不如数据库层面计算高效。
• 无法直接用于数据库查询/排序： 您不能直接在 where('cool_title', '...') 或 orderBy('cool_title') 中使用此属性，因为 cool_title 不存在于数据库表中。

二、使用 DB::raw 实现数据库层面的条件字段选择

尽管用户可能倾向于避免原始 SQL，但在某些场景下，例如需要在数据库层面进行高效过滤、排序，或者处理大量数据时，DB::raw 仍然是不可替代的强大工具。它允许您直接将 SQL 片段注入到 Eloquent 查询中。

1. 构建查询

我们可以使用 addSelect 方法结合 DB::raw 来添加一个计算字段。

use Illuminate\Support\Facades\DB;
use App\Models\Activity;

// 假设我们正在查询 Activity 模型
$activities = Activity::addSelect([
    'id', // 选择其他需要的字段
    'title',
    'original_title',
    DB::raw('(CASE WHEN title IS NULL OR title = "" THEN original_title ELSE title END) as coolTitle')
])->get();

foreach ($activities as $activity) {
    echo "ID: {$activity->id}, Title: {$activity->title}, Original Title: {$activity->original_title}, Cool Title: {$activity->coolTitle}\n";
}

注意事项：

• CASE WHEN 语句中的条件需要根据实际情况调整。IS NULL 用于检查 NULL 值，title = "" 用于检查空字符串。通常建议同时检查。
• addSelect 方法会保留您模型中 $fillable 或 $guarded 之外的其他字段，但为了清晰起见，最好明确列出所有需要的字段。

2. 使用数据库函数简化 (例如 MySQL 的 IFNULL/COALESCE)

如果您的数据库支持，可以使用更简洁的数据库函数，例如 MySQL 的 IFNULL 或 COALESCE。COALESCE 函数返回其参数中第一个非 NULL 的表达式。

// 使用 COALESCE，它会返回第一个非 NULL 的表达式
// 如果 title 可能为空字符串但不是 NULL，则需要更复杂的逻辑
$activities = Activity::addSelect([
    'id',
    'title',
    'original_title',
    DB::raw('COALESCE(NULLIF(title, ""), original_title) as coolTitle')
])->get();
// NULLIF(title, "") 会将空字符串的 title 转换为 NULL，
// 然后 COALESCE 就可以处理 NULL 和 original_title。

// 如果只需要处理 NULL 值，COALESCE 足够
$activities = Activity::addSelect([
    'id',
    'title',
    'original_title',
    DB::raw('COALESCE(title, original_title) as coolTitle')
])->get();

优点：

• 性能高效： 计算在数据库层面完成，减少了应用层面的处理负担。
• 可用于查询/排序： 可以直接在 where('coolTitle', '...') 或 orderBy('coolTitle') 中使用这个计算字段。

缺点：

• 可读性略低： 相比 Accessor，SQL 片段可能略显复杂。
• 数据库依赖： DB::raw 中的 SQL 语法可能依赖于特定的数据库系统（例如 MySQL 的 IFNULL，PostgreSQL 的 COALESCE）。

三、处理基于条件字段的搜索

原始问题中也提到了“make a search”的需求。如果您需要根据 title 或 original_title 的值进行搜索，而不一定需要创建一个新的 coolTitle 字段，那么可以使用 where 和 orWhere 组合。

1. 简单的条件搜索

假设您要搜索 $search 关键字，如果 title 不为空且匹配，或者 original_title 匹配，则返回结果。

use App\Models\Activity;

$search = 'some keyword';

$activities = Activity::where(function ($query) use ($search) {
    // 检查 title 是否不为空且匹配搜索词
    $query->whereNotNull('title')
          ->where('title', 'like', '%' . $search . '%');
})->orWhere(function ($query) use ($search) {
    // 或者 original_title 匹配搜索词
    $query->where('original_title', 'like', '%' . $search . '%');
})->get();

2. 考虑空值/空字符串的搜索逻辑

如果您的逻辑是“如果 title 为空，则搜索 original_title；否则搜索 title”，这在单个数据库查询中实现会稍微复杂，通常需要 DB::raw 或更复杂的 where 嵌套。

例如，如果您想搜索 coolTitle 的逻辑（title 优先，否则 original_title）：

use Illuminate\Support\Facades\DB;
use App\Models\Activity;

$search = 'some keyword';

$activities = Activity::where(function ($query) use ($search) {
    // 如果 title 不为空，则搜索 title
    $query->whereNotNull('title')
          ->where('title', 'like', '%' . $search . '%');
})->orWhere(function ($query) use ($search) {
    // 如果 title 为空（或 null），则搜索 original_title
    $query->where(function ($subQuery) {
        $subQuery->whereNull('title')->orWhere('title', ''); // 检查 title 为 null 或空字符串
    })->where('original_title', 'like', '%' . $search . '%');
})->get();

这种方法虽然没有直接创建 coolTitle 字段，但实现了基于相同逻辑的搜索功能。

四、选择最佳方案

• 如果主要目的是在模型实例被访问时显示或处理派生属性，并且不需要在数据库层面进行过滤或排序，推荐使用 Eloquent Accessor。 它提供了最“Eloquent 风格”的解决方案，代码整洁且易于维护。
• 如果需要根据派生字段进行高效的数据库过滤、排序，或者处理大量数据时性能至关重要，那么使用 DB::raw 是更合适的选择。 尽管涉及原始 SQL，但它直接利用了数据库的强大功能。
• 如果仅仅是需要在两个字段中进行条件搜索，而不需要生成一个新字段，则可以使用 where 和 orWhere 的组合来构建复杂的搜索逻辑。

最终的选择取决于您的具体需求、对性能的考量以及对代码风格的偏好。通常，从 Accessor 开始，如果遇到性能瓶颈或需要数据库层面的复杂操作，再考虑转向 DB::raw 是一个明智的策略。

以上就是《Eloquent查询优化与搜索技巧详解》的详细内容，更多关于的资料请关注golang学习网公众号！