使用多个关键字对象引用的 Django Rest Framework 对象

Question

我有一个对两个字段有唯一约束的模型：

class Document(models.Model):
    filename = models.CharField(max_length=255)
    publication = models.CharField(max_length=8)

    class Meta:
        constraints = [
                models.UniqueConstraint(
                    fields=['filename', 'publication'], name='document_key')

根据DRF GenericAPIView get_object 方法中的文档：

    """
    Returns the object the view is displaying.
    You may want to override this if you need to provide non-standard
    queryset lookups.  Eg if objects are referenced using multiple
    keyword arguments in the url conf.
    """

使用多个关键字参数进行引用正是我想要做的。 我已经开始覆盖 get_object 方法

class DocumentViewset(viewsets.ModelViewSet):
    serializer_class = serializers.ActSerializer 
    lookup_fields = ('filename', 'publication')

    def get_object(self):
        """As per the example in the DRF docstring itself,
        objects are referenced using multiple keyword arguments
        in the URL conf. Therefore, we need to override. 
        """
        queryset = self.filter_queryset(self.get_queryset())
        lookup_url_kwargs = self.lookup_fields

        print(lookup_url_kwargs)
        print(self.kwargs)

这给了我：

('filename', 'publication')
{'pk': '17'}

您可以看到问题是我的 lookup_url_kwargs 不会在 self.kwargs 中（在下一行进行了验证）。 如果设置了 'lookup_url_kwarg'，那么 self.kwargs 就是那个。 但是没有它，self.kwargs 默认为 'pk'。 如何覆盖此行为以便在 URL 中需要两个字段？？ 谢谢你。

)

Answer 1

有几种方法可以获得所需的行为，复杂性依次增加：

---

第一种方式：

不要像往常一样使用 DRF 路由器并手动定义 URL 端点。 此外，请参考正确的映射，例如使用 URL 关键字参数filename 、 publication的详细 URL：

urlpatterns = [
    path(
        'documents/<filename:str>/<publication:str>/',
        DocumentViewset.as_view({'get': 'retrieve'}),
        name='document-detail',
    ),
    ...
]

现在，您将在retrieve方法中的self.kwargs retrieve具有相应值的filename和publication键。

您可以添加路径转换器以更好地控制每个 URL 关键字匹配所允许的模式。 例如，如果您用-而不是/ （因为/通常表示子资源）分隔它们，您的 URL 在逻辑上可能会更好看。 在这里，我们创建了两个转换器来获取破折号 ( - ) 前后的部分：

class BaseDashConverter:  
    def to_python(self, value):
        return value

    def to_url(self, value):
        return value

class BeforeDashConverter(BaseDashConverter):
    regex = '[^-]+'

class AfterDashConverter(BaseDashConverter):
    regex = '[^/]+'

现在，是时候注册这两个了：

register_converter(BeforeDashConverter, 'before-dash')
register_converter(AfterDashConverter, 'after-dash')

然后在urlpatterns ，您可以执行以下操作：

urlpatterns = [
    path(
        'documents/<filename:before-dash>-<publication:after-dash>/',
        DocumentViewset.as_view({'get': 'retrieve'}),
        name='document-detail',
    ),
    ...
]

您还可以直接将re_path与 Regex 一起使用，而不是创建转换器并使用path ：

urlpatterns = [
    re_path(
        'documents/(?P<filename>[^-]+)-(?P<publication>[^/]+)/',
        DocumentViewset.as_view({'get': 'retrieve'}),
        name='document-detail',
    ),
    ...
]

FWIW，您需要为所有方法-操作映射添加 URL 路径，就像我为get - retrieve所做的那样。

---

第二种方式：

假设lookup_fields是您的自定义属性（视图集实际上使用由属性lookup_field引用的单个字段），您可以将lookup_kwargs为类似combined名称，并在 URL 中使用filename和publication -作为/documents/<filename>-<publication>/例如/documents/somename-foobar/ 。 DRF Router的详细信息查找匹配一个或多个字符，除了. 和/在前缀之后，所以这将被匹配。

