Django实现接口token检测的实现方案

一、Token认证的实现思路

  1. 用户登录后生成Token:用户登录成功后,服务器生成一个Token,并返回给客户端。
  2. 客户端请求时携带Token:客户端在每次请求时,将Token放入HTTP请求头(Headers)中。
  3. 服务器端验证Token:Django后端解析请求中的Token,并验证其合法性。
  4. Token校验通过,允许访问接口;否则,返回未授权的错误信息。

二、环境准备

在Django项目中,我们可以使用rest_framework.authtoken或者自定义Token认证逻辑。这里介绍两种方式:

  1. 基于 Django REST framework(DRF) 的 Token 认证
  2. 自定义 Token 认证

三、基于 Django REST Framework(DRF)的 Token 认证

Django REST Framework 提供了现成的 Token 认证机制,下面是实现步骤。

1. 安装 Django REST framework

如果还未安装 Django REST framework,请使用 pip 安装:

复制代码
pip install djangorestframework
pip install djangorestframework.authtoken

AI写代码sh
12

2. 添加到 Django 配置

在 settings.py 中启用 Django REST framework 和 Token 认证:

css 复制代码
INSTALLED_APPS = [    'django.contrib.admin',    'django.contrib.auth',    'django.contrib.contenttypes',    'django.contrib.sessions',    'django.contrib.messages',    'django.contrib.staticfiles',    'rest_framework',    'rest_framework.authtoken',]

REST_FRAMEWORK = {
    'DEFAULT_AUTHENTICATION_CLASSES': (
        'rest_framework.authentication.TokenAuthentication',
    ),
    'DEFAULT_PERMISSION_CLASSES': (
        'rest_framework.permissions.IsAuthenticated',
    ),
}

AI写代码python
运行
12345678910111213141516171819

3. 生成 Token 表

运行 Django 迁移命令,创建 Token 认证所需的数据表:

复制代码
python manage.py migrate

AI写代码sh
1

4. 创建 API 视图

创建用户登录接口,生成并返回 Token。

kotlin 复制代码
from django.contrib.auth import authenticate
from rest_framework.authtoken.models import Token
from rest_framework.response import Response
from rest_framework.views import APIView
from rest_framework import status

class LoginView(APIView):
    def post(self, request):
        username = request.data.get("username")
        password = request.data.get("password")
        user = authenticate(username=username, password=password)
        if user:
            token, created = Token.objects.get_or_create(user=user)
            return Response({"token": token.key})
        return Response({"error": "Invalid Credentials"}, status=status.HTTP_401_UNAUTHORIZED)

AI写代码python
运行
123456789101112131415

5. 保护 API 端点

在 API 视图中使用 TokenAuthentication 保护 API,仅允许持有有效 Token 的用户访问:

python 复制代码
from rest_framework.authentication import TokenAuthentication
from rest_framework.permissions import IsAuthenticated
from rest_framework.views import APIView
from rest_framework.response import Response

class ProtectedView(APIView):
    authentication_classes = [TokenAuthentication]
    permission_classes = [IsAuthenticated]

    def get(self, request):
        return Response({"message": "You have access to this protected endpoint."})

AI写代码python
运行
1234567891011

6. 测试 API

  1. 获取 Token:

    makefile 复制代码
    curl -X POST http://127.0.0.1:8000/api/login/ -H "Content-Type: application/json" -d '{"username": "admin", "password": "password"}'
    
    AI写代码sh
    1

    服务器返回:

    json 复制代码
    {"token": "abc123xyz456"}
    
    AI写代码json
    1
  2. 访问受保护的 API:

    ruby 复制代码
    curl -X GET http://127.0.0.1:8000/api/protected/ -H "Authorization: Token abc123xyz456"
    
    AI写代码sh
    1

    服务器返回:

    json 复制代码
    {"message": "You have access to this protected endpoint."}
    
    AI写代码json
    1

四、自定义 Token 认证方案

如果不使用 DRF 自带的 TokenAuthentication,我们也可以自定义 Token 认证。

1. 自定义 Token 模型

在 models.py 中创建 Token 存储表:

python 复制代码
from django.db import models
from django.contrib.auth.models import User
import uuid

class CustomToken(models.Model):
    user = models.OneToOneField(User, on_delete=models.CASCADE)
    key = models.CharField(max_length=255, unique=True, default=uuid.uuid4)
    created_at = models.DateTimeField(auto_now_add=True)

    def __str__(self):
        return self.key

AI写代码python
运行
1234567891011

2. 创建 Token 生成逻辑

