Laravel中查询JSON数组列：实现whereIn式多条件匹配

本文详细介绍了如何在Laravel中查询包含数组的JSONB列，以实现类似`whereIn`的多值匹配逻辑。针对`JSON_CONTAINS`在查询数组时默认要求所有元素都匹配的问题，文章提出了使用`whereJsonContains`和`orWhereJsonContains`方法组合的解决方案，并通过具体代码示例展示了如何灵活地匹配JSON数组中的任意一个或多个值，提升查询的精确性和效率。

理解JSON数组列查询的挑战

在现代Web应用开发中，将复杂数据结构存储为JSON或JSONB类型列已成为常见实践。例如，一个support_tags列可能存储一个简单的字符串数组，如["caring", "budgets", "careers_employment", "addictions"]。当需要查询这些列时，一个常见的需求是找到那些support_tags中包含给定列表中任意一个标签的服务，而不是要求包含所有标签。

直接使用数据库原生的JSON_CONTAINS函数（或Laravel通过whereRaw调用的方式）配合一个完整的JSON数组进行查询时，往往会遇到不符合预期的结果。例如：

$categories = ["caring", "smoking"];
$services = \App\Models\Service::where("status", "accepted")
    ->whereRaw("JSON_CONTAINS(support_tags, '" . json_encode($categories) . "')")
    ->get();

这段代码的意图是查找support_tags中包含"caring"或"smoking"的服务。然而，JSON_CONTAINS函数在第二个参数是一个JSON数组时，默认行为是检查第一个参数（support_tags）是否完整包含第二个参数（["caring", "smoking"]）作为其子集。这意味着，只有当support_tags同时包含"caring"和"smoking"这两个元素时，记录才会被匹配。这与我们期望的“只要包含其中任意一个就匹配”的whereIn行为大相径庭。

解决方案：利用whereJsonContains和orWhereJsonContains

Laravel Eloquent 提供了专门用于查询JSON列的便捷方法，其中whereJsonContains()和orWhereJsonContains()是解决此类问题的关键。这些方法允许我们以更优雅、更安全的方式查询JSON列中的单个值，并结合Eloquent的查询构建器，实现复杂的逻辑。

基础用法

whereJsonContains('column', 'value')方法用于检查指定JSON列中是否包含某个特定的值。例如，要查找support_tags中包含"caring"的服务：

$services = \App\Models\Service::whereJsonContains('support_tags', 'caring')->get();

实现“任意匹配”逻辑

为了实现类似whereIn的“任意匹配”逻辑，我们需要组合多个whereJsonContains条件，并使用逻辑OR操作符。在Eloquent中，这通常通过在闭包函数中构建查询来实现，以确保OR条件被正确地分组。

假设我们要查找support_tags中包含"smoking"或"caring"的服务，并且这些服务状态为"accepted"，可以这样构建查询：

Find JSON Path Online

Easily find JSON paths within JSON objects using our intuitive Json Path Finder

30

查看详情

$services = \App\Models\Service::where("status", "accepted")
    ->where(function($query) {
        $query->whereJsonContains('support_tags', 'smoking')
              ->orWhereJsonContains('support_tags', 'caring');
    })
    ->get();

代码解析：

1. ->where("status", "accepted"): 这是一个标准的where条件，用于过滤状态为"accepted"的服务。
2. ->where(function($query) { ... }): 这是关键部分。它允许我们创建一个嵌套的查询条件组。在这个闭包内部，所有的条件都会被视为一个整体，并与外部的条件通过AND连接。
3. $query->whereJsonContains('support_tags', 'smoking'): 在闭包内部，第一个条件是检查support_tags是否包含字符串"smoking"。
4. ->orWhereJsonContains('support_tags', 'caring'): 紧接着，使用orWhereJsonContains来添加第二个条件，检查support_tags是否包含字符串"caring"。由于是在同一个闭包内，这两个条件之间是OR关系。

最终，这个查询会返回所有状态为"accepted"，并且其support_tags列中包含"smoking"或"caring"（或两者都包含）的服务。

动态构建多条件查询

如果我们的匹配列表$categories是动态的，我们可以通过循环来构建这些orWhereJsonContains条件：

$categories = ["caring", "smoking", "budgets"]; // 假设这是一个动态的分类列表

$services = \App\Models\Service::where("status", "accepted")
    ->where(function($query) use ($categories) {
        foreach ($categories as $category) {
            $query->orWhereJsonContains('support_tags', $category);
        }
    })
    ->get();

说明：

• 在闭包中使用use ($categories)将外部的$categories变量引入。
• 循环遍历$categories数组，为每个分类动态地添加一个orWhereJsonContains条件。这样，无论$categories中有多少个元素，查询都能正确地匹配其中任意一个。

注意事项与性能考量

1. 数据库兼容性： whereJsonContains方法依赖于底层数据库的JSON函数。MySQL 5.7+、PostgreSQL等现代关系型数据库都支持JSON类型和相关函数。请确保你的数据库版本符合要求。
2. 安全性： 相较于手动拼接SQL的whereRaw，使用whereJsonContains方法更加安全，它会自动处理值的转义，有效防止SQL注入。
3. 性能优化： 对于大型数据集和频繁的JSON列查询，考虑为JSONB列创建索引。在PostgreSQL中，可以使用GIN索引来加速对JSONB内部键值或数组元素的查询。例如：

   CREATE INDEX support_tags_gin_idx ON services USING GIN (support_tags);

   登录后复制

   在MySQL中，可以通过创建虚拟列并为其添加索引来优化。

4. 数据结构： 确保JSON列中的数据结构一致。本教程假设support_tags是一个简单的字符串数组。如果JSON结构更复杂（例如，对象数组），查询方法可能需要调整，例如使用whereJsonContains('column->path', 'value')。

总结

Laravel的whereJsonContains和orWhereJsonContains方法为查询JSON数组列提供了强大而灵活的工具。通过将这些方法与Eloquent的闭包查询功能结合，我们可以轻松实现类似whereIn的多值匹配逻辑，即在JSON数组中查找包含给定列表中任意一个值的记录。这种方法不仅提高了代码的可读性和维护性，还通过Eloquent的抽象层确保了查询的安全性，是处理JSONB数组列查询的推荐实践。

以上就是Laravel中查询JSON数组列：实现whereIn式多条件匹配的详细内容，更多请关注php中文网其它相关文章！