Django中如何注解JSONField将所有值转为字符串以实现搜索高亮

问题根源在于Django的SearchHeadline处理JSONField时，仅会对原生字符串类型的字段值应用高亮逻辑，而JSON中的数值、null等非字符串类型无法被字符串形式的搜索查询匹配高亮。要解决这个问题，需要先将JSON内的所有值转换为字符串类型，再基于转换后的字段执行搜索和高亮。

方案一：保持JSON结构的元素级高亮（推荐） #

这个方案会递归遍历JSON结构，将所有非字符串值转为字符串，同时保留原JSON的数组/对象结构，实现精准的元素高亮。

1. 在PostgreSQL中创建自定义转换函数 #

执行以下SQL语句，创建一个递归处理JSON的PL/pgSQL函数：

CREATE OR REPLACE FUNCTION json_cast_all_to_text(json_val jsonb)
RETURNS jsonb AS $$
BEGIN
    RETURN (
        SELECT jsonb_agg(
            CASE
                WHEN jsonb_typeof(elem) = 'array' THEN json_cast_all_to_text(elem)
                WHEN jsonb_typeof(elem) = 'object' THEN json_cast_all_to_text(elem)
                WHEN jsonb_typeof(elem) IN ('number', 'boolean', 'null') THEN to_jsonb(elem::text)
                ELSE elem
            END
        )
        FROM jsonb_array_elements(json_val) AS elem
    );
END;
$$ LANGUAGE plpgsql IMMUTABLE;

该函数会把JSON中的数值、布尔、null类型全部转为字符串类型的JSON值，递归处理嵌套的数组和对象。

2. 在Django中定义对应的Func类 #

在你的Django项目中（比如模型文件或单独的工具模块），定义调用上述SQL函数的Func子类：

from django.db.models import Func
from django.contrib.postgres.fields import JSONField

class JsonCastAllToText(Func):
    function = 'json_cast_all_to_text'
    output_field = JSONField()

3. 修改搜索查询代码 #

基于转换后的字段构建搜索向量和高亮注解：

from django.contrib.postgres.search import SearchVector, SearchQuery, SearchHeadline

# 假设query是用户输入的搜索关键词
search_query = SearchQuery(query)
search_vector = SearchVector(JsonCastAllToText('data'))
search_headline_data = SearchHeadline(JsonCastAllToText('data'), search_query, highlight_all=True)

results = Row.objects.all()
    .annotate(search=search_vector)
    .annotate(headline_data=search_headline_data)

处理后，搜索"87"会得到带高亮的JSON结果：

[["A1", "<b>87</b>", "987", "blue"], ["B1", "null", "null", "white"]]

方案二：快速转为文本（适合无需保留JSON结构的场景） #

如果不需要保留原JSON结构，仅需要高亮匹配内容，可以直接将整个JSON字段转为文本：

from django.db.models import Func
from django.contrib.postgres.search import SearchVector, SearchQuery, SearchHeadline

class JsonToText(Func):
    function = 'CAST'
    template = '%(function)s(%(expressions)s AS TEXT)'

search_vector = SearchVector(JsonToText('data'))
search_query = SearchQuery(query)
search_headline_data = SearchHeadline(JsonToText('data'), search_query, highlight_all=True)

results = Row.objects.all()
    .annotate(search=search_vector)
    .annotate(headline_data=search_headline_data)

这种方式的高亮结果是纯文本形式，例如：

[["A1", <b>87</b>, 987, "blue"], ["B1", null, null, "white"]]

内容的提问来源于stack exchange，提问作者Mathieu Dhondt