测试平台开发（三）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

 转载请注明出处，商用请征得作者本人同意，谢谢！！！