Django学习笔记（16）——扩展Django自带User模型，实现用户注册与登录

一，项目题目：扩展Django自带User模型，实现用户注册与登录

　　我们在开发一个网站的时候，无可避免的需要设计实现网站的用户系统。此时我们需要实现包括用户注册，登录，用户认证，注销，修改密码等功能。Django作为一个完美主义者的终极框架，当然也会想到用户的这些痛点，它内置了强大的用户认证系——auth，所以本文在不建立User模型的情况下实现用户的注册，登录和认证。另外对Django Auth自带的User模型进行扩展，运行用户添加更多的个人信息。

 　　我在之前的Django学习笔记（9）——开发用户注册与登录系统 中已经完成了这个注册与登录系统，那么下面在这里写主要是向基于Django自带的User模型重新建立自己用户的模型。

二，项目需求

2.1 实现的功能需求

　　我们用Django2.0开发一个叫users的APP，来实现以下六项功能：

1. 用户注册：注册完成后转到登录页面
2. 用户登录：登录完成后转到用户资料页面
3. 用户资料页面：查看用户注册信息，并提供编辑资料按钮
4. 用户资料编辑：编辑完成后转到用户资料查看页面
5. 用户密码重置
6. 用户退出登录

2.2  扩展User模型的内容

　　由于Django Auth自带的User模型字段有限，我们还需要自定义模型UserProfile对其扩展。

　　（Auth组件的相关内容可以参考：Django学习笔记（13）——Django的用户认证组件，视图层和QuerySet API）

　　首先我们看一下Django Auth模块自带User模型所包含字段：

username：用户名

email: 电子邮件

password：密码

first_name：名

last_name：姓

is_active: 是否为活跃用户。默认是True

is_staff: 是否为员工。默认是False

is_superuser: 是否为管理员。默认是False

date_joined: 加入日期。系统自动生成。

　　下面展示我们自定义的UserProfile模型

user: 与User是1对1关系

org：用户名

telephone: 电话

mod_date: 最后修改日期。系统自动生成

　　

2.3  项目不足与改进

　　整个用户注册和登录非常简单，比如没有邮箱验证，也不能通过第三方APP授权登录，我做的页面也比较丑陋、一个更好的方式是使用以及成熟的第三方Django Package（比如django-allauth）来实现用户注册和登录。

 

三，编码规范需求

编码规范需求：

    1. 代码规范遵守pep8 (https://python.org/dev/peps/pep-0008/)

    2. 函数有相应的注释

    3. 程序有文档说明文件（README.md）

    4. 程序的说明文档必须包含的内容：程序的开发环境（django版本）、程序的实
现的功能、程序的启动方式、登录用户信息、程序的运行效果

    5. 程序设计的流程图：

　　

四，项目思路

　　基本的项目开启什么的都在这里不再阐述了，我直接写项目的主要思路，基础的Django操作流程看我之前的博客就行。

4.1  创建模型（Model）

　　到目前为止，我学习Django，第一步都是创建模型。为什么呢？因为大多数语言都遵循软件开发的设计模式MVC。

　　这里我们建立一个名称为UserProfile的模型，代码如下：

from django.db import models

# Create your models here.
from django.contrib.auth.models import User

class UserProfile(models.Model):
    user = models.OneToOneField(User, on_delete=models.CASCADE,
                                related_name='profile')
    # 模型类中设置:blank=True,表示代码中创建数据库记录时该字段可传空白(空串,空字符串)
    org = models.CharField('Organization', max_length=128, blank=True)
    telephone = models.CharField('Telephone', max_length=50, blank=True)
    mod_data = models.DateTimeField('Last modified', auto_now=True)

    class Meta:
        verbose_name = 'User profile'

    def __str__(self):
        # return self.user.__str__()
        return "{}".format(self.user.__str__())

　　注意：我们并没改变Django Auth 自带的User模型，也没有建立新的User模型。而UserProfile只是对User模型的扩展。找到users/models.py，并创建上面的UserProfile模型。由于我们引入了Django Auth自带的User模型，所以我们必须开始先把它import进来。

　　自定义的UserProfile模型新增字段的意思如下：

user: 与User是1对1关系

org：用户名

telephone: 电话

mod_date: 最后修改日期。系统自动生成

　　

4.2  配置URL

　　我比较习惯先写URL，再写视图View，从URL配置上，你应该可以理解我们想实现的六个功能。

　　下面是users/urls.py代码内容：

from django.urls import re_path, path
from users import views

app_name = 'users'

urlpatterns = [
    re_path(r'^register/$', views.register, name='register'),
    re_path(r'^login/$', views.login, name='login'),
    re_path(r'^user/(?P<pk>\d+)/profile/$', views.profile, name='profile'),
    re_path(r'^user/(?P<pk>\d+)/profile/update/$', views.profile_update, name='profile_update'),
    re_path(r'^user/(?P<pk>\d+)/pwd_change/$', views.pwd_change, name='pwd_change'),
    re_path(r"^logout/$", views.logout, name='logout'),
]

　　上面，我们使用 name= '?' ，比如第一个：我们这是给动态链接 /register/取了个名字 ‘register’，这样我们就可以在HTML模板里面通过 {% url 'users:register' %} 来调用这个链接了。

4.3  编写视图函数（View）

　　我们需要编写六个视图函数，正如上面url路径所指。

　　由于这六个视图中，register ， login，profile ， pwdChange这个四个视图都需要用到表单，所以我们先创建表单代码。

　　（表单代码我们可以分离出去，在users目录下创建MyForms.py文件，然后再在里面创建form表单，最后将其导入视图函数，这样代码显得工整，清晰，而且后期容易维护。还有MyForms.py可以通过clean方法自定义表单验证，非常便捷，而且逻辑更清晰）。

from django import forms
from django.contrib.auth.models import User
import re

def email_check(email):
    
    pattern = re.compile(r"\"?([-a-zA-Z0-9.'?{}]+@\w+\.\w+)\"?")
    return re.match(pattern, email)

class RegistrationForm(forms.Form):
    username = forms.CharField(label='Username', max_length=50)
    email = forms.EmailField(label='Email')
    password1 = forms.CharField(label='Password', widget=forms.PasswordInput)
    password2 = forms.CharField(label='Password Confirmation', widget=forms.PasswordInput)

    #user clean methods to define custom validation rules

    def clean_username(self):
        username = self.cleaned_data.get('username')
        if len(username) < 3:
            raise forms.ValidationError("your username must be at least 3 characters log")
        elif len(username) > 20:
            raise forms.ValidationError("your username is too long")
        else:
            filter_result = User.objects.filter(username__exact=username)
            if len(filter_result) > 0:
                raise forms.ValidationError('your username already exists')
        return username

    def clean_email(self):
        email = self.cleaned_data.get('email')
        if email_check(email):
            filter_result = User.objects.filter(email__exact=email)
            if len(filter_result) > 0:
                raise forms.ValidationError("your email already exists")
        else:
            raise forms.ValidationError("Please enter a valid email")

        return email

    def clean_password1(self):
        password1 = self.cleaned_data.get('password1')
        if len(password1) < 3:
            raise forms.ValidationError("your password is too short")
        elif len(password1) > 20:
            raise forms.ValidationError("your password is too long")

        return password1

    def clean_password2(self):
        password1 = self.cleaned_data.get('password1')
        password2 = self.cleaned_data.get('password2')

        if password1 and password2 and password1 != password2:
            raise forms.V