今天来记录一下初步使用drf中的认证组件来制作一个小案例。
案例需求
/login：通过用户名、密码登录，登录成功后生成个Token并返回给用户。/user：登录的用户可以查看自己的用户信息，支持通过url中加参数查看，也支持在请求头中加参数查看
项目准备
新建纯净版项目
项目目录如下：
drf_study/$
├── apps/
│ └── api/
│ ├── migrations/
│ ├── __init__.py
│ ├── admin.py
│ ├── apps.py
│ ├── models.py
│ ├── tests.py
│ └── views.py
├── drf_study/
│ ├── __init__.py
│ ├── asgi.py
│ ├── settings.py
│ ├── urls.py
│ └── wsgi.py
├── utils/
│ └── auth.py
├── db.sqlite3
├── manage.py
└── requirements.txt
纯净版setting.py如下，数据库用Postgre：
- 增加Postgresql的链接
- 加上rest_framework的两个配置，其中一个就是认证组件的路径。
# drf_study/drf_study/settings.py
from pathlib import Path
# Build paths inside the project like this: BASE_DIR / 'subdir'.
BASE_DIR = Path(__file__).resolve().parent.parent
# Quick-start development settings - unsuitable for production
# See https://docs.djangoproject.com/en/5.2/howto/deployment/checklist/
# SECURITY WARNING: keep the secret key used in production secret!
SECRET_KEY = 'django-insecure-jc1gzygdwlklcq_4#4z@j7vmhi)6nhg%7k^$2$yp-dp(klj%9c'
# SECURITY WARNING: don't run with debug turned on in production!
DEBUG = True
ALLOWED_HOSTS = []
# Application definition
INSTALLED_APPS = [
# 'django.contrib.admin',
# 'django.contrib.auth',
# 'django.contrib.contenttypes',
# 'django.contrib.sessions',
# 'django.contrib.messages',
'django.contrib.staticfiles',
'rest_framework',
'apps.api',
]
MIDDLEWARE = [
'django.middleware.security.SecurityMiddleware',
# 'django.contrib.sessions.middleware.SessionMiddleware',
'django.middleware.common.CommonMiddleware',
'django.middleware.csrf.CsrfViewMiddleware',
# 'django.contrib.auth.middleware.AuthenticationMiddleware',
# 'django.contrib.messages.middleware.MessageMiddleware', 'django.middleware.clickjacking.XFrameOptionsMiddleware',
]
ROOT_URLCONF = 'drf_study.urls'
TEMPLATES = [
{
'BACKEND': 'django.template.backends.django.DjangoTemplates',
'DIRS': [],
'APP_DIRS': True,
'OPTIONS': {
'context_processors': [
'django.template.context_processors.request',
# 'django.contrib.auth.context_processors.auth',
# 'django.contrib.messages.context_processors.messages', ],
},
},
]
WSGI_APPLICATION = 'drf_study.wsgi.application'
# Database
# https://docs.djangoproject.com/en/5.2/ref/settings/#databases
# DATABASES = {
# 'default': {
# 'ENGINE': 'django.db.backends.sqlite3',
# 'NAME': BASE_DIR / 'db.sqlite3',
# }
# }
DATABASES = {
'default': {
'ENGINE': 'django.db.backends.postgresql',
'NAME': 'drf_study',
'USER': 'DATEBASE_USER',
'PASSWORD': 'DATEBASE_PASSWORD',
'HOST': 'localhost',
'PORT': '5432',
}
}
# Password validation
# https://docs.djangoproject.com/en/5.2/ref/settings/#auth-password-validators
AUTH_PASSWORD_VALIDATORS = [
{
'NAME': 'django.contrib.auth.password_validation.UserAttributeSimilarityValidator',
},
{
'NAME': 'django.contrib.auth.password_validation.MinimumLengthValidator',
},
{
'NAME': 'django.contrib.auth.password_validation.CommonPasswordValidator',
},
{
'NAME': 'django.contrib.auth.password_validation.NumericPasswordValidator',
},
]
# Internationalization
# https://docs.djangoproject.com/en/5.2/topics/i18n/
LANGUAGE_CODE = 'en-us'
TIME_ZONE = 'UTC'
USE_I18N = True
USE_TZ = True
# Static files (CSS, JavaScript, Images)
# https://docs.djangoproject.com/en/5.2/howto/static-files/
STATIC_URL = 'static/'
# Default primary key field type
# https://docs.djangoproject.com/en/5.2/ref/settings/#default-auto-field
DEFAULT_AUTO_FIELD = 'django.db.models.BigAutoField'
REST_FRAMEWORK = {
'UNAUTHENTICATED_USER': None,
'DEFAULT_AUTHENTICATION_CLASSES':[
'utils.auth.QuaryParamsAuthentication',
'utils.auth.HeaderAuthentication',
'utils.auth.NotAuthentication',
]
}
创建表和测试数据
# drf_study/apps/api/models.py
from django.db import models
# Create your models here.
class UserInfo(models.Model):
username = models.CharField(verbose_name='用户名', max_length=64)
password = models.CharField(verbose_name='密码', max_length=64)
# 简单示例，所以让Token直接放到数据库中
token = models.CharField(verbose_name='Token', max_length=255, null=True, blank=True)
class Meta:
db_table = 'user_info'
路由
#drf_study/drf_study/urls.py
from django.urls import path
from apps.api import views
urlpatterns = [
path('login/', views.LoginView.as_view(), name='login'),
path('user/', views.UserView.as_view(), name='user'),
]
视图类
# drf_study/apps/api/views.py
from rest_framework.response import Response
from rest_framework.views import APIView
from apps.api import models
import uuid
class LoginView(APIView):
authentication_classes = []
def post(self, request):
# 1. 获取用户提交的信息
# - 用的是drf的request对象的get方法，注意：前端传参的时候，是以json传到body中的
username = request.data.get('username')
pwd = request.data.get('password')
# 2. 去数据库验证用户
user_object = models.UserInfo.objects.filter(username=username, password=pwd).first()
if not user_object:
return Response({"code":10001, "status":"fail", "msg":"用户名密码错误~"})
# 3. 用户验证成功，生成token存入数据库，并返回给用户
token = str(uuid.uuid4())
user_object.token = token
user_object.save()
return Response({"status":"success", "token":token})
class UserView(APIView):
def get(self, request):
context = {
'content':'user View',
'user':self.request.user.username
}
return Response(context)
认证组件
#drf_study/utils/auth.py
from rest_framework.authentication import BaseAuthentication
from rest_framework.exceptions import AuthenticationFailed
from apps.api import models
# 在url中返回token
class QuaryParamsAuthentication(BaseAuthentication):
def authenticate(self, request):
# 1. 要求前端通过url带上token来访问，这里就去获取token
token = request.query_params.get('token')
# 2. 验证token的合法性,先验证token不能为空，再验证token在数据库中有值
if not token:
return
user_object = models.UserInfo.objects.filter(token=token).first()
if user_object:
return (user_object, token)
return
def authenticate_header(self, request):
return 'API'
# 在header中返回token
class HeaderAuthentication(BaseAuthentication):
def authenticate(self, request):
# 1. 要求前端通过请求头中的AUTHORIZATION带token来访问，这里就去获取token
token = request.META.get('HTTP_AUTHORIZATION')
# 2. 验证token的合法性
if not token:
return
user_object = models.UserInfo.objects.filter(token=token).first()
if user_object:
return (user_object, token)
return
def authenticate_header(self, request):
return 'API'
# 如果在url和header中都没有拿到token，就认证失败
class NotAuthentication(BaseAuthentication):
def authenticate(self, request):
raise AuthenticationFailed({"status":"fail", "code":"10003","msg":"用户不存在~"})
def authenticate_header(self, request):
return 'API'
