1.签发token源码分析
2.校验token源码分析
3.自定义drf-jwt配置
4.多方式登录签发token
5.自定义jwt校验规则（了解）
6.admin密文管理自定义User表（了解）
7.群查各过滤组件数据准备
8.drf搜索组件
9.drf排序组件
10.基础分页器
一.签发token源码分析
源码入口：
前提：给一个局部禁用了所有 认证与权限 的视图类发送用户信息得到token，其实就是登陆接口
1.rest_framework_jwt.views.ObtainJSONWebToken 的 父类 JSONWebTokenAPIView 的 post 方法
# 接受有username，password的post请求
2.post方法将请求数据交给rest_framework_jwt.serializer.JSONWebToKenSerializer 处理
# 完成数据的校验，会走序列化类的 全局钩子校验规则，校验得到登陆用户并签发，token存储在序列化对象中
def validate(self, attrs):
# 账号密码字典
credentials = {
self.username_field: attrs.get(self.username_field),
'password': attrs.get('password')
}
if all(credentials.values()):
# 签发token第1步：用账号密码得到user对象
user = authenticate(**credentials)
if user:
if not user.is_active:
msg = _('User account is disabled.')
raise serializers.ValidationError(msg)
# 签发token第2步：通过user得到payload，payload包含着用户信息与过期时间
payload = jwt_payload_handler(user)
# 在视图类中，可以通过 序列化对象.object.get('user'或者'token') 拿到user和token
return {
# 签发token第3步：通过payload签发出token
'token': jwt_encode_handler(payload),
'user': user
}
else:
msg = _('Unable to log in with provided credentials.')
raise serializers.ValidationError(msg)
else:
msg = _('Must include "{username_field}" and "password".')
msg = msg.format(username_field=self.username_field)
raise serializers.ValidationError(msg)
手动签发token逻辑
# 1）通过username、password得到user对象 # 2）通过user对象生成payload：jwt_payload_handler(user) => payload # from rest_framework_jwt.serializers import jwt_payload_handler # 3）通过payload签发token：jwt_encode_handler(payload) => token # from rest_framework_jwt.serializers import jwt_encode_handler
二.校验token源码分析
源码入口：
前提：访问一个配置了jwt认证规则的视图类，就需要提交认证字符串token，在认证类中完成token的校验 # 1）通过username、password得到user对象 # 2）通过user对象生成payload：jwt_payload_handler(user) => payload # from rest_framework_jwt.serializers import jwt_payload_handler # 3）通过payload签发token：jwt_encode_handler(payload) => token # from rest_framework_jwt.serializers import jwt_encode_handler
def authenticate(self, request):
"""
Returns a two-tuple of `User` and token if a valid signature has been
supplied using JWT-based authentication. Otherwise returns `None`.
"""
# 带有反爬小规则的获取token：前台必须按 "jwt token字符串" 方式提交
# 校验user第1步：从请求头 HTTP_AUTHORIZATION 中拿token，并提取
jwt_value = self.get_jwt_value(request)
# 游客
if jwt_value is None:
return None
# 校验
try:
# 校验user第2步：token => payload
payload = jwt_decode_handler(jwt_value)
except jwt.ExpiredSignature:
msg = _('Signature has expired.')
raise exceptions.AuthenticationFailed(msg)
except jwt.DecodeError:
msg = _('Error decoding signature.')
raise exceptions.AuthenticationFailed(msg)
except jwt.InvalidTokenError:
raise exceptions.AuthenticationFailed()
# 校验user第3步：token => payload
user = self.authenticate_credentials(payload)
return (user, jwt_value)
手动校验token逻辑
1.从请求头中获取token
2.根据token解析出payload：jwt_decode_handler(token) => payload
from rest_framework_jwt.authentication import jwt_decode_handler
3.根据payload解析出user：self.authenticate_credentials(payload) = > user
继承drf-jwt的BaseJSONWebToKenAuthentication，拿到父级的authenticate_credentials方法
三.自定义drf-jwt配置
# 自定义 drf-jwt 配置
import datetime
JWT_AUTH = {
# user => payload
'JWT_PAYLOAD_HANDLER':
'rest_framework_jwt.utils.jwt_payload_handler',
# payload => token
'JWT_ENCODE_HANDLER':
'rest_framework_jwt.utils.jwt_encode_handler',
# token => payload
'JWT_DECODE_HANDLER':
'rest_framework_jwt.utils.jwt_decode_handler',
# token过期时间
'JWT_EXPIRATION_DELTA': datetime.timedelta(days=7),
# token刷新的过期时间
'JWT_REFRESH_EXPIRATION_DELTA': datetime.timedelta(days=7),
# 反爬小措施前缀
'JWT_AUTH_HEADER_PREFIX': 'JWT',
}
四.多方式登录签发token
models.py
from django.db import models
from django.contrib.auth.models import AbstractUser
class User(AbstractUser):
mobile = models.CharField(max_length=11, unique=True)
class Meta:
db_table = 'api_user'
verbose_name = '用户表'
verbose_name_plural = verbose_name
def __str__(self):
return self.username
api/serializers.py
注意
# 1) 前台提交多种登录信息都采用一个key，所以后台可以自定义反序列化字段进行对应 # 2) 序列化类要处理序列化与反序列化，要在fields中设置model绑定的Model类所有使用到的字段 # 3) 区分序列化字段与反序列化字段 read_only | write_only # 4) 在自定义校验规则中（局部钩子、全局钩子）校验数据是否合法、确定登录的用户、根据用户签发token # 5) 将登录的用户与签发的token保存在序列化类对象中
from rest_framework import serializers
from . import models
import re
# 拿到前台token的两个函数： user => payload => token
# from rest_framework_jwt.settings import api_settings
# jwt_payload_handler = api_settings.JWT_PAYLOAD_HANDLER
# jwt_encode_handler = api_settings.JWT_ENCODE_HANDLER
from rest_framework_jwt.serializers import jwt_payload_handler
from rest_framework_jwt.serializers import jwt_encode_handler
class UserModelSerializer(serializers.ModelSerializer):
# 自定义反序列字段：一定要设置write_only，只参与反序列化，不会与model类字段映射
usr = serializers.CharField(write_only=True)
pwd = serializers.CharField(write_only=True)
class Meta:
model = models.User
fields = ['usr', 'pwd', 'username', 'mobile', 'email']
# 系统校验规则
extra_kwargs = {
'username': {
# 只参加序列化
'read_only': True
},
'mobile': {
'read_only': True
},
'email': {
'read_only': True
},
}
# 我们是账号密码整体校验得到一个用户，可以在全局校验
def validate(self, attrs):
# 在这拿到了用户输入的账户和密码，做一些校验规则
usr = attrs.get('usr')
pwd = attrs.get('pwd')
# 多方式登录：各分支处理得到该方式下对应的用户
if re.match(r'.+@.+', usr):
user_query = models.User.objects.filter(email=usr)
elif re.match(r'1[3-9][0-9]{9}', usr):
user_query = models.User.objects.filter(mobile=usr)
else:
user_query = models.User.objects.filter(username=usr)
user_obj = user_query.first()
# 签发：得到登录用户，签发token并存储在实例化对象中
# 判断user用户要有，然后校验密码，这是auth组件里面的方法，check_password校验密码是密文的
if user_obj and user_obj.check_password(pwd):
# 签发token，将token存放到 实例化类对象的token 名字中
payload = jwt_payload_handler(user_obj)
token = jwt_encode_handler(payload)
# 将当前用户与签发的token都保存在序列化对象中
self.user = user_obj
self.token = token
return attrs
# 如果没有return肯定就会抛异常
raise serializers.ValidationError({'data': '数据有误'})
api/views.py
#实现多方式登陆签发token：账号、手机号、邮箱等登陆
# 1) 禁用认证与权限组件
# 2) 拿到前台登录信息，交给序列化类
# 3) 序列化类校验得到登录用户与token存放在序列化对象中
# 4) 取出登录用户与token返回给前台
import re
from . import serializers, models
from utils.response import APIResponse
from rest_framework_jwt.serializers import jwt_payload_handler
from rest_framework_jwt.serializers import jwt_encode_handler
class LoginAPIView(APIView):
# 1) 禁用认证与权限组件
authentication_classes = []
permission_classes = []
def post(self, request, *args, **kwargs):
# 直接用反序列化组件
# 2) 拿到前台登录信息，交给序列化类，规则：账号用usr传，密码用pwd传
user_ser = serializers.UserModelSerializer(data=request.data)
# 校验，如果校验失败就直接抛异常
# 3) 序列化类校验得到登录用户与token存放在序列化对象中
user_ser.is_valid(raise_exception=True)
# 4) 取出登录用户与token返回给前台
return APIResponse(token=user_ser.token, results=serializers.UserModelSerializer(user_ser.user).data)
# "一根筋" 思考方式：所有逻辑都在视图类中处理
def my_post(self, request, *args, **kwargs):
usr = request.data.get('usr')
pwd = request.data.get('pwd')
if re.match(r'.+@.+', usr):
user_query = models.User.objects.filter(email=usr)
elif re.match(r'1[3-9][0-9]{9}', usr):
user_query = models.User.objects.filter(mobile=usr)
else:
user_query = models.User.objects.filter(username=usr)
user_obj = user_query.first()
if user_obj and user_obj.check_password(pwd):
payload = jwt_payload_handler(user_obj)
token = jwt_encode_handler(payload)
return APIResponse(results={'username': user_obj.username}, token=token)
return APIResponse(data_msg='不可控错误')
五.自定义jwt校验规则（了解）
api/authentications.py
1 import jwt
2 from rest_framework_jwt.authentication import BaseJSONWebTokenAuthentication
3 from rest_framework_jwt.authentication import jwt_decode_handler
4 from rest_framework.exceptions import AuthenticationFailed
5 class JWTAuthentication(BaseJSONWebTokenAuthentication):
6 def authenticate(self, request):
7 jwt_token = request.META.get('HTTP_AUTHORIZATION')
8
9 # 自定义校验规则：auth token jwt
10 token = self.parse_jwt_token(jwt_token)
11
12 if token is None:
13 return None
14
15 try:
16 # token => payload
17 payload = jwt_decode_handler(token)
18 except jwt.ExpiredSignature:
19 raise AuthenticationFailed('token已过期')
20 except:
21 raise AuthenticationFailed('非法用户')
22 # payload => user
23 user = self.authenticate_credentials(payload)
24
25 return (user, token)
26
27 # 自定义校验规则：auth token jwt，auth为前盐，jwt为后盐
28 def parse_jwt_token(self, jwt_token):
29 tokens = jwt_token.split()
30 if len(tokens) != 3 or tokens[0].lower() != 'auth' or tokens[2].lower() != 'jwt':
31 return None
32 return tokens[1]
api/views.py
1 from rest_framework.views import APIView
2 from utils.response import APIResponse
3 # 必须登录后才能访问 - 通过了认证权限组件
4 from rest_framework.permissions import IsAuthenticated
5 # 自定义jwt校验规则
6 from .authentications import JWTAuthentication
7 class UserDetail(APIView):
8 authentication_classes = [JWTAuthentication]
9 permission_classes = [IsAuthenticated]
10 def get(self, request, *args, **kwargs):
11 return APIResponse(results={'username': request.user.username})
六.admin密文管理自定义User表（了解）
from django.contrib import admin
from . import models
# 自定义User表，admin后台管理，采用密文密码
from django.contrib.auth.admin import UserAdmin
class MyUserAdmin(UserAdmin):
add_fieldsets = (
(None, {
'classes': ('wide',),
'fields': ('username', 'password1', 'password2', 'mobile', 'email'),
}),
)
admin.site.register(models.User, MyUserAdmin)
七.群查各过滤组件数据准备
models.py
class Car(models.Model):
name = models.CharField(max_length=16, unique=True, verbose_name='车名')
price = models.DecimalField(max_digits=10, decimal_places=2, verbose_name='价格')
brand = models.CharField(max_length=16, verbose_name='品牌')
class Meta:
db_table = 'api_car'
verbose_name = '汽车表'
verbose_name_plural = verbose_name
def __str__(self):
return self.name
admin.py
admin.site.register(models.Car)
serializers.py
from rest_framework import serializers
class CarModelSerializer(serializers.ModelSerializer):
class Meta:
model = models.Car
fields = ['name', 'price', 'brand']
views.py
# Car的群查接口
from rest_framework.generics import ListAPIView
class CarListAPIView(ListAPIView):
queryset = models.Car.objects.all()
serializer_class = serializers.CarModelSerializer
urls.py
from django.conf.urls import url
from . import views
urlpatterns = [
url(r'^cars/$', views.CarListAPIView.as_view()),
]
八.drf搜索过滤组件
views.py
from rest_framework.generics import ListAPIView
# 第一步：drf的SearchFilter - 搜索过滤
from rest_framework.filters import SearchFilter
class CarListAPIView(ListAPIView):
queryset = models.Car.objects.all()
serializer_class = serializers.CarModelSerializer
# 第二步：局部配置 过滤类 们（全局配置用DEFAULT_FILTER_BACKENDS）
filter_backends = [SearchFilter]
# 第三步：SearchFilter过滤类依赖的过滤条件 => 接口：/cars/?search=...
search_fields = ['name', 'price']
# eg：/cars/?search=1，name和price中包含1的数据都会被查询出
九.drf排序过滤组件
views.py
from rest_framework.generics import ListAPIView
# 第一步：drf的OrderingFilter - 排序过滤
from rest_framework.filters import OrderingFilter
class CarListAPIView(ListAPIView):
queryset = models.Car.objects.all()
serializer_class = serializers.CarModelSerializer
# 第二步：局部配置 过滤类 们（全局配置用DEFAULT_FILTER_BACKENDS）
filter_backends = [OrderingFilter]
# 第三步：OrderingFilter过滤类依赖的过滤条件 => 接口：/cars/?ordering=...
ordering_fields = ['pk', 'price']
# eg：/cars/?ordering=-price,pk，先按price降序，如果出现price相同，再按pk升序
十.基础分页器
api/pahenations.py
from rest_framework.pagination import PageNumberPagination
class MyPageNumberPagination(PageNumberPagination):
# ?page=页码
page_query_param = 'page'
# ?page=页面 下默认一页显示的条数
page_size = 3
# ?page=页面&page_size=条数 用户自定义一页显示的条数
page_size_query_param = 'page_size'
# 用户自定义一页显示的条数最大限制：数值超过5也只显示5条
max_page_size = 5
views.py
from rest_framework.generics import ListAPIView
class CarListAPIView(ListAPIView):
# 如果queryset没有过滤条件，就必须 .all()，不然分页会出问题
queryset = models.Car.objects.all()
serializer_class = serializers.CarModelSerializer
# 分页组件 - 给视图类配置分页类即可 - 分页类需要自定义，继承drf提供的分页类即可
pagination_class = pagenations.MyPageNumberPagination