drf-day06

路由Routers

drf提供两个路由类，只要继承了ViewSetMixin及其子类的视图类，就可以使用这两个视图类来自动生成路由

REST framework提供了两个router

SimpleRouter
DefaultRouter

自动生成路由

使用方法

# 第一步：导入路由类
from rest_framework.routers import SimpleRouter, DefaultRouter

# 第二步：实例化得到对象
router = SimpleRouter()
# router = DefaultRouter()

# 第三步：注册路由（可以注册多个）
# 第一个参数：路径 第二个参数：视图类 第三个参数：别名，可以不写
router.register('books',views.BookView,'books')

# 第四步（两种方式）：把自动生成的路由添加到urlpatterns中
# 方式一：
urlpatterns = [
    ...
]
urlpatterns += router.urls

# 方式二，使用include添加   path('', include(router.urls)),
urlpatterns = [
    ...
    path('', include(router.urls)),
]

自动生成的路由映射关系其实定死了（）
/books/--->get--->list
/books/--->post--->create
/books/1--->get--->retrieve
...

以后写的视图类不需要写action装饰器的话，视图类中必须要有

list，destroy，retrieve，create，update方法之一

其实是必须是 5个视图扩展类之一+GenericAPIView 9个视图子类，ModelViewSet

SimpleRouter和DefaultRouter

DefaultRouter 比 SimpleRouter 多一个根路径，显示所有注册过的路由

action装饰器的使用

class UserView(ViewSet):
    # 在视图函数中，会有一些其它名字的方法，必须要使用action装饰器做映射
    # methods：支持的请求方式，列表
    # detail：默认是False 控制生成的路由是  /user/login/ 还是 /user/pk/login    是不是带pk
    # url_path: 控制生成的/user/后的路径是什么，如果不写，默认以方法名命名   /user/login/，一般跟函数名同名即可
    # url_name：别名，用于反向解析
    @action(methods=['GET','POST'], detail=True, url_path='login')
    def login(self, request,pk):
        return Response('ok')

# 这样写了以后可以：自动生成路由

登录接口编写

models.py

# 用户表
class User(models.Model):
    username = models.CharField(max_length=32)
    password = models.CharField(max_length=32)
    def __str__(self):
        return self.username


# 用户登录记录表
# 如何区分用户是否登录了？
class UserToken(models.Model):
    # SET_NULL   SET_DEFAULT   CASCADE  SET(函数内存地址)
    user = models.OneToOneField(to='User', on_delete=models.CASCADE)
    token = models.CharField(max_length=32, null=True)  # 用户如果没有登录，就是空，如果登录了，就有值，登录多次以最后一次为准

views.py

class UserView(ViewSet):
    # authentication_classes = []
    @action(methods=['POST', ], detail=False, url_path='login')
    def login(self, request):
        # 取出前端传入的用户名密码，校验，通过，返回登录成功，失败就返回用户名密码错误
        username = request.data.get('username')
        password = request.data.get('password')
        user = User.objects.filter(username=username, password=password).first()
        if user:
            # 登录成功,不同人生成的token是不一样的，谁登录的，就把token存到UserToken表中
            token = str(uuid.uuid4())  # 生成一个永不重复的随机字符串
            # 存UserToken:如果没有记录，就是新增，如果有记录更新一下即可
            # 通过user去UserToken表中查数据，如果能查到，使用defaults的数据更新，如果查不到，直接通过user和defaults的数据新增
            UserToken.objects.update_or_create(defaults={'token': token}, user=user)
            return Response({'code': 100, 'msg': '登录成功', 'token': token})
        else:
            return Response({'code': 101, 'msg': '用户名或密码错误'})

urls.py

from rest_framework.routers import SimpleRouter, DefaultRouter

# 实例化得到对象
router = SimpleRouter()

# 注册路由
router.register('user',views.UserView,'user')

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

认证

访问接口，必须登录后才能访问

通过认证类完成：
1. 写一个认证类，继承BaseAuthentication
2. 重写authenticate方法，在内部做认证
3. 如果认证通过，返回2个值
4. 认证不通过抛AuthenticationFailed异常
5. 只要返回了两个值，在后续的request.user 就是当前登录用户
- 如果想让某个视图类登录后才能访问
```
# 方式一：局部配置
class BookView(ModelViewSet):
	authentication_classes = [LoginAuth,]
    
# 方式二：全局配置（settings.py）
REST_FRAMEWORK={
    'DEFAULT_AUTHENTICATION_CLASSES':['app01.auth.LoginAuth',]
}

# 局部禁用：
authentication_classes = []
```

