drf路由组件

发表于 2018-07-05 更新于 2022-05-01 分类于 Python之路， Django ， DRF 本文字数： 6.2k 阅读时长 ≈ 6 分钟

一路由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')

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

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

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

2）添加路由数据

可以有两种方式：

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

或

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

1.2 代码演示

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

# 必须是继承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.2 视图集中附加action的声明

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

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

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

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

: 声明该action的路径是否与单一资源对应，及是否是
1
xxx/<pk>/action方法名/
- True 表示路径格式是xxx/<pk>/action方法名/
- False 表示路径格式是xxx/action方法名/

举例：

from rest_framework.viewsets import ModelViewSet
from rest_framework.decorators import action

class StudentModelViewSet(ModelViewSet):
    queryset = Student.objects.all()
    serializer_class = StudentModelSerializer

    # methods 设置当前方法允许哪些http请求访问当前视图方法
    # detail 设置当前视图方法是否是操作一个数据
    # detail为True，表示路径名格式应该为 router_stu/{pk}/login/
    @action(methods=['get'], detail=False)
    def login(self, request):
        return Response({'msg':'登陆成功'})

    @action(methods=['put'], detail=True)
    def get_new_5(self, request,pk):
        return Response({'msg':'获取5条数据成功'})

由路由器自动为此视图集自定义action方法形成的路由会是如下内容：

1 2	^router_stu/get_new_5/$ name: router_stu-get_new_5 ^router_stu/{pk}/login/$ name: router_stu-login

1.3 路由router形成URL的方式

1） SimpleRouter

SimpleRouter

2）DefaultRouter

DefaultRouter

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

扩展

0 books和publish5个接口，自动生成路由
1 写登录功能，使用action映射
2 写一个认证类，保证books的所有接口，必须认证通过才能访问
	-访问时，token不放在请求地址中，放在请求头中
3 写一个权限类，publish的所有接口，必须超级用户才能访问


# 部分人
4 权限user_type使用choice，返回的提示信息，自定制
5 把认证类源码过一遍
6 权限类源码看一看

0.books和publish5个接口，自动生成路由

# models.py
class Book(models.Model):
    name=models.CharField(max_length=32)
    price=models.IntegerField()
    publish=models.ForeignKey(to='Publish',on_delete=models.CASCADE)
    authors=models.ManyToManyField(to='Author',null=True)
    def __str__(self):
        return self.name

    def publish_name(self):
        return self.publish.name

class Publish(models.Model):
    name=models.CharField(max_length=32)
    addr=models.CharField(max_length=32)
    def __str__(self):
        return self.name
 
# sers.py
class BookSerializer(ModelSerializer):
    class Meta:
        model=Book
        fields='__all__'
        extra_kwargs = {"publish": {'write_only': True},"authors": {'write_only': True}}
    publish_name=serializers.CharField(source='publish',read_only=True)
    authors_name=SerializerMethodField(source='authors')


    def get_authors_name(self,obj):
        tmp = []
        for author in obj.authors.all():
            tmp.append(author.name)
        return tmp

class PublishSerializer(ModelSerializer):
    class Meta:
        model=Publish
        fields='__all__'
        
# views.py
class BookView(ModelViewSet):
    queryset = models.Book.objects.all()
    serializer_class = BookSerializer
    
class PublishView(ModelViewSet):
    queryset = models.Publish.objects.all()
    serializer_class = PublishSerializer
    
# urls.py
router.register('books',views.BookView,'books')
router.register('publish',views.PublishView,'publish')

path('',include(router.urls)),

1 写登录功能，使用action映射

# urls.py
router.register('',views.LoginView,'login')

# views.py
class LoginView(ViewSet):
    @action(methods=['POST'], detail=False)
    def login(self, request, *args, **kwargs):
        username = request.data.get('username')
        password = request.data.get('password')
        user = models.User.objects.filter(username=username, password=password).first()
        if user:
            token = str(uuid.uuid4())
            models.UserToken.objects.update_or_create(defaults={'token': token}, user=user)
            return APIResponse(msg='登录成功', token=token)
        else:
            return APIResponse(msg='用户名或者密码错误', code=101)

2.写一个认证类，保证books的所有接口，必须认证通过才能访问
-访问时，token不放在请求地址中，放在请求头中

# 认证类
class LoginAuth(BaseAuthentication):
    def authenticate(self, request):
        token = request.META.get('HTTP_TOKEN')
        user_token = models.UserToken.objects.filter(token=token).first()
        if user_token:
            user = user_token.user
            return user, user_token
        else:
            raise AuthenticationFailed('您没有登录，认证失败')


from rest_framework.permissions import BasePermission


# 视图类中配置
authentication_classes = [LoginAuth,]

3 写一个权限类，publish的所有接口，必须超级用户才能访问

# 权限类
class UserPermission(BasePermission):
    message = '您没有管理员权限'
    def has_permission(self, request, view):
        if request.user.get_user_type_display() == '超级用户':
            return True
        else:
            return False
          
# 视图类中配置
permission_classes = [UserPermission,]

4 权限user_type使用choice，返回的提示信息，自定制

# models.py
user_type=models.IntegerField(choices=((0,'超级用户'),(1,'普通用户')))

# 权限类自定制信息配置
# 只要在权限类中定义message即可
class UserPermission(BasePermission):
    message = '您没有管理员权限'
    def has_permission(self, request, view):
        if request.user.get_user_type_display() == '超级用户':
            return True
        else:
            return False

一 路由Routers

1.1 使用方法

1.2 代码演示

1.2 视图集中附加action的声明

1.3 路由router形成URL的方式

扩展

一路由Routers