drf路由组件Routers

drf路由组件Routers

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

REST framework提供了两个router

• SimpleRouter
• DefaultRouter

一、使用方法

创建Router对象，并注册视图集

# 导入SimpleRouter与DafaultRouter包
from rest_farmework.routers import SimpleRouter,DafaultRouter

# 实例化对象
simplerouter = SimpleRouter()
defaultrouter = DafaultRouter()

# 路由注册
simplerouter.register('login/',StudentModelViewSet,basename='login')

register(prefix, viewset, base_name)

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

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

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

二、添加路由的两种方式

有两种添加方式

第一种

urlpatterns = [
    ……
]
urlpatterns+=simplerouter.urls

第二种

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

代码演示

# 必须是继承ModelViewSet的视图类才能自动生成路由
from rest_framework.viewsets import ModelViewSet,ReadOnlyModelViewSet
class StudentModelViewSet(ModelViewSet):
    queryset = Student.objects.all()
    serializer_class = StudentModelSerializer
		# 这种方法不会自动生成，需要用action配置
    def login(self,request):
        """学生登录功能"""
        print(self.action)
        return Response({
   "message":"登录成功"})

路由代码

from django.urls import path, re_path
from . import views
urlpatterns = [
    ...
]

"""使用drf提供路由类router给视图集生成路由列表"""
# 实例化路由类
# drf提供一共提供了两个路由类给我们使用,他们用法一致,功能几乎一样
from rest_framework.routers import DefaultRouter
router = DefaultRouter()

# 注册视图集
# router.register("路由前缀",视图集类)
router.register("router_stu",views.StudentModelViewSet)

# 把生成的路由列表追加到urlpatterns
print( router.urls )
urlpatterns += router.urls

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

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

1、自动生成路由的视图类
	-需要继承ViewSetMixin+9个视图子类
    -需要继承ViewSetMixin+视图类+五个视图扩展类

三、视图集中附加action的声明

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

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

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

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

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

• 访问的路径，可以不写，如果不写，以方法名作为路径 通过get请求访问这个路径test/login就能触发login的执行

• url_path:访问的路径可以不写，，如果不写就会以方法名作为路径，通过get请求访问这个路径test/login就能触发函数login的执行

• url_name:别名

# @action(methods=['GET'],detail=False,url_path='login',url_name='login')
@action(methods=['GET']