在 views.py 中定义登录逻辑,生成自定义 Token:

python 复制代码
from django.contrib.auth import authenticate
from django.http import JsonResponse
from .models import CustomToken

def custom_login(request):
    if request.method == "POST":
        username = request.POST.get("username")
        password = request.POST.get("password")
        user = authenticate(username=username, password=password)

        if user:
            token, created = CustomToken.objects.get_or_create(user=user)
            return JsonResponse({"token": token.key})
        return JsonResponse({"error": "Invalid credentials"}, status=401)

AI写代码python
运行
1234567891011121314

3. 中间件拦截 Token

在 middleware.py 中定义 Token 验证逻辑:

python 复制代码
from django.http import JsonResponse
from .models import CustomToken

class TokenMiddleware:
    def __init__(self, get_response):
        self.get_response = get_response

    def __call__(self, request):
        token = request.headers.get("Authorization")

        if not token:
            return JsonResponse({"error": "Token missing"}, status=401)

        try:
            user_token = CustomToken.objects.get(key=token)
            request.user = user_token.user
        except CustomToken.DoesNotExist:
            return JsonResponse({"error": "Invalid token"}, status=401)

        return self.get_response(request)

AI写代码python
运行
1234567891011121314151617181920

然后,在 settings.py 中启用中间件:

ini 复制代码
MIDDLEWARE = [
    'django.middleware.security.SecurityMiddleware',
    'django.contrib.sessions.middleware.SessionMiddleware',
    'django.middleware.common.CommonMiddleware',
    'django.middleware.csrf.CsrfViewMiddleware',
    'django.middleware.authentication.AuthenticationMiddleware',
    'django.contrib.messages.middleware.MessageMiddleware',
    'django.middleware.clickjacking.XFrameOptionsMiddleware',
    'myapp.middleware.TokenMiddleware',  # 添加自定义 Token 认证中间件
]

AI写代码python
运行
12345678910

4. 受保护的 API

在 views.py 中定义需要 Token 认证的接口:

python 复制代码
from django.http import JsonResponse

def protected_view(request):
    return JsonResponse({"message": "Welcome, you are authenticated!"})

AI写代码python
运行
1234

5. 测试

  1. 获取 Token:

    bash 复制代码
    curl -X POST http://127.0.0.1:8000/custom_login/ -d "username=admin&password=admin"
    
    AI写代码sh
    1

    返回:

    json 复制代码
    {"token": "abc123xyz456"}
    
    AI写代码json
    1
  2. 访问受保护 API:

    bash 复制代码
    curl -X GET http://127.0.0.1:8000/protected_view/ -H "Authorization: abc123xyz456"
    
    AI写代码sh
    1

    返回:

    json 复制代码
    {"message": "Welcome, you are authenticated!"}
    
    AI写代码json
    1

五、总结

本方案介绍了 Django 中实现接口 Token 认证的两种方法:

  1. 使用 Django REST framework(DRF)的 Token 认证:适用于 REST API,简单易用。
  2. 自定义 Token 认证:适用于更灵活的需求,可定制 Token 规则、过期策略等。

以上代码和步骤确保了 API 的安全性,避免未经授权的访问,适用于 Django Web 项目的用户身份验证。

相关推荐
码事漫谈4 小时前
以后人人都可以成为导演
后端
Resean02234 小时前
Spring 源码分析(二)配置类的解析与扫描
java·后端·spring
一只爱撸猫的程序猿4 小时前
五周、两个开源仓库、九次拦截之后:AI 时代程序员缺的到底是什么
人工智能·后端·开源
北城笑笑6 小时前
Vue 110 ,若依SSE流式接口限次空500排查与解决
前端·javascript·vue.js·后端·vue
ServBay6 小时前
Local harness 将退役,VS Code 本地开发要不要搬到云端?
后端·ai编程·visual studio code
ashiho7 小时前
【LeetCode hot 100】3. 无重复字符的最长子串 (三种解法)
java·数据结构·后端·算法·leetcode·滑动窗口
张一凡938 小时前
你的 AGENTS.md,真的管到模型写代码了吗?
前端·后端·agent
00后程序员8 小时前
iOS 实时活动怎么开发,Windows 上用 KXBuild 和 ActivityKit 写灵动岛
后端·ios
程序员cxuan8 小时前
推荐 10 个 WorkBuddy 中的邪修用法
人工智能·后端·程序员
Bacon8 小时前
给项目做一次"全身 CT":Agent Skills 生态里的代码体检全链路
前端·人工智能·后端