在Eloquent查询中创建自定义派生列
在web开发中，我们经常会遇到需要根据模型中现有字段的值动态生成一个新字段的场景。例如，一个产品可能有主标题 (title) 和备用标题 (original_title)，我们希望在查询结果中得到一个统一的“显示标题”（cooltitle），其逻辑是：如果 title 不为空，则使用 title 的值；否则，使用 original_title 的值。本文将探讨如何在不直接依赖原始sql的情况下实现这一目标，同时也会介绍使用原始sql的直接方法及其优势。
方法一：使用数据库原生SQL (DB::raw)
尽管用户倾向于避免原生SQL，但在某些情况下，尤其是在需要数据库层面进行复杂计算、排序或过滤时，DB::raw 是最直接且性能最佳的选择。它允许我们将自定义的SQL表达式直接注入到Eloquent查询中，从而在数据库层完成计算。
实现示例：
use Illuminate\Support\Facades\DB;
use App\Models\Activity; // 假设您的模型名为Activity
$activities = Activity::addSelect([
'*', // 选择所有现有列
DB::raw('CASE WHEN title IS NOT NULL AND title != "" THEN title ELSE original_title END AS coolTitle')
])->get();
foreach ($activities as $activity) {
echo $activity->coolTitle; // 访问派生列
}代码解析：
- addSelect('*'): 确保查询结果中包含模型的所有原始字段。
- DB::raw(...): 允许我们编写原生SQL表达式。
- CASE WHEN title IS NOT NULL AND title != "" THEN title ELSE original_title END: 这是一个标准的SQL条件表达式。它首先检查 title 是否为 NULL 且不为空字符串。如果满足条件，则使用 title 的值；否则，使用 original_title 的值。
- AS coolTitle: 为这个派生列指定一个别名，使其可以在模型实例中像普通属性一样访问。
优点：
- 性能高效： 计算在数据库服务器端完成，减少了PHP端的处理负担，尤其适用于大数据量查询。
- 功能强大： 可以利用数据库的全部SQL功能，包括复杂的聚合、窗口函数等。
- 直接用于排序/过滤： 可以在查询中直接使用 coolTitle 进行 orderBy 或 where 操作，因为它是数据库查询结果的一部分。
缺点：
- 可读性降低： SQL字符串可能较长，降低了代码的PHP纯粹性。
- 数据库依赖： SQL语法可能因数据库类型而异（尽管 CASE WHEN 是标准SQL）。
方法二：使用Eloquent模型访问器 (Accessors)
如果派生列的逻辑不需要在数据库层面进行排序、过滤或分组，并且您希望保持代码的PHP纯粹性，那么使用Eloquent模型访问器是一个“更干净”的选择。访问器允许您在模型中定义一个方法，该方法在访问特定属性时会被自动调用。
实现示例：
首先，在您的 Activity 模型中定义一个访问器：
// app/Models/Activity.php
namespace App\Models;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;
class Activity extends Model
{
use HasFactory;
// ... 其他模型定义
/**
* 获取活动的统一标题。
*
* @return string
*/
public function getCoolTitleAttribute(): string
{
// 确保字段存在且不为空字符串
if (!empty($this->attributes['title'])) {
return $this->attributes['title'];
}
// 如果title为空，则返回original_title，确保返回字符串类型
return $this->attributes['original_title'] ?? '';
}
/**
* 可选：将coolTitle添加到模型序列化的属性列表中，以便在toArray()或toJson()时包含。
*
* @var array
*/
protected $appends = ['cool_title'];
}代码解析：
- getCoolTitleAttribute(): 这是一个访问器方法的命名约定，CoolTitle 部分会被转换为 cool_title 属性。
- !empty($this->attributes['title']): 检查 title 属性是否存在且不为空（包括 null 和空字符串）。
- $this->attributes['original_title'] ?? '': 使用空合并运算符确保即使 original_title 为 null 也返回一个空字符串，避免潜在错误。
- protected $appends = ['cool_title'];: 如果希望在将模型转换为数组或JSON时自动包含 cool_title 属性，需要将其添加到 $appends 数组中。
使用方式：
use App\Models\Activity;
$activities = Activity::all(); // 正常查询所有活动
foreach ($activities as $activity) {
echo $activity->cool_title; // 访问通过访问器定义的属性
}优点：
- 代码整洁： 逻辑封装在模型内部，与业务逻辑更贴合。
- PHP原生： 完全使用PHP代码实现，易于理解和测试。
- 可重用性： cool_title 属性可以在模型实例的任何地方被访问。
缺点：
- 性能开销： 逻辑在PHP端执行，对于大量结果集，可能略慢于数据库层面的计算。
- 无法直接用于数据库排序/过滤： 您不能直接在Eloquent查询中使用 where('cool_title', '...') 或 orderBy('cool_title')，因为 cool_title 并非数据库中的真实列。如果需要，您必须先获取所有数据，然后在PHP集合上进行过滤或排序。
结合搜索逻辑的考量
原始问题中提到了一种搜索方式，即 Activity::whereNotNull('title',$search)->orWhere('original_title',$search)->get();。这实际上是针对 搜索条件 的处理，而非创建 派生列。如果您的需求是根据 title 或 original_title 中的任意一个字段来筛选数据，可以使用以下方式：
use App\Models\Activity;
$searchTerm = 'some_keyword';
$activities = Activity::where(function ($query) use ($searchTerm) {
$query->where('title', 'LIKE', '%' . $searchTerm . '%')
->orWhere('original_title', 'LIKE', '%' . $searchTerm . '%');
})->get();这种方法用于在 title 或 original_title 包含特定搜索词的记录。这与创建 coolTitle 派生列的目的不同，但常常是业务需求中与字段合并相关的另一个方面。
注意事项与选择建议
- “空”的定义： 在SQL中，NULL 和空字符串 '' 是不同的。在 DB::raw 中，通常使用 IS NOT NULL AND column != '' 来同时检查这两种情况。在PHP中，empty() 函数可以很好地处理 null、空字符串、0、false 等情况。
- 性能与数据量： 对于小型数据集或派生列不需要用于数据库层面的排序/过滤时，访问器是优雅且足够高效的选择。对于大型数据集，或派生列是核心查询条件时，DB::raw 通常是更好的选择，因为它将计算卸载到数据库。
- 业务复杂性： 如果派生列的逻辑非常复杂，并且涉及多个字段的计算，使用 DB::raw 可以利用数据库的优化能力。如果逻辑相对简单，访问器能保持模型代码的清晰。
- 未来扩展： 考虑未来是否会基于这个派生列进行更复杂的数据库操作。如果会，从一开始就使用 DB::raw 可能会减少后期重构的麻烦。
总结
在Eloquent中创建自定义派生列，我们可以根据具体需求选择 DB::raw 或模型访问器。DB::raw 提供了强大的数据库原生能力，适用于性能敏感和需要数据库层面操作的场景；而模型访问器则提供了更“Eloquent-like”的解决方案，使代码更具可读性和可维护性，适用于主要用于显示或PHP端处理的场景。理解两者的优缺点，将帮助您在开发中做出明智的技术决策。
