drf路由组件（4星）

目录

• 路由组件（4星）
  • 路由Routers
    • 使用方法
    • 代码演示
    • 重写方法
    • 扩展自己的方法(action装饰器)
  • 总结

路由组件（4星）

路由Routers

对于视图集ViewSet， 我们除了可以自己手动指明请求方式与动作action之间的对应关系外，还可以使用Routers来帮助我们快速实现路由信息。

REST framework提供了两个router

• SimpleRouter(推荐)
• DefaultRouter

DefaultRouter与SimpleRouter的区别是，DefaultRouter会多附带一个默认的API根视图，返回一个包含所有列表视图的超链接响应数据。下面就是DefaultRouter的效果。

使用方法

创建router对象，并注册视图集，例如

from rest_framework.routers import DefaultRouter, SimpleRouter
router = DefaultRouter()
router.register('book', views.BookAPIView, basename='book')

register(prefix, viewset, basename)

• prefix 该视图集的路由前缀
• viewset 视图集(不用加as_view())
• basename 路由别名的前缀

如上述代码会形成的路由如下：

^books/$    name: book-list
^books/{pk}/$   name: book-detail

添加路由数据

可以有两种方式(推荐第一种)

urlpatterns = [
    ...
    url(r'^', include(router.urls))
]

或

urlpatterns = [
    ...
]
urlpatterns += router.urls

代码演示

使用路由类给视图集生成了路由地址

### 视图类必须继承了ViewSetMixin的子类才能使用自动生成路由
from rest_framework.viewsets import ModelViewSet

class BookAPIView(ModelViewSet):
    queryset = Book.objects.all()
    serializer_class = BookModelSerializer

    def login(self, request):
        return Response('登陆')

路由代码:

"""使用drf提供路由类router给视图集生成路由列表"""
# 实例化路由类
# drf提供一共提供了两个路由类给我们使用,他们用法一致,功能几乎一样
from rest_framework.routers import DefaultRouter, SimpleRouter # 随便用一个
router = DefaultRouter()
# 注册视图集
# router.register("路由前缀",视图集类) 别名basename可以省略
router.register('book', views.BookAPIView, basename='book')
# 把生成的路由列表追加到urlpatterns
urlpatterns = [
    path('admin/', admin.site.urls),
    path('', include(router.urls))
]
或
urlpatterns += router.urls

上面的代码就成功生成了路由地址(增删改查一个/查多个)， 但是不会添加我们在视图集自定义方法的路由。

所以我们如果也要给自定义方法生成路由，则需要进行action动作的声明。

重写方法

重写list方法

在视图类中

class BookAPIView(ModelViewSet):
    queryset = Book.objects.all()
    serializer_class = BookModelSerializer

    def list(self, request, *args, **kwargs):
        # 调用父类的方法(不然直接调用self.list()就递归了)
        response = super().list(request, *args, **kwargs)
        # 这里的response.data是之前返回给前端的数据
        res = {'result': response.data, 'msg': '查询成功', 'code': 100}
        return Response(res)

在路由中

from rest_framework.routers import SimpleRouter

router = SimpleRouter()
router.register('book', views.BookAPIView, basename='book')

urlpatterns = [
    path('admin/', admin.site.urls),
    path('', include(router.urls))

扩展自己的方法(action装饰器)

在视图集中，如果想要让Router自动帮助我们为自定义的动作生成路由信息，需要使用rest_framework.decorators.action装饰器。

以action装饰器装饰的方法名会作为action动作名，与list、retrieve等同。

action装饰器可以接收两个参数：

• methods: 声明该action对应的请求方式，列表传递

• detail: 声明该action的路径是否与单一资源对应

  • True 表示路径格式是xxx//action方法名/
  • False 表示路径格式是xxx/action方法名/

  from rest_framework.viewsets import ModelViewSet
  from rest_framework.decorators import action
  class TestAPIView(ModelViewSet):
      queryset = Book.objects.all()
      serializer_class = BookModelSerializer
      # methods 设置当前方法允许哪些http请求访问当前视图方法
      # detail 设置当前视图方法是否是操作一个数据
      # detail为True，表示路径名格式应该为 ^book/(?P<pk>[^/.]+)/login/$
      # 在**kwargs里可以取到pk的值
      @action(methods=['GET', ], detail=False)
      def login(self, request, *args, **kwargs):
          return Response('登陆')
  

  在urls.py中

  from rest_framework.routers import SimpleRouter
  router = SimpleRouter()
  router.register('test', views.TestAPIView, 'test')
  urlpatterns = [
      path('', include(router.urls)),
  ]
  

  • url_path: 把指定数据添加到路径后缀，默认是把函数名添加到路径后缀

    url_path = 'xxx' 那么url为 test/(?P [ ^/. ]+)/xxx/$

  • url_name='xxx' 起别名

  补充（了解），必须继承ViewSetMixin的视图类才有

  视图类有action属性，是当此请求要执行的函数名

总结

1 自动生成路由的视图类，
    -需要继承ViewSetMixin+9个视图字类
    -需要继承ViewSetMixin+视图类（GenericAPIView。。。）+5个视图扩展类
2 可以使用action的视图类，ViewSetMixin+视图类（APIView...）