drf-路由组件

目录：

 

1 路由Routers

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

REST framework提供了两个router

• SimpleRouter
• DefaultRouter

1.1 使用方法

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

from rest_framework import routers

router = routers.SimpleRouter()
router.register(r'router_stu', StudentModelViewSet, base_name='student')

register(prefix, viewset, base_name)

• prefix 该视图集的路由前缀
• viewset 视图集
• base_name 路由别名的前缀

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

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

2）添加路由数据

可以有两种方式：

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

或者

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

1.2 代码演示

views.py

from django.shortcuts import render
from  rest_framework.viewsets import ModelViewSet
from app01.models import Book
from app01.serializers import BookSerializer

# Create your views here.
class BookViewSet(ModelViewSet):
    queryset = Book.objects.all()
    serializer_class = BookSerializer

urls.py

from django.contrib import admin
from django.urls import path, re_path
from app01 import views

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

# 第一步：导入routers模块
from rest_framework import routers

# 第二步：有两个类,实例化得到对象
# routers.DefaultRouter 生成的路由更多
# routers.SimpleRouter
router = routers.SimpleRouter()
# 第三步：注册
# router.register('路由前缀','继承自ModelViewSet视图类','别名')
router.register('books', views.BookViewSet)  # 不要加斜杠了

# 第四步
# router.urls # 自动生成的路由,加入到原路由中
# print(router.urls)
# urlpatterns+=router.urls
'''
[
, 
[^/.]+)/$'[name='book-detail']>
]

'''
urlpatterns += router.urls

'''
两个类路由区别：
SimpleRouter
, 
[^/.]+)/$'[name='book-detail']>


DefaultRouter
^books/$ [name='book-list']
^books/(?P[^/.]+)/$ [name='book-detail']  这两条跟simple一样

^$ [name='api-root']  根，根路径会显示出所有可以访问的地址
^\.(?P[a-z0-9]+)/?$ [name='api-root']


^books\.(?P[a-z0-9]+)/?$ [name='book-list']  http://127.0.0.1:8000/books.json
^books/(?P[^/.]+)\.(?P[a-z0-9]+)/?$ [name='book-detail']  http://127.0.0.1:8000/books/1.json


'''

上面的代码就成功生成了路由地址[增/删/改/查一条/查多条的功能]，但是不会自动我们在视图集自定义方法的路由。

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

1.3 视图集中附加action的声明

action是为了给继承自ModelViewSet的视图类中定义的函数也添加路由

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

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

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

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

• detail

  : 声明该action的路径是否与单一资源对应，及是，不是

xxx//action方法名/

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

举例：

# 使用
from rest_framework.decorators import action  # 装饰器

class BookViewSet(ModelViewSet):
    queryset =Book.objects.all()
    serializer_class = BookSerializer
    # methods第一个参数，传一个列表，列表中放请求方式，
    # ^books/get_1/$ [name='book-get-1'] 当向这个地址发送get请求，会执行下面的函数
    # detail：布尔类型 如果是True
    #^books/(?P[^/.]+)/get_1/$ [name='book-get-1']
    @action(methods=['GET','POST'],detail=True)
    def get_1(self,request,pk):
        print(pk)
        book=self.get_queryset()[:2]  # 从0开始截取一条
        ser=self.get_serializer(book,many=True)
        return Response(ser.data)
    
# 装饰器，放在被装饰的函数上方，method：请求方式，detail：是否带pk

1.4 路由router形成URL的方式

1） SimpleRouter

 

 2）DefaultRouter

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

 

总结drf路由书写的三种方式

# 路由 3种写法  
    -django传统的路由（cvb路由）path('test/', views.TestView.as_view()),
    -只要继承ViewSetMixin：path('books/', views.BookViewSet.as_view(actions={'get':'list','post':'create'})),
    -使用路由组件自动生成路由
        -SimpleRouter
        -DefaultRouter
        -使用：
            # 第一步：导入routers模块
            from rest_framework import routers
            # 第二步：有两个类,实例化得到对象
            # routers.DefaultRouter 生成的路由更多
            # routers.SimpleRouter
            router=routers.SimpleRouter()
            # 第三步：注册
            # router.register('前缀','继承自ModelViewSet视图类','别名')
            router.register('books',views.BookViewSet) # 不要加斜杠了
            urlpatterns+=router.urls
# action装饰器的使用：装饰器给继承了ModeViewSet的视图类中自定义的方法，自动生成路由
# action装饰器参数method=['get','post'],detail=True(带pk的)/False（不带pk）