DRF对接Elasticsearch时country[]参数含义及传参失败问题

开发对接Elasticsearch的基础Django检索API时，接口运行会打印请求query_params参数与最终生成的search.query查询体，当前出现传参异常：

• 传入的country参数值'DE'未被正常写入search.query，生成的查询体中terms子句的country字段值为None
• 打印的请求QueryDict显示，实际接收到的参数名为country[]，而非代码中获取参数时使用的country

待解答问题：

1. 为何传入的country参数值'DE'无法正常传递到search.query查询条件中？
2. 请求参数名country[]中的[]具备什么作用，会对参数解析产生什么影响？

相关业务代码 #

class ESNumView(APIView):
    """Obtain number of articles after a search in titles and abstract in ES"""

    def get(self, request, *args, **kwargs):
        query = self.request.query_params.get('query')
        country = self.request.query_params.get('country')

        print(self.request.query_params)

        search = Search(index=constants.ES_INDEX)

        q = Q('bool',
              must=[
                Q('multi_match', query=query, fields=['title', 'abstract']),
                Q('terms', country=country)
              ]
            )
        s = search.query(q)

        pprint(s.to_dict())

        num_count = s.count()

        return Response(data=[{'search_count': num_count}])

接口运行输出 #

<QueryDict: {'query': ['membrane'], 'country[]': ['DE']}>

{'query': {'bool': {'must': [{'multi_match': {'fields': ['title', 'abstract'], 'query': 'membrane'}}, {'terms': {'country': None}}]}}}

1. 参数值无法写入查询条件的原因 #

核心原因是参数名完全不匹配。
Django会把请求里的查询参数按照传入的原始键名存入QueryDict，代码中调用self.request.query_params.get('country')尝试读取名为country的参数，但实际QueryDict里根本不存在这个键——对应参数的原始键名是country[]，get方法找不到匹配键时会默认返回None，最终写入ES terms查询的自然就是None。

2. country[]中[]的作用与解析影响 #

• 这个方括号后缀是跨前后端的约定式写法，最早在PHP生态、jQuery类库中普及，作用是显式标记当前参数为数组类型，支持传递多个同名字段值，比如同时传多个国家筛选值时，请求参数会写成country[]=DE&country[]=US，后端拿到后可以直接解析为国家数组。
• 这种约定不是HTTP协议的强制标准，Django框架本身不会对带[]后缀的参数做特殊适配：它不会自动去掉方括号把参数映射到不带后缀的键名上，只会把country[]作为完整的、独立的字符串键名存储，这也是按country取值拿不到结果的直接原因。

修复方案 #

两种改法二选一即可：

• 后端适配前端传参格式：把取值代码改为读取country[]键即可。由于ES的terms查询本身就支持传入数组做多值匹配，推荐用getlist方法获取所有传入的国家值，兼容多筛选值场景：

  # 替换原有的country取值行
  country = self.request.query_params.getlist('country[]')
  

  如果确定为单值传参，用self.request.query_params.get('country[]')也能拿到'DE'。
• 前端适配后端逻辑：调整前端传参代码，发送请求时不要给country参数加[]后缀，直接传country=DE格式即可。

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