在Laravel Eloquent中创建条件性自定义列的多种策略

问题解析：在Eloquent中创建条件性自定义列

在进行数据库查询时，我们经常会遇到需要根据特定条件从现有字段中派生出新字段的需求。例如，在一个模型中，我们可能同时拥有title和original_title两个字段，希望在查询结果中生成一个名为cooltitle的自定义列。这个cooltitle的值应优先使用title字段，但如果title为空（包括空字符串或null），则退而使用original_title的值。

用户最初尝试使用DB::raw结合SQL的CASE语句来实现这一目标：

$activity = Activity::addSelect(
    DB::raw('(CASE WHEN title = "" THEN original_title ELSE title END) as coolTitle')
)->get();

这种方法虽然有效，但部分开发者可能倾向于避免直接使用原始SQL，寻求更“Eloquent化”或更具PHP风格的解决方案。此外，在处理“空”的概念时，我们需要明确区分空字符串（''）和NULL值，这在SQL的条件判断中至关重要。

方案一：使用DB::raw实现数据库层面的条件选择

尽管用户希望避免使用DB::raw，但对于复杂的条件逻辑和SQL函数，DB::raw往往是最高效且最直接的数据库层面解决方案。它允许我们直接向查询构建器注入任意的SQL片段，确保了最大的灵活性和数据库级别的性能优化。

示例代码：

考虑到空值判断的严谨性，我们通常会同时检查NULL和空字符串。

use Illuminate\Support\Facades\DB;

// 获取Activity模型实例，或者直接在静态方法中调用
// $db = DB::connection()->getQueryGrammar(); // 如果需要更底层的语法访问，但通常DB::raw就足够

$activities = Activity::addSelect([
    '*', // 选择所有现有列
    DB::raw("CASE 
                WHEN title IS NULL OR title = '' 
                THTHEN original_title 
                ELSE title 
             END AS coolTitle")
])->get();

foreach ($activities as $activity) {
    echo $activity->coolTitle; // 访问自定义的coolTitle属性
}

注意事项：

• 性能优势： DB::raw将条件逻辑直接下推到数据库执行，这意味着数据库在返回数据之前就完成了字段的合并和计算，减少了PHP应用层的处理负担，尤其适用于大量数据查询。
• 灵活性： 适用于任何复杂的SQL函数或条件逻辑，是处理数据库原生功能的强大工具。
• 可读性： 相较于纯Eloquent链式调用，SQL片段的可读性可能略低，但对于熟悉SQL的开发者而言，其意图清晰。
• 跨数据库兼容性： SQL语法可能因数据库类型（MySQL, PostgreSQL, SQLite等）而异，需要注意兼容性。上述CASE WHEN语法在主流关系型数据库中普遍支持。

方案二：利用Eloquent模型访问器实现应用层逻辑封装

如果自定义列的需求主要用于数据显示，且不需要在数据库层面进行排序或筛选，那么使用Eloquent模型访问器（Accessor）是一个“更干净”、更符合面向对象编程思想的解决方案。访问器允许我们在模型中定义一个方法，动态地为模型实例添加一个虚拟属性。

示例代码：

在Activity模型中定义一个访问器：

百度文心百中

百度大模型语义搜索体验中心

22

查看详情

// app/Models/Activity.php

namespace App\Models;

use Illuminate\Database\Eloquent\Model;

class Activity extends Model
{
    // ... 其他模型定义 ...

    /**
     * 获取自定义的coolTitle属性。
     *
     * @return string
     */
    public function getCoolTitleAttribute(): string
    {
        // 优先使用title，如果title为空或null，则使用original_title
        return $this->title ?? $this->original_title ?? '';
        // 或者更明确地判断空字符串
        // return (empty($this->title) && $this->title !== '0') ? ($this->original_title ?? '') : $this->title;
    }
}

现在，当您查询Activity模型并访问coolTitle属性时，Eloquent会自动调用getCoolTitleAttribute方法：

$activities = Activity::all(); // 或任何其他查询

foreach ($activities as $activity) {
    echo $activity->coolTitle; // 访问虚拟属性
}

注意事项：

• 代码可维护性： 将业务逻辑封装在模型内部，使查询代码更简洁，提高了代码的可读性和可维护性。
• 性能考量： 访问器是在数据从数据库加载到PHP应用后才执行的。这意味着如果需要对coolTitle进行数据库层面的排序（orderBy('coolTitle')）或筛选（where('coolTitle', 'like', '%search%')），此方法将无法直接支持。
• 惰性加载： 访问器仅在访问对应属性时才执行，这对于不总是需要计算的属性来说是高效的。

方案三：针对不同需求的查询策略——筛选而非选择

值得注意的是，原始问题和提供的答案中存在一个重要的概念区分：“选择自定义列”与“按条件筛选记录”。用户最初的目标是选择一个根据条件合并的新列，而答案中提供的whereNotNull和orWhere示例则主要用于筛选符合特定条件的记录。

筛选示例（基于提供的答案）：

如果您想查找title或original_title中包含特定关键词的活动，可以使用如下查询：

$search = 'your search term';

$activities = Activity::where(function ($query) use ($search) {
    $query->whereNotNull('title') // 确保title不为NULL
          ->where('title', 'like', "%{$search}%");
})->orWhere(function ($query) use ($search) {
    $query->whereNotNull('original_title') // 确保original_title不为NULL
          ->where('original_title', 'like', "%{$search}%");
})->get();

// 简化版本，如果不需要区分null和空字符串
// $activities = Activity::where('title', 'like', "%{$search}%")
//                      ->orWhere('original_title', 'like', "%{$search}%")
//                      ->get();

注意事项：

• 目的不同： 此方法用于根据title或original_title的内容来过滤数据集，它并不会在结果集中创建一个新的coolTitle列。
• 组合使用： 如果既需要筛选，又需要自定义列，可以结合使用上述方案。例如，先用where条件筛选出相关记录，再用addSelect(DB::raw(...))添加自定义列。

总结与选择建议

在Laravel Eloquent中创建条件性自定义列时，选择哪种策略取决于您的具体需求和对性能、代码可维护性的权衡：

• 首选DB::raw (方案一)：
  • 当您需要在数据库层面进行复杂计算、排序或筛选，并且对性能有较高要求时。
  • 当您需要处理大量数据，将计算逻辑下推到数据库能显著提升效率。
• 考虑模型访问器 (方案二)：
  • 当自定义列仅用于应用层的数据展示，不需要在数据库层面进行排序或筛选时。
  • 当您希望将业务逻辑封装在模型内部，提高代码的可读性和可维护性时。
• 理解筛选策略 (方案三)：
  • 明确区分“选择自定义列”和“根据条件筛选记录”是两个不同的目标。
  • 根据实际的查询需求，灵活运用where、orWhere等方法进行数据过滤。

在大多数情况下，对于条件性的自定义列选择，DB::raw结合SQL CASE语句是兼顾性能和灵活性的最佳选择。如果对原始SQL有顾虑，可以通过封装查询范围（Query Scope）来提高代码的复用性和整洁性。

以上就是在Laravel Eloquent中创建条件性自定义列的多种策略的详细内容，更多请关注php中文网其它相关文章！