基于rest_framework的ModelViewSet类编写登录视图和认证视图

斗战胜魔

背景：看了博主一抹浅笑的rest_framework认证模板，发现登录视图函数是基于APIView类封装。
优化：使用ModelViewSet类通过重写create方法编写登录函数。
环境：既然接触到rest_framework的使用，相信已经搭建好相关环境了。
1 建立模型

编写模型类

1. # models.py
2. from django.db import models
3. class User(models.Model):
4.     username = models.CharField(verbose_name='用户名称',unique=True,max_length=16)
5.     password = models.CharField(verbose_name='登陆密码',max_length=16)
6. class Token(models.Model):
7.     username = models.CharField(verbose_name='用户名称',unique=True,max_length=16)
8.     token = models.CharField(verbose_name='验证密钥',max_length=32)

复制代码

生成迁移文件

1. python manage.py makemigrations

复制代码

迁移数据模型

1. python manage.py migrate

复制代码

2 确定需要重写的方法

查看ModelViewSet类源码

1. '''
2. class ModelViewSet(mixins.CreateModelMixin,
3.                    mixins.RetrieveModelMixin,
4.                    mixins.UpdateModelMixin,
5.                    mixins.DestroyModelMixin,
6.                    mixins.ListModelMixin,
7.                    GenericViewSet):
8.     """
9.     A viewset that provides default `create()`, `retrieve()`, `update()`,
10.     `partial_update()`, `destroy()` and `list()` actions.
11.     """
12.     pass
13. '''

复制代码

最终目的是往Token模型对应的表添加数据，所以得选择CreateModelMixin模型的源码查看。

1. '''
2. class CreateModelMixin:
3.     """
4.     Create a model instance.
5.     """
6.     def create(self, request, *args, **kwargs):
7.         serializer = self.get_serializer(data=request.data)
8.         serializer.is_valid(raise_exception=True)
9.         self.perform_create(serializer)
10.         headers = self.get_success_headers(serializer.data)
11.         return Response(serializer.data, status=status.HTTP_201_CREATED, headers=headers)
13.     def perform_create(self, serializer):
14.         serializer.save()
16.     def get_success_headers(self, data):
17.         try:
18.             return {'Location': str(data[api_settings.URL_FIELD_NAME])}
19.         except (TypeError, KeyError):
20.             return {}
21. '''

复制代码

查看得知，CreateModelMixin类下的create方法调用了serializer类的save方法创建数据。继续查看save方法。
通过serializers.ModelSerializer定位到serializers.py文件，搜索'def save('定位到以下内容。

1. '''
2.     def save(self, **kwargs):
3.         assert hasattr(self, '_errors'), (
4.             'You must call `.is_valid()` before calling `.save()`.'
5.         )
7.         assert not self.errors, (
8.             'You cannot call `.save()` on a serializer with invalid data.'
9.         )
11.         # Guard against incorrect use of `serializer.save(commit=False)`
12.         assert 'commit' not in kwargs, (
13.             "'commit' is not a valid keyword argument to the 'save()' method. "
14.             "If you need to access data before committing to the database then "
15.             "inspect 'serializer.validated_data' instead. "
16.             "You can also pass additional keyword arguments to 'save()' if you "
17.             "need to set extra attributes on the saved model instance. "
18.             "For example: 'serializer.save(owner=request.user)'.'"
19.         )
21.         assert not hasattr(self, '_data'), (
22.             "You cannot call `.save()` after accessing `serializer.data`."
23.             "If you need to access data before committing to the database then "
24.             "inspect 'serializer.validated_data' instead. "
25.         )
27.         validated_data = {**self.validated_data, **kwargs}
29.         if self.instance is not None:
30.             self.instance = self.update(self.instance, validated_data)
31.             assert self.instance is not None, (
32.                 '`update()` did not return an object instance.'
33.             )
34.         else:
35.             self.instance = self.create(validated_data)
36.             assert self.instance is not None, (
37.                 '`create()` did not return an object instance.'
38.             )
39. '''