认证类

from .models import UserToken
from rest_framework.authentication import BaseAuthentication
from rest_framework.exceptions import AuthenticationFailed


class LoginAuth(BaseAuthentication):
    def authenticate(self, request):
        # 在这里做认证，校验用户是否登录（带了token，并且能查到，就是登录,返回两个值，否则就是没登录，抛异常）
        # 用户带的token从哪取？后端人员定的：放在请求地址中
        token = request.GET.get('token')
        # 通过token查询该token是否是在表中有记录
        user_token = UserToken.objects.filter(token=token).first()
        if user_token:
            return user_token.user, token  # 返回两个值，一个是当前登录用户，一个是token
        else:
            raise AuthenticationFailed('您没有登录')

作业

1 、2

1 登录接口，图书5个接口，出版社5个接口（关联的关系），使用9个视图子类，5个视图扩展类写
2 图书的必须登录后才能方法，出版社的不登录就能访问
-全局配置，局部禁用

models.py

from django.db import models


class Book(models.Model):
    name = models.CharField(max_length=32)
    price = models.CharField(max_length=32)
    publish = models.ForeignKey(to='Publish', on_delete=models.CASCADE)

    def publish_detail(self):
        return {'name': self.publish.name, 'address': self.publish.addr}


class Publish(models.Model):
    name = models.CharField(max_length=32)
    addr = models.CharField(max_length=32)


class User(models.Model):
    username = models.CharField(max_length=32)
    password = models.CharField(max_length=32)

    def __str__(self):
        return self.username


class UserToken(models.Model):
    user = models.OneToOneField(to='User', on_delete=models.CASCADE)
    token = models.CharField(max_length=32, null=True)

serializer.py

from rest_framework import serializers
from .models import Book, Publish


class BookSerializer(serializers.ModelSerializer):
    class Meta:
        model = Book
        # fields = '__all__'
        fields = ['name', 'price', 'publish', 'publish_detail']


class PublishSerializer(serializers.ModelSerializer):
    class Meta:
        model = Publish
        fields = '__all__'

views.py

import uuid

from django.shortcuts import render
from rest_framework.decorators import action
from rest_framework.generics import GenericAPIView, ListCreateAPIView, RetrieveUpdateDestroyAPIView
from rest_framework.response import Response
from rest_framework.viewsets import ModelViewSet
from rest_framework.mixins import RetrieveModelMixin, CreateModelMixin, UpdateModelMixin, DestroyModelMixin, \
    ListModelMixin

from .auth import LoginAuth
from .models import Book, User, UserToken, Publish
from .serializer import BookSerializer, PublishSerializer

# 5个视图扩展类
# class BookView(ModelViewSet):
#     # authentication_classes = [LoginAuth, ]
#     serializer_class = BookSerializer
#     queryset = Book.objects.all()
#
#     def list(self, request, *args, **kwargs):
#         print(request.user)
#         return super().list(request, *args, **kwargs)

# class BookView(GenericAPIView, ListModelMixin, CreateModelMixin):
#     queryset = Book.objects.all()
#     serializer_class = BookSerializer
#
#     def get(self, request, *args, **kwargs):
#         return self.list(request, *args, **kwargs)
#
#     def post(self, request, *args, **kwargs):
#         return self.create(request, *args, **kwargs)
#
#
# class BookDetailView(GenericAPIView, RetrieveModelMixin, UpdateModelMixin, DestroyModelMixin):
#     queryset = Book.objects.all()
#     serializer_class = BookSerializer
#
#     def get(self, request, *args, **kwargs):
#         return self.retrieve(request, *args, **kwargs)
#
#     def put(self, request, *args, **kwargs):
#         return self.update(request, *args, **kwargs)
#
#     def delete(self, request, *args, **kwargs):
#         return self.destroy(request, *args, **kwargs)
#
#
# class PublishView(GenericAPIView, ListModelMixin, CreateModelMixin):
#     authentication_classes = []
#     queryset = Publish.objects.all()
#     serializer_class = PublishSerializer
#
#     def get(self, request, *args, **kwargs):
#         return self.list(request, *args, **kwargs)
#
#     def post(self, request, *args, **kwargs):
#         return self.create(request, *args, **kwargs)
#
#
# class PublishDetailView(GenericAPIView, RetrieveModelMixin, UpdateModelMixin, DestroyModelMixin):
#     authentication_classes = []
#     queryset = Publish.objects.all()
#     serializer_class = PublishSerializer
#
#     def get(self, request, *args, **kwargs):
#         return self.retrieve(request, *args, **kwargs)
#
#     def put(self, request, *args, **kwargs):
#         return self.update(request, *args, **kwargs)
#
#     def delete(self, request, *args, **kwargs):
#         return self.destroy(request, *args, **kwargs)

# 9个视图子类
class BookView(ListCreateAPIView):
    queryset = Book.objects.all()
    serializer_class = BookSerializer


class BookDetailView(RetrieveUpdateDestroyAPIView):
    queryset = Book.objects.all()
    serializer_class = BookSerializer


class PublishView(ListCreateAPIView):
    authentication_classes = []
    queryset = Publish.objects.all()
    serializer_class = PublishSerializer


class PublishDetailView(RetrieveUpdateDestroyAPIView):
    authentication_classes = []
    queryset = Publish.objects.all()
    serializer_class = PublishSerializer

class UserView(ModelViewSet):
    @action(methods=['POST', ], detail=False, url_path='login')
    def login(self, request):
        username = request.data.get('username')
        password = request.data.get('password')
        user = User.objects.filter(username=username, password=password).first()
        if user:
            token = str(uuid.uuid4())
            UserToken.objects.update_or_create(defaults={'token': token}, user=user)
            return Response({'code': 100, 'msg': '登录成功', 'token': token})
        else:
            return Response({'code': 101, 'msg': '用户名或密码错误'})

auth.py

from rest_framework.authentication import BaseAuthentication
from rest_framework.exceptions import AuthenticationFailed

from app01.models import UserToken


class LoginAuth(BaseAuthentication):
    def authenticate(self, request):
        token = request.GET.get('token')
        user_token = UserToken.objects.filter(token=token).first()
        if user_token:
            return user_token.user, token
        else:
            raise AuthenticationFailed('您没有登录')

urls.py

from django.contrib import admin
from django.urls import path, include
from rest_framework.routers import SimpleRouter, DefaultRouter

from app01 import views

router = SimpleRouter()
router.register('user', views.UserView, 'user')

urlpatterns = [
    path('admin/', admin.site.urls),
    path('', include(router.urls)),
    path('books/', views.BookView.as_view()),
    path('books/<int:pk>', views.BookDetailView.as_view()),
    path('publish/', views.PublishView.as_view()),
    path('publish/<int:pk>', views.PublishDetailView.as_view()),
]

settings.py

REST_FRAMEWORK = {
    'DEFAULT_AUTHENTICATION_CLASSES': ['app01.auth.LoginAuth', ]
}

3 研究一下级联删除的其他

on_delete=None,               # 删除关联表中的数据时,当前表与其关联的field的行为
on_delete=models.CASCADE,     # 删除关联数据,与之关联也删除
on_delete=models.DO_NOTHING,  # 删除关联数据,什么也不做
on_delete=models.PROTECT,     # 删除关联数据,引发错误ProtectedError
# models.ForeignKey('关联表', on_delete=models.SET_NULL, blank=True, null=True)
on_delete=models.SET_NULL,    # 删除关联数据,与之关联的值设置为null（前提FK字段需要设置为可空,一对一同理）
# models.ForeignKey('关联表', on_delete=models.SET_DEFAULT, default='默认值')
on_delete=models.SET_DEFAULT, # 删除关联数据,与之关联的值设置为默认值（前提FK字段需要设置默认值,一对一同理）
on_delete=models.SET,         # 删除关联数据,
 a. 与之关联的值设置为指定值,设置：models.SET(值)
 b. 与之关联的值设置为可执行对象的返回值,设置：models.SET(可执行对象)

posted @ 2022-10-08 19:50 梦想有双休阅读(25) 评论(0) 收藏举报

刷新页面返回顶部

yi-chun