REST framework @action 装饰器_django action装饰器-优快云博客

本文链接：https://blog.youkuaiyun.com/qq_75046142/article/details/140243417

在 Django REST framework 中，@action 装饰器用于将 ViewSet 方法标记为可路由操作。通过使用 @action 装饰器，可以定义复杂的业务逻辑，并将其映射到特定的 HTTP 方法上。

首先我们为什么要使用 @action 装饰器：

定义自定义动作：@action
装饰器用于在视图集中（ViewSet）定义自定义的动作或操作，并将其绑定到视图集中。这样可以实现一些特定的功能，丰富API的功能。
路由映射：@action
装饰器将方法标记为可路由操作，使其能够被路由器（Router）识别并生成相应的路由信息。这对于创建自定义端点非常有用。
灵活的HTTP方法支持：通过 methods
参数，可以指定该操作响应的HTTP方法名称列表，默认为GET请求。这使得开发者可以根据需要灵活地定义不同类型的请求方法。
细节控制：@action 装饰器还允许通过 detail
参数来确定该操作是否适用于实例或细节视图。例如，某些操作可能只适用于单个实例，而不需要关注整个集合。
额外参数：@action 装饰器还可以接收其他关键字参数，以进一步自定义操作的行为和响应。
使用 @action 装饰器可以方便地在视图集中添加自定义动作，增强API的功能性和灵活性，同时确保这些动作能够被路由器正确识别和处理。

以下是如何使用 @action 装饰器来定义复杂业务逻辑的详细步骤：

确保已经安装了 Django 和 Django REST Framework。可以通过运行以下命令来安装它们：

   pip install django djangorestframework

如果还没有项目，可以创建一个新的项目：

django-admin startproject myproject

在 myproject/urls.py 文件中，添加对 ViewSet 的 URL 路径。例如：

 from django.urls  import path, include
   from rest_framework.routers  import DefaultRouter
   from .views import MyViewSet

   router = DefaultRouter()
   router.register (r'myviewset', MyViewSet)

   urlpatterns = [
       path('', include(router.urls )),
   ]

在 myproject/views.py 文件中，定义一个 ViewSet，并使用 @action 装饰器来定义自定义方法。例如：

from rest_framework import viewsets, status
   from rest_framework.response  import Response
   from .serializers import MySerializer

   class MyViewSet(viewsets.ModelViewSet):
       queryset = MyModel.objects.all ()
       serializer_class = MySerializer

       @action(methods=['post'], detail=True)
       def custom post action(self, request, *args,**kwargs):
           # 自定义业务逻辑
           data = request.data 
           # 进行一些操作
           result = some_operation(data)
           return Response(result, status=status.HTTP_200_OK)

       @action(methods=['get'], detail=False)
       def list行动(self, request, *args,**kwargs):
           # 另一种自定义业务逻辑
           results = MyModel.objects.filter 的一些条件()
           serializer = self.get _serializer(results, many=True)
           return Response(serializer.data )

@action 装饰器还可以接受额外的参数，这些参数将仅用于该路由视图。例如，可以指定序列化器类：

 @action(methods=['post'], detail=True, serializer_class=FollowSerializer)
   def follow_action(self, request, *args,**kwargs):
       # 自定义业务逻辑
       user = request.user 
       followee = request.data.get ('followee')
       # 进行一些操作
       follow关系 = Follow.objects.create (user=user, followee=followee)
       return Response({'message': 'Follow successful'}.status=status.HTTP_201_CREATED)

这样，可以根据不同的请求方法和参数来执行不同的业务逻辑。

通过以上步骤，你可以在 Django REST framework 中使用 @action 装饰器来定义复杂的业务逻辑，并将其映射到特定的 HTTP 方法上。这样可以使得代码更加模块化和易于维护。

在使用 @action 装饰器之前，开发者可能会遇到以下问题：

未安装必要的库：有些情况下，开发者可能会因为没有正确安装或配置相关库而导致 @action 装饰器无法正常工作。
URL 路径问题：在自定义动作中设置 URL 路径时，可能会遇到路径未解析的问题。例如，当使用 @action
装饰器定义自定义方法时，URL 路径可能不会正确生成。
方法不允许：在某些情况下，特定的方法（如 DELETE 方法）可能不被允许使用 @action
装饰器。这可能是由于默认路由器的限制或其他配置问题。
参数传递问题：在使用 @action 装饰器时，传递给装饰器的参数可能不会正确传递到视图函数中。这可能导致功能实现不符合预期。
动态路由问题：在设置动态路由时，@action 装饰器可能无法正确处理参数和路由的映射。

这些问题通常需要通过检查项目的依赖关系、确保正确的 URL 配置以及适当处理方法权限来解决。