复制代码

看最后这个if……else……语句中的self.instance = self.create(validated_data)。
说明这里调用了create方法，返回一个模型对象。于是查看ModelSerializer类的create方法。

1. '''
2.     def create(self, validated_data):
3.         """
4.         We have a bit of extra checking around this in order to provide
5.         descriptive messages when something goes wrong, but this method is
6.         essentially just:
8.             return ExampleModel.objects.create(**validated_data)
10.         If there are many to many fields present on the instance then they
11.         cannot be set until the model is instantiated, in which case the
12.         implementation is like so:
14.             example_relationship = validated_data.pop('example_relationship')
15.             instance = ExampleModel.objects.create(**validated_data)
16.             instance.example_relationship = example_relationship
17.             return instance
19.         The default implementation also does not handle nested relationships.
20.         If you want to support writable nested relationships you'll need
21.         to write an explicit `.create()` method.
22.         """
23.         raise_errors_on_nested_writes('create', self, validated_data)
25.         ModelClass = self.Meta.model
27.         # Remove many-to-many relationships from validated_data.
28.         # They are not valid arguments to the default `.create()` method,
29.         # as they require that the instance has already been saved.
30.         info = model_meta.get_field_info(ModelClass)
31.         many_to_many = {}
32.         for field_name, relation_info in info.relations.items():
33.             if relation_info.to_many and (field_name in validated_data):
34.                 many_to_many[field_name] = validated_data.pop(field_name)
36.         try:
37.             instance = ModelClass._default_manager.create(**validated_data)
38.         except TypeError:
39.             tb = traceback.format_exc()
40.             msg = (
41.                 'Got a `TypeError` when calling `%s.%s.create()`. '
42.                 'This may be because you have a writable field on the '
43.                 'serializer class that is not a valid argument to '
44.                 '`%s.%s.create()`. You may need to make the field '
45.                 'read-only, or override the %s.create() method to handle '
46.                 'this correctly.\nOriginal exception was:\n %s' %
47.                 (
48.                     ModelClass.__name__,
49.                     ModelClass._default_manager.name,
50.                     ModelClass.__name__,
51.                     ModelClass._default_manager.name,
52.                     self.__class__.__name__,
53.                     tb
54.                 )
55.             )
56.             raise TypeError(msg)
58.         # Save many-to-many relationships after the instance is created.
59.         if many_to_many:
60.             for field_name, value in many_to_many.items():
61.                 field = getattr(instance, field_name)
62.                 field.set(value)
64.         return instance
65. '''

复制代码

这逻辑我是没看懂，但是通过print、type、dir函数可以确定
接收对象validated_data是一个字典，
返回对象instance是一个模型对象。
于是可以把源码cv过来，简单测试是否能够通。

1. import time
2. import hashlib
4. from rest_framework import status
5. from rest_framework import serializers
6. from rest_framework.response import Response
7. from rest_framework.viewsets import ModelViewSet
9. from myapp import models as myapp_models
11. class TokenSerializer(serializers.ModelSerializer):
12.     class Meta:
13.         model = myapp_models.Token
14.         fields = '__all__'
15.     def create(self,validated_data):
16.         ######################################
17.         query_obj = myapp_models.Token.objects.update_or_create(
18.             username=validated_data['username'],
19.             defaults={"username":validated_data['username'],"token":validated_data['token']})[0]
20.         print(query_obj)
21.         return query_obj
22.         #------------------------------------#
23. class LoginView(ModelViewSet):
24.     queryset = myapp_models.Token.objects.all()
25.     serializer_class = TokenSerializer
26.     def create(self, request, *args, **kwargs):
27.         serializer = self.get_serializer(data=request.data)
28.         serializer.is_valid(raise_exception=True)
29.         self.perform_create(serializer)
30.         headers = self.get_success_headers(serializer.data)
31.         return Response(serializer.data, status=status.HTTP_201_CREATED, headers=headers)

