drf路由与认证

298 阅读5分钟

路由

以往写路由的方式:

# 正常路由写法:
path('user/', UserView.as_view(),
path('user/<int:pk>/', UserView.as_view()),
     
# 继承了ViewSetMixin及其子类的视图类的路由写法:
path('user/', UserView.as_view({'get': 'list', 'post': 'create'})),
path('user/<int:pk>/', UserView.as_view({'get': 'retrieve', 'put': 'update', 'delete': 'destroy'})),

自动生成路由:

1.自动生成路由的写法
    # 第一步 导入路由模块
    from rest_framework.routers import SimpleRouter, DefaultRouter
    # 第二步 实例化得到对象
    router = SimpleRouter()

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

    urlpatterns = [
        path('admin/', admin.site.urls),
        # 第四步 把注册好的路由添加到urlpatterns中
        # 方式1:
        path('', include(router.urls)),
    ]
    # 方式2:
    urlpatterns += router.urls
2.这种写法的缺点:路由的映射关系定死了
	/books/---> get请求:list方法;post请求:create方法
    /books/---> get请求:retrieve方法;put请求:update方法
    。。。
    如果我们的视图类中有login等方法,不能在这里映射
3.上述缺点可以在视图类的函数上(如login等)加action装饰器解决
	不想加装饰器就必须要写list,destroy,retrieve,create,update五个方法之一
    其实是必须是 5个视图扩展类之一+GenericAPIView  或者 9个视图子类,ModelViewSet
4.SimpleRouter和DefaultRouter的区别
	DefaultRouter比SimpleRouter多一个根路径,显示所有注册过的路由

action装饰器的使用:

在视图函数中 会有些其他名字的方法,这些方法不对应五大请求方式,必须要使用action装饰器做映射。

# action写法
@action(methods=['GET','POST'], detail=True, url_path='login')
def login(self, request,pk):
	pass
# 参数作用:
	# methods:支持的请求方式(大写),列表,支持多个
	# detail:控制生成的路由 是不是带pk
		默认是False:   /user/login/ 
		如果是True:   /user/pk/login 
	# url_path: 控制生成的/user/后的路径是什么,如果不写,默认以方法名命名   /user/login/,一般跟函数名同名即可
	# url_name:别名,用于反向解析

登录接口编写

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
router = SimpleRouter()
router.register('user', views.BookView, 'user')
urlpatterns = [
    path('admin/', admin.site.urls),
    path('', include(router.urls)),
]

认证

需求:登录之后才能访问某些接口
# 通过认证类完成,使用步骤
	1 写一个认证类,继承BaseAuthentication
    2 重写authenticate方法,在内部做认证
    3 如果认证通过,返回2个值,一个是当前登录用户,一个是token
    4 认证不通过抛AuthenticationFailed异常
    5 只要返回了两个值,在后续的request.user 就是当前登录用户
如果想让某个视图类登录之后才能访问
	方式1:局部配置
        class BookView(ModelViewSet):
            authentication_classes = [LoginAuth,]
	方式2:全局配置
    	 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):
    # 重写authenticate方法
    def authenticate(self, request):
        # 在这里做登录认证 能查到该用户并且带了token则登录成功,否则登录失败抛异常
        # 用户带的token从哪取?后端人员定的:放在请求地址中
        token = request.GET.get('token')
        # 查询token表中是否有记录
        user_token = UserToken.objects.filter(token=token)
        if user_token:
            return user_token.user, token  # 返回两个值 一个是用户 一个是token
        else:
            return AuthenticationFailed('您没有登录')

作业

1 登录接口,图书5个接口,出版社5个接口(关联的关系),,使用9个视图子类,5个视图扩展类写
2 图书的必须登录后才能方法,出版社的不登录就能访问
	-全局配置,局部禁用
    
3 研究一下级联删除的其他()
class BookView(ListCreateAPIView):
    # authentication_classes = [LoginAuth]
    queryset = models.Book.objects.all()
    serializer_class = serializer.BookSerializer


class BookDetailView(RetrieveUpdateDestroyAPIView):
    # authentication_classes = [LoginAuth]
    queryset = models.Book.objects.all()
    serializer_class = serializer.BookSerializer


class PublishView(GenericAPIView, ListModelMixin, CreateModelMixin):
    queryset = models.Publish.objects.all()
    serializer_class = serializer.PublishSerializer
    authentication_classes = []

    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, DestroyModelMixin, UpdateModelMixin, RetrieveModelMixin):
    queryset = models.Publish.objects.all()
    serializer_class = serializer.PublishSerializer
    authentication_classes = []

    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)
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(可执行对象)