快捷導(dǎo)航

DRF使用simple JWT身份驗(yàn)證的實(shí)現(xiàn)

更新時(shí)間：2021年01月14日 14:35:20 作者：一切如來(lái)心秘密

這篇文章主要介紹了DRF使用simple JWT身份驗(yàn)證，文中通過(guò)示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧

前言

在Django的前后端分離項(xiàng)目中DRF(Django Restframe Work)框架無(wú)疑是首選，關(guān)于token驗(yàn)證一般使用的是JWT，但是JWT只支持到Django1.x的版本。

官方推薦Django2.x之后的版本使用simple JWT，官方文檔。

登錄返回token和refresh

user 模型類：

我user模型類繼承的是django.contrib.auth.models.AbstractUser,這樣可以使用Django自帶的認(rèn)證。

如果繼承該類，我們就必須在settings中配置 AUTH_USER_MODEL = "users.UserProfile"

from datetime import datetime

from django.db import models
from django.contrib.auth.models import AbstractUser
# Create your models here.

class UserProfile(AbstractUser):
  """
  用戶
  """
  name = models.CharField(max_length=30, null=True, blank=True, verbose_name="姓名")
  birthday = models.DateField(null=True, blank=True, verbose_name="出生年月")
  gender = models.CharField(max_length=6, choices=(("male", u"男"), ("female", "女")), default="female", verbose_name="性別")
  mobile = models.CharField(null=True, blank=True, max_length=11, verbose_name="電話")
  email = models.CharField(max_length=100, null=True, blank=True, verbose_name="郵箱")

  class Meta:
    verbose_name = "用戶"
    verbose_name_plural = "用戶"

  def __str__(self):
    return self.username

序列化文件：

注意這里使用的User是Django管理的user模型類，要從django.contrib.auth.get_user_model實(shí)例化獲取。

在users模塊的serializers.py文件中寫如下序列化類繼承自rest_framework_simplejwt.serializers.TokenObtainPairSerializer：

在這里插入圖片描述

from django.contrib.auth import get_user_model
User = get_user_model()

class MyTokenObtainPairSerializer(TokenObtainPairSerializer):
  @classmethod
  def get_token(cls, user):
    token = super().get_token(user)
    token['name'] = user.username
    return token

  def validate(self, attrs):
    """
    登錄返回token和refresh
    :param attrs:
    :return:
    """
    data = super().validate(attrs)
    data['token'] = str(data["access"])
    return data

根據(jù)官方文檔的說(shuō)明，get_token方法之所以設(shè)置token['name']是因?yàn)槌绦蚩赡苓\(yùn)行在集群上，這里不寫也可以。

編寫視圖類：

from users.serializers import MyTokenObtainPairSerializer

class MyTokenObtainPairView(TokenObtainPairView):
  serializer_class = MyTokenObtainPairSerializer

編寫url:

其中api/token/和api/token/refresh/兩個(gè)URL是simple JWT自帶的token方法：

api/token/用于獲取token
api/token/refresh/用于刷新token

from django.conf.urls import url
from django.urls import include, path

from rest_framework_simplejwt.views import (
  TokenObtainPairView,
  TokenRefreshView,
)

urlpatterns = [
  # simple jwt 認(rèn)證接口
  path('api/token/', TokenObtainPairView.as_view(), name='token_obtain_pair'),
  path('api/token/refresh/', TokenRefreshView.as_view(), name='token_refresh'),
  path('login/', MyTokenObtainPairView.as_view(), name='token_obtain_pair'),
]

settings配置SIMPLE_JWT：

這是對(duì)token的一些自定義設(shè)置包括獲取的token和refresh的生命周期等配置，通過(guò)查看rest_framework_simplejwt的源碼可以發(fā)現(xiàn)有很多自定義配置，感興趣的小伙伴可以通過(guò)查看官方文檔了解更多，這里我只配置了獲取的token的生命周期。

啟動(dòng)程序訪問(wèn)：

在這里插入圖片描述

可以發(fā)現(xiàn)返回了三個(gè)值：

refresh：是刷新token用的，當(dāng)前端token過(guò)期需要刷新token的時(shí)候就可以訪問(wèn)前邊說(shuō)的api/token/refreshurl，參數(shù)就是refresh的值。
access：這個(gè)就是token但是框架里叫做access。
token：這個(gè)是在序列化文件中給access新命名了一個(gè)值，方便前端獲取：

def validate(self, attrs):
  """
  登錄返回token和refresh
  :param attrs:
  :return:
  """
  data = super().validate(attrs)
  data['token'] = str(data["access"])
  return data

注冊(cè)返回token

視圖類：

在視圖類中導(dǎo)入from rest_framework_simplejwt.tokens import RefreshToken
重寫create方法，需要通過(guò)前邊導(dǎo)入的RefreshToken來(lái)獲取token返回給前端。

from django.contrib.auth import get_user_model
from django.db.models import Q
from rest_framework.response import Response
from rest_framework_simplejwt.tokens import RefreshToken
from rest_framework.mixins import CreateModelMixin
from rest_framework import viewsets
from rest_framework import status

from users.serializers import (
  UserRegSerializer
)
from .models import VerifyCode

User = get_user_model()


class UserViewSet(CreateModelMixin, viewsets.GenericViewSet):
  """
  用戶
  """
  serializer_class = UserRegSerializer
  queryset = User.objects.all()

  def create(self, request, *args, **kwargs):
    serializer = self.get_serializer(data=request.data)
    serializer.is_valid(raise_exception=True)
    user = self.perform_create(serializer)

    ret_dict = serializer.data
    refresh = RefreshToken.for_user(user)
    access_token = str(refresh.access_token)
    ret_dict["token"] = access_token

    headers = self.get_success_headers(serializer.data)
    return Response(ret_dict, status=status.HTTP_201_CREATED, headers=headers)

  def perform_create(self, serializer):
    return serializer.save()

到此這篇關(guān)于DRF使用simple JWT身份驗(yàn)證的實(shí)現(xiàn)的文章就介紹到這了,更多相關(guān)DRF使用simple JWT身份驗(yàn)證內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: