測試平台開發（三）Django實現登錄注冊功能

在Django中通常一個功能的開發順序為：創建應用 -> 數據庫表字段設計 -> 視圖函數編寫 -> 應用路由 -> 全局路由 -> 測試

Django的工作流程是：

 

一、創建用戶應用

打開 Tools > Run manage.py Task…，運行 startapp空格加應用名稱

startapp users　　# startapp:創建應用的關鍵字，user:為應用的名字

生成應用后一定要記得將應用名加入到settings.py文件里名為INSTALLED_APPS的列表中，遵循規范加入到列表的最后，再添加應用也一樣

# settings.py
INSTALLED_APPS=[
　　……,
　　'users',
]

應用目錄詳解

users
 ├── migrations　　# 存放遷移數據表的歷史文件，內容自動生成
 │    └── __init__.py　　# 一個空文件，告訴 Python 該目錄是一個 Python 包。
 ├── __init__.py　　# 一個空文件，告訴 Python 該目錄是一個 Python 包。
 ├── admin.py　　# 該應用的后台管理系統配置，這里用不到
 ├── apps.py　　　　# 該應用的一些配置,這里用不到
 ├── models.py　　　　# 數據模塊,用來定義數據表結構
 ├── tests.py　　　　# Django提供的自動化測試功能,這里用不到
 └── views.py　　　　# 視圖模塊，代碼邏輯處理的主要地點,項目中大部分代碼均在這里編寫

 

二、編寫數據模型

創建時間、修改時間和邏輯刪除這些字段會經常用到，每次都寫代碼會很冗余，解決辦法就是寫一個類繼承使用

1.在項目跟目錄下創建utils目錄，再在utils目錄下創建base_models.py文件

# utils/base_models.py
from django.db import models


class BaseModel(models.Model):
    """
    數據庫表公共字段
    """
    create_time = models.DateTimeField(auto_now_add=True, verbose_name='創建時間', help_text='創建時間')
    update_time = models.DateTimeField(auto_now=True, verbose_name='更新時間', help_text='更新時間')
    is_delete = models.BooleanField(default=False, verbose_name='邏輯刪除', help_text='邏輯刪除')

    class Meta:
        # abstract = True：為抽象模型類，用於其他模型類繼承，數據庫遷移時不會創建ModelBase表
        abstract = True
        verbose_name = '公共字段表'
        db_table = 'BaseModel'

 

2.編寫用戶表的模型，繼承上面的類

#users/models.py
from django.db import models

from utils.base_models import BaseModel


class Users(BaseModel):
    id = models.AutoField(primary_key=True, verbose_name='id主鍵')
    username = models.CharField(max_length=50, unique=True, verbose_name='用戶名')
    password = models.CharField(max_length=50, verbose_name='密碼')
    email = models.EmailField(max_length=50, verbose_name='郵箱')

    def __str__(self):
        return self.username

    class Meta:
        db_table = 'lx_users'
        verbose_name = '用戶數據'
        verbose_name_plural = verbose_name

遷移數據庫，打開 Tools > Run manage.py Task…，依次行

makemigrations
migrate

 

三、編寫視圖函數

1.先把需要用的token認證機制寫出來，token 這里使用Python中的 pyjwt 庫

1.1 安裝 pip install pyjwt

pip install pyjwt

1.2 生成token，在users目錄下邊創建generate_token.py文件

# users/generate_token.py
from datetime import datetime, timedelta
import jwt

from django.conf import settings

def generate_jwt_token(username):
    token = jwt.encode({
        'exp': datetime.utcnow() + timedelta(days=1),
        'iat': datetime.utcnow(),
        'data': {
            'username': username
        }
    }, settings.SECRET_KEY, algorithm='HS256')
    return token.decode('utf-8')

1.3 認證token的裝飾器，在utils目錄下創建jwt_permission_required.py文件

# utils/jwt_permission_required.py
import jwt
from django.conf import settings
from django.http import JsonResponse
from users.models import Users


def auth_permission_required(func):
    def decorator(view_func):
        def _wrapped_view(request, *args, **kwargs):
            try:
                if func == "func":
                    auth = request.META.get('HTTP_AUTHORIZATION').split()
                else:
                    auth = request.request.META['HTTP_AUTHORIZATION'].split()
            except AttributeError:
                return JsonResponse({"status_code": 401, "message": "沒有權限"})
            if auth[0].lower() == 'token':
                try:
                    dict = jwt.decode(auth[1], settings.SECRET_KEY, algorithms=['HS256'])
                    username = dict.get('data').get('username')
                except jwt.ExpiredSignatureError:
                    return JsonResponse({"status_code": 401, "message": "token 已過期"})
                except jwt.InvalidTokenError:
                    return JsonResponse({"status_code": 401, "message": "token 無效"})
                except Exception as e:
                    return JsonResponse({"status_code": 401, "message": "無法獲取用戶對象"})
                try:
                    Users.objects.get(username=username)
                except Users.DoesNotExist:
                    return JsonResponse({"status_code": 401, "message": "用戶不存在"})
            else:
                return JsonResponse({"status_code": 401, "message": "不支持身份驗證類型"})
            return view_func(request, *args, **kwargs)
        return _wrapped_view
    return decorator

 

