Django REST Framework对称字段查询优化及单对象返回实现问题

原有get_queryset中的异常捕获逻辑实际不会生效，因为filter()方法无论是否命中数据都会返回QuerySet对象，不会抛出Comparison.DoesNotExist异常，只有get()方法才会触发该异常。对称查询有两种常用优化方案：

方案1：单次OR查询（无需修改存储逻辑） #

用Django的Q对象合并两种对称条件，一次查询即可完成，无需分两次查询：

from django.db.models import Q

# 核心查询逻辑
h1 = self.request.query_params.get("hash1")
h2 = self.request.query_params.get("hash2")
# 可自行补充参数非空校验
comparison = Comparison.objects.filter(Q(hash1=h1, hash2=h2) | Q(hash1=h2, hash2=h1)).first()

方案2：存储前统一哈希顺序（查询效率更高） #

如果可以修改存储逻辑，建议重写模型的save方法，存入前统一两个哈希的顺序（比如按字典序排序），这样查询时也先排序再查，无需OR条件，查询效率更高（可以完全命中hash1+hash2的联合唯一索引）：

models.py修改 #

class Comparison(models.Model):
    result = models.FloatField()
    hash1 = models.CharField(max_length=100)
    hash2 = models.CharField(max_length=100)

    class Meta:
        constraints=[
            models.UniqueConstraint(fields=['hash1','hash2'], name='compared')
        ]
    
    def save(self, *args, **kwargs):
        # 存入前统一哈希顺序，保证hash1永远小于hash2（字典序）
        if self.hash1 > self.hash2:
            self.hash1, self.hash2 = self.hash2, self.hash1
        super().save(*args, **kwargs)

查询逻辑简化 #

h1 = self.request.query_params.get("hash1")
h2 = self.request.query_params.get("hash2")
# 先对传入的两个哈希排序
sorted_h = sorted([h1, h2])
comparison = Comparison.objects.filter(hash1=sorted_h[0], hash2=sorted_h[1]).first()

原有写法报错的原因是：get_queryset要求返回可迭代的QuerySet对象，直接返回单个模型实例会导致视图默认的列表序列化逻辑报错。可以通过两种方式实现单对象返回：

方案1：重写list方法 #

如果需要保留原有的ModelViewSet标准接口，同时支持传哈希参数返回单对象：

from rest_framework.response import Response
from rest_framework import status
from django.db.models import Q

class ComparisonView(viewsets.ModelViewSet):  
    serializer_class = ComparisonSerializer   
    queryset = Comparison.objects.all()  

    def list(self, request, *args, **kwargs):
        h1 = request.query_params.get("hash1")
        h2 = request.query_params.get("hash2")
        # 只有同时传了两个哈希参数时才返回单对象
        if h1 and h2:
            comparison = self.queryset.filter(Q(hash1=h1, hash2=h2) | Q(hash1=h2, hash2=h1)).first()
            if not comparison:
                return Response({"detail": "比对结果不存在"}, status=status.HTTP_404_NOT_FOUND)
            serializer = self.get_serializer(comparison)
            return Response(serializer.data)
        # 不传参数走默认的列表返回逻辑
        return super().list(request, *args, **kwargs)

方案2：自定义独立接口（更符合REST规范） #

如果不需要默认的列表查询接口，建议自定义一个专用的action，接口语义更清晰：

from rest_framework.decorators import action
from rest_framework.response import Response
from rest_framework import status
from django.db.models import Q

class ComparisonView(viewsets.ModelViewSet):  
    serializer_class = ComparisonSerializer   
    queryset = Comparison.objects.all()  

    @action(methods=["get"], detail=False, url_path="get-result")
    def get_result(self, request):
        h1 = request.query_params.get("hash1")
        h2 = request.query_params.get("hash2")
        if not h1 or not h2:
            return Response({"detail": "缺少hash1或hash2参数"}, status=status.HTTP_400_BAD_REQUEST)
        comparison = self.queryset.filter(Q(hash1=h1, hash2=h2) | Q(hash1=h2, hash2=h1)).first()
        if not comparison:
            return Response({"detail": "比对结果不存在"}, status=status.HTTP_404_NOT_FOUND)
        return Response(self.get_serializer(comparison).data)

该接口的访问路径为视图根路径加上get-result/，例如/api/comparison/get-result?hash1=xxx&hash2=xxx，直接返回单对象结构。

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