Laravel 中高效查询 JSON 字段的完整指南

Laravel 中高效查询 JSON 字段的完整指南

laravel 原生支持对 mysql 5.7+、postgresql、sql server 2016 和启用 json1 扩展的 sqlite 等数据库的 json 列进行安全、简洁的查询,推荐使用 `->` 操作符语法(如 `info->id`),避免手动拼接 sql 引发的注入与解析错误。

在 Laravel 中查询 JSON 类型字段(如 orders.info)时,最常见也最易出错的场景是误用原始 SQL(如 whereRaw(‘JSON_EXTRACT(…) = …’))。你遇到的报错:

Column not found: 1054 Unknown column '6112 ' in 'where clause'

根本原因在于:whereRaw() 中直接拼接 $value(未转义)导致 SQL 解析器将数值 6112 错误识别为列名(尤其当 $value 含空格或特殊上下文时),这属于典型的 SQL 注入风险 + 类型解析失败。Laravel 的 -> 语法正是为此类场景设计的安全替代方案。

✅ 正确做法(推荐):

$value = 6;
$order = DB::table('orders')
    ->where('info->id', $value) // 自动参数绑定,类型安全
    ->first();

该写法在底层会生成类似以下的预处理语句(以 MySQL 为例):

SELECT * FROM `orders` WHERE JSON_EXTRACT(`info`, "$.id") = ?

并安全绑定 $value 为参数,彻底规避字符串拼接风险。

? 进阶 JSON 查询能力(Eloquent & Query Builder 均支持):

  • 匹配 JSON 数组中是否存在某值(需数据库支持 JSON 函数):

    // 查找 info->tags 数组中包含 "urgent" 的订单
    $orders = DB::table('orders')
        ->whereJsonContains('info->tags', 'urgent')
        ->get();
  • 匹配 JSON 数组长度

    // 查找 info->items 数组长度恰好为 3 的订单
    $orders = DB::table('orders')
        ->whereJsonLength('info->items', 3)
        ->get();
    
    // 或使用比较操作符
    $orders = DB::table('orders')
        ->whereJsonLength('info->items', '>', 0)
        ->get();

⚠️ 注意事项:

  • whereJsonContains 在 SQLite 中不被支持(除非手动启用 JSON1 扩展且 Laravel 版本 ≥ 8.x);
  • JSON 路径区分大小写(如 info->Id ≠ info->id);
  • MySQL 中若 info->id 对应值为 null 或路径不存在,where(‘info->id’, $value) 将返回 false —— 如需包含 NULL 场景,请显式判断:->whereNull(‘info->id’)->orWhere(‘info->id’, $value);
  • Eloquent 模型中同样适用:Order::where(‘info->id’, $value)->first()。

? 总结:始终优先使用 Laravel 内置的 JSON 查询方法(->、whereJsonContains、whereJsonLength),它们跨数据库兼容、自动参数化、可读性强,且经 Laravel 官方深度测试。放弃手写 JSON_EXTRACT + whereRaw,既是安全升级,也是开发效率提升的关键实践。

https://www.php.cn/faq/2015451.html

发表回复

Your email address will not be published. Required fields are marked *