复制代码

3 重写create方法

3.1 编写登录逻辑

TokenSerializer
1.获取username和password。
2.验证username、password匹配性。
3.匹配错误：更新或创建模型中username对应的token为空字符串，返回模型对象。
4.匹配正确：通过md5加密生成token,更新或创建模型中username对应的token为密钥。
ModelViewSet
1.根据username查询token值。
2.将username、token值设置到session会话。

1. import time
2. import hashlib
4. from rest_framework import status
5. from rest_framework import serializers
6. from rest_framework.response import Response
7. from rest_framework.viewsets import ModelViewSet
9. from myapp import models as myapp_models
11. class TokenSerializer(serializers.ModelSerializer):
12.     class Meta:
13.         model = myapp_models.Token
14.         fields = '__all__'
15.     def create(self,validated_data):
16.         ######################################
17.         user_obj = myapp_models.User.objects.filter(
18.             username=validated_data['username'],
19.             password=validated_data['token'])
20.         user_dict = validated_data
21.         user_dict['token'] = ''
22.         if not user_obj.exists():
23.             query_obj = myapp_models.Token.objects.update_or_create(
24.                 username=user_dict['username'],
25.                 defaults={"username":user_dict['username'],"token":user_dict['token']})[0]
26.             return query_obj
27.         validated_data['token'] = hashlib.md5(
28.             ''.format(time.time(),''.join(validated_data.values())).encode()).hexdigest()
29.         query_obj = myapp_models.Token.objects.update_or_create(
30.             username=validated_data['username'],
31.             defaults={"username":validated_data['username'],"token":validated_data['token']})[0]
32.         print(query_obj)
33.         return query_obj
34.         #------------------------------------#
35. class LoginView(ModelViewSet):
36.     queryset = myapp_models.Token.objects.all()
37.     serializer_class = TokenSerializer
38.     def create(self, request, *args, **kwargs):
39.         serializer = self.get_serializer(data=request.data)
40.         serializer.is_valid(raise_exception=True)
41.         self.perform_create(serializer)
42.         headers = self.get_success_headers(serializer.data)
43.         ######################################
44.         token_obj = myapp_models.Token.objects.filter(
45.             username=request.POST.get('username')).first()
46.         if token_obj.token == '':
47.             request.session['username'] = token_obj.username
48.             request.session['token'] = token_obj.token
49.             return Response('检查输入的账户和密码')
50.         request.session['username'] = token_obj.username
51.         request.session['token'] = token_obj.token
52.         #------------------------------------#
53.         return Response(serializer.data, status=status.HTTP_201_CREATED, headers=headers)

复制代码

3.2 编写认证逻辑

1.从session中获取username，token。
2.判断username，token是否不存在、或token是否为空字符串。
3.判断正确：抛出异常。
4.判断错误：范围username和模型对象组成的元组。

1. from rest_framework import exceptions
2. from rest_framework.authentication import BaseAuthentication
4. from myapp import models as myapp_models
6. class Authentication(BaseAuthentication):
7.     def authenticate(self,request):
8.         ######################################
9.         username = request._request.session.get('username','')
10.         token = request._request.session.get('token','')
11.         token_obj = myapp_models.Token.objects.filter(
12.             username=username,token=token)
13.         if not token_obj.exists or token_obj.first().token == '':
14.             raise exceptions.AuthenticationFailed('认证失败')
15.         return (token_obj.first().username,token_obj.first())
16.         #------------------------------------#

复制代码

3.3 添加路由

1. path('login/',myapp_views.LoginView.as_view({
2.         'post':'create'}),name='login')

复制代码

来源:https://www.cnblogs.com/mlcode/p/17969584/rest_framework
免责声明：由于采集信息均来自互联网，如果侵犯了您的权益，请联系我们【E-Mail:cb@itdo.tech】 我们会及时删除侵权内容，谢谢合作！