如果这样做，则在get_object您可以添加自定义逻辑，例如：

class DocumentViewset(viewsets.ModelViewSet):
    serializer_class = serializers.ActSerializer 

    lookup_fields = ('filename', 'publication')
    lookup_url_kwarg = 'combined'

    def get_object(self):
        queryset = self.filter_queryset(self.get_queryset())

        lookup_url_kwarg = self.lookup_url_kwarg

        assert lookup_url_kwarg in self.kwargs, (
            'Expected view %s to be called with a URL keyword argument '
            'named "%s". Fix your URL conf, or set the `.lookup_field` '
            'attribute on the view correctly.' %
            (self.__class__.__name__, lookup_url_kwarg)
        )

        combined = self.kwargs[lookup_url_kwarg]
        filter_kwargs = dict(zip(self.lookup_fields, combined.partition('-')[::2]))
        obj = get_object_or_404(queryset, **filter_kwargs)

        self.check_object_permissions(self.request, obj)

        return obj

---

第三种方式：

覆盖 DRF 的Router并在get_lookup_regex方法中添加自定义 Regex 以匹配 URL 路径，包括filename和publication 。

以下是一个示例，与前面的方法一样，它将匹配/documents/<filename>-<publication>/ （例如/documents/somename-foobar/ ）形式的任何模式，但现在 URL 关键字参数将有两个键： filename和publication 。 您可以根据自己的喜好更改模式/格式。

首先，我们需要使用重写的get_lookup_regex定义自定义路由器：

from rest_framework.routers import DefaultRouter

class CustomRouter(DefaultRouter):
    def get_lookup_regex(self, viewset, lookup_prefix=''):
        lookup_fields = getattr(viewset, 'lookup_fields', ('filename', 'publication'))
        lookup_url_kwargs = getattr(viewset, 'lookup_url_kwargs', lookup_fields)
        return (
            rf'(?P<{lookup_prefix}{lookup_url_kwargs[0]}>[^-]+)-'
            rf'(?P<{lookup_prefix}{lookup_url_kwargs[1]}>[^/.]+)'
        )

因此，这将检查ViewSet类中的lookup_fields和lookup_url_kwargs以根据匹配的模式设置 Regex 关键字。

注册视图集将像往常一样：

router = CustomRouter()
router.register('documents', DocumentViewSet)

利用上述路由器的DocumentViewset可以像下面这样，覆盖了get_queryset和lookup_fields / lookup_url_kwargs集：

class DocumentViewset(viewsets.ModelViewSet):
    serializer_class = serializers.ActSerializer 

    lookup_fields = ('filename', 'publication')
    lookup_url_kwargs = ('filename', 'publication')

    def get_object(self):
        queryset = self.filter_queryset(self.get_queryset())

        lookup_url_kwargs = self.lookup_url_kwargs or self.lookup_fields

        assert all(
            lookup_kwarg in self.kwargs
            for lookup_kwarg in lookup_url_kwargs
        ), (
            'Expected view %s to be called with URL keyword arguments '
            'named "%s". Fix your URL conf, or set the `.lookup_fields` '
            'attribute on the view correctly.' %
            (self.__class__.__name__, ','.join(lookup_url_kwargs))
        )

        field_values = (self.kwargs[lookup_kwarg] for lookup_kwarg in lookup_url_kwargs)
        filter_kwargs = dict(zip(self.lookup_fields, field_values))
        obj = get_object_or_404(queryset, **filter_kwargs)

        # May raise a permission denied
        self.check_object_permissions(self.request, obj)

        return obj

---

以上每一项都会让您获得所需的行为。 选择最适合您的那一款。

注意：使用-作为示例中的分隔符，您可以选择自己的分隔符。 但是如果你想使用/或. 作为分隔符，您需要使用第一种或第三种方式，因为第二种方式使用DefaultRouter.get_lookup_regex在其中模式被数学计算到下一个/或. .