2. 返回的參數格式需要統一規范，在utils目錄下創建common.py文件來放一些公共配置，寫一個result字典，所有返回格式都用這個

# utils/common.py
result = {
    "message": None,
    "success": False,
    "details": None
}

 

3.表單校驗，在users目錄下創建forms.py文件，用來校驗用戶注冊時輸入的數據

# users/forms.py
import re

from django import forms
from django.core.exceptions import ValidationError

from users.models import Users


class RegisterForm(forms.Form):
    username = forms.CharField(
        label="用戶名",
        required=True,
        max_length=50,
        min_length=2,
        error_messages={
            "required": "用戶名不能為空",
            "max_length": "用戶名最長不能超過50個字符",
            "min_length": "用戶名最小長度為2"
        })
    password = forms.CharField(
        label="密碼",
        required=True,
        max_length=50,
        min_length=5,
        error_messages={
          "required": "密碼不能為空",
          "max_length": "密碼最長不能超過50個字符",
          "min_length": "密碼最小長度為5"
        })
    r_password = forms.CharField(
        required=True,
        max_length=50,
        min_length=5,
        label="確認密碼",
        error_messages={
            "required": "確認密碼不能為空",
            "max_length": "確認密碼最長不能超過50個字符",
            "min_length": "確認密碼最小長度為5"
        })
    email = forms.CharField(
        min_length=5,
        required=True,
        label="郵箱",
        error_messages={
            "required": "郵箱不能為空",
            "max_length": "郵箱最長不能超過50個字符",
            "min_length": "郵箱最小長度為5"
        }
    )

    def clean_username(self):
        val = self.cleaned_data.get("username")
        ret = Users.objects.filter(username=val)
        if not ret:
            return val
        else:
            raise ValidationError("該用戶名已注冊!")

    def clean_email(self):
        val = self.cleaned_data.get("email")
        if re.match(r'^[0-9a-zA-Z_]{0,19}@[0-9a-zA-Z]{1,13}\.[com,cn,net]{1,3}$', val):
            return val
        else:
            raise ValidationError("郵箱格式不正確!")

    # 走完所有的校驗才走clean
    def clean(self):
        pwd = self.cleaned_data.get("password")
        r_pwd = self.cleaned_data.get("r_password")
        if pwd and r_pwd:
            if pwd != r_pwd:
                raise forms.ValidationError("兩次密碼不一致")
        return self.cleaned_data

 

4.編寫用戶應用的視圖函數

# users/views.py
from django.http import JsonResponse
from django.views import View

from users.forms import RegisterForm
from users.generate_token import generate_jwt_token
from users.models import Users
from utils.jwt_permission_required import auth_permission_required
from utils.common import result


class LoginView(View):
    def post(self, request):
        result["message"] = "登錄失敗"
        result["success"] = False
        result["details"] = None
        json_data = request.body.decode('utf-8')
        if json_data:
            python_data = eval(json_data)
            username = python_data.get('username')
            password = python_data.get('password')
            data = Users.objects.filter(username=username, password=password).values("id", "username").first()
            if data:
                token = generate_jwt_token(username)
                result["message"] = "登錄成功"
                result["success"] = True
                result["details"] = {"id": data["id"], "username": data["username"],"token": token}
                return JsonResponse(result, status=200)
            result["details"] = "用戶名或密碼錯誤"
            return JsonResponse(result, status=400)
        return JsonResponse(result, status=500)


class RegisterView(View):
    def post(self, request):
        result["message"] = "注冊失敗"
        result["success"] = False
        result["details"] = None
        json_data = request.body.decode('utf-8')
        if json_data:
            python_data = eval(json_data)
            data = RegisterForm(python_data)
            if data.is_valid():
                data.cleaned_data.pop("r_password")
                Users.objects.create(**data.cleaned_data)
                data.cleaned_data.pop("password")
                result["message"] = "注冊成功"
                result["success"] = True
                result["details"] = data.cleaned_data
                return JsonResponse(result, status=200)
            else:
                result["details"] = data.errors
                return JsonResponse(result, status=400)
        return JsonResponse(result, status=500)

@auth_permission_required("func")
def demo(request):
    if request.method == 'GET':
        return JsonResponse({"state": 1, "message": "token有效"})
    else:
        return JsonResponse({"state": 0, "message": "token無效"})

 

四、編寫應用的路由

在users目錄下創建urls.py文件

#users/urls.py
from django.urls import path

from users import views

urlpatterns = [
    path('login', views.LoginView.as_view()),
    path('register', views.RegisterView.as_view()),
    path('demo', views.demo)
]

 

五、定義全局路由

# testplatform/urls.py
from django.contrib import admin
from django.urls import path, include

urlpatterns = [
    path('admin/', admin.site.urls),
    path('api/user/', include("users.urls")),
]

 

六、測試

1.注冊接口

2.登錄接口

3.token驗證接口

　　3.1 不帶token

　　

　　3.2 帶token

　　

 

 

GitHub持續更新：地址https://github.com/debugf/testplatform

 

 轉載請注明出處，商用請征得作者本人同意，謝謝！！！