Django auth应用模块详解

目录

• Django auth应用模块是什么？
• Django auth应用模块使用方法
  • 设置认证
  • 内置视图
• 自定义视图和表单
• 扩展 User 模型
• 总结

Django auth应用模块是什么？

Django auth 应用模块是 Django 框架提供的一个内置应用模块，用于管理用户认证、用户权限、密码重置等与用户身份验证相关的任务。它提供了许多可以直接使用的视图、表单和模板，以简化身份验证相关的编程。

Django auth 模块的主要组件包括以下几个部分：

• User 模型：Django auth 模块提供了一个 User 模型，它可以用于存储用户的基本信息，例如用户名、电子邮件地址和密码等。如果需要扩展 User 模型，可以使用 AbstractUser 类，或者自定义一个 User 模型。

• 用户认证视图：Django auth 模块提供了几个视图，用于处理用户认证相关的任务，例如登录、注销、注册、密码重置等。这些视图可以直接使用，也可以进行自定义。

• 表单：Django auth 模块提供了一些表单，用于处理用户认证相关的数据，例如登录表单、注册表单、密码重置表单等。这些表单可以直接使用，也可以进行自定义。

• 权限系统：Django auth 模块提供了一个基于组和权限的权限系统，用于管理用户对应用程序中的不同资源的访问权限。用户可以分配到一个或多个组，每个组都可以关联一组权限。开发人员可以使用这个权限系统来定义应用程序中的资源，并控制哪些用户可以访问它们。

• 模板标签和上下文处理器：Django auth 模块提供了一些方便的模板标签和上下文处理器，用于在模板中方便地访问用户认证相关的信息，例如当前登录的用户、登录状态等。

下面是一些常用的 Django auth 模块的功能：

• 用户注册和登录：Django auth 模块提供了方便的视图和表单，用于处理用户注册和登录。开发人员只需要使用这些视图和表单，就可以快速构建一个安全的用户认证系统。

• 密码重置：Django auth 模块提供了一个方便的视图和表单，用于处理密码重置请求。当用户忘记密码时，他们可以通过这个功能来重置密码。

• 用户管理：Django auth 模块提供了一些视图和表单，用于管理用户，例如添加、删除、编辑用户信息等。

• 权限管理：Django auth 模块提供了一个基于组和权限的权限系统，可以用于管理用户对应用程序中的资源的访问权限。

• 用户状态管理：Django auth 模块提供了一些视图和表单，用于管理用户的登录状态。例如，可以在用户登录时设置一个“记住我”选项，使用户可以在关闭浏览器后保持登录状态。

接下来我们通过一个实例，详细了解如何设置认证、如何使用内置的视图和表单、如何扩展 User 模型等内容。

Django auth应用模块使用方法

设置认证

在 Django 中使用 auth 应用模块前，需要先在 INSTALLED_APPS 中添加 django.contrib.auth 应用：

# settings.py
INSTALLED_APPS = [
    # ...
    'django.contrib.auth',
    # ...
]

然后，在 urls.py 中添加 auth 应用模块的 URL 配置：

# urls.py
from django.urls import include, path

urlpatterns = [
    # ...
    path('accounts/', include('django.contrib.auth.urls')),
    # ...
]

这个 URL 配置将会使 Django 自动使用 auth 应用模块提供的视图来处理用户认证相关的请求，例如 /accounts/login/、/accounts/logout/、/accounts/password_reset/ 等。

内置视图

Django auth 应用模块提供了许多内置的视图，可以直接在 urls.py 中使用。

登录视图

使用 LoginView 类来处理用户登录请求：

# urls.py
from django.urls import path
from django.contrib.auth.views import LoginView

urlpatterns = [
    path('login/', LoginView.as_view(template_name='login.html'), name='login'),
    # ...
]

LoginView 类使用的模板可以自定义，上面代码中的 template_name 参数指定了使用的模板文件。

注销视图

使用 LogoutView 类来处理用户注销请求：

# urls.py
from django.urls import path
from django.contrib.auth.views import LogoutView

urlpatterns = [
    path('logout/', LogoutView.as_view(), name='logout'),
    # ...
]

注册视图

使用 UserCreationForm 类来处理用户注册请求：

# urls.py
from django.urls import path
from django.contrib.auth.views import LoginView, LogoutView
from django.contrib.auth.forms import UserCreationForm
from django.views.generic.edit import CreateView

urlpatterns = [
    path('register/', CreateView.as_view(template_name='register.html', form_class=UserCreationForm, success_url='/accounts/login/'), name='register'),
    # ...
]

UserCreationForm 类是一个内置的表单，用于创建新的用户。上面代码中的 template_name 参数指定了使用的模板文件，form_class 参数指定了使用的表单类，success_url 参数指定了注册成功后要跳转的页面。

密码重置视图

使用 PasswordResetView 类来处理密码重置请求：

# urls.py
from django.urls import path
from django.contrib.auth.views import PasswordResetView

urlpatterns = [
    path('password_reset/', PasswordResetView.as_view(template_name='password_reset.html'), name='password_reset'),
    # ...
]

密码重置确认视图

使用 PasswordResetConfirmView 类来处理密码重置确认请求：

# urls.py
from django.urls import path
from django.contrib.auth.views import PasswordResetConfirmView

urlpatterns = [
    path('reset/<uidb64>/<token>/', PasswordResetConfirmView.as_view(template_name='password_reset_confirm.html'), name='password_reset_confirm'),
# ...
]

密码重置完成视图

使用 PasswordResetCompleteView 类来处理密码重置完成请求：

# urls.py
from django.urls import path
from django.contrib.auth.views import PasswordResetCompleteView

urlpatterns = [
    path('reset/done/', PasswordResetCompleteView.as_view(template_name='password_reset_complete.html'), name='password_reset_complete'),
    # ...
]

自定义视图和表单

除了使用内置的视图和表单外，我们还可以自定义视图和表单来处理用户认证相关的请求。

自定义登录视图和表单

# views.py
from django.contrib.auth import authenticate, login
from django.shortcuts import render, redirect
from django.contrib.auth.forms import AuthenticationForm

def custom_login(request):
    if request.method == 'POST':
        form = AuthenticationForm(request=request, data=request.POST)
        if form.is_valid():
            username = form.cleaned_data.get('username')
            password = form.cleaned_data.get('password')
            user = authenticate(request, username=username, password=password)
            if user is not None:
                login(request, user)
                return redirect('home')
    else:
        form = AuthenticationForm()
    return render(request, 'custom_login.html', {'form': form})

# urls.py
from django.urls import path
from .views import custom_login

urlpatterns = [
    path('login/', custom_login, name='login'),
    # ...
]

在上面的示例中，我们自定义了一个 custom_login 视图和一个 AuthenticationForm 表单，用于处理用户登录请求。在视图中，我们首先检查请求的方法是否为 POST，如果是，则将请求中的表单数据传递给 AuthenticationForm 表单进行验证。如果表单数据有效，则使用 authenticate 函数来验证用户身份。如果用户身份验证成功，则调用 login 函数将用户登录到系统中。

自定义注册视图和表单

# views.py
from django.contrib.auth import login
from django.shortcuts import render, redirect
from django.contrib.auth.forms import UserCreationForm

def custom_register(request):
    if request.method == 'POST':
        form = UserCreationForm(request.POST)
        if form.is_valid():
            user = form.save()
            login(request, user)
            return redirect('home')
    else:
        form = UserCreationForm()
    return render(request, 'custom_register.html', {'form': form})

# urls.py
from django.urls import path
from .views import custom_register

urlpatterns = [
    path('register/', custom_register, name='register'),
    # ...
]

在上面的示例中，我们自定义了一个 custom_register 视图和一个 UserCreationForm 表单，用于处理用户注册请求。在视图中，我们首先检查请求的方法是否为 POST，如果是，则将请求中的表单数据传递给 UserCreationForm 表单进行验证。如果表单数据有效，则使用 save 方法将用户信息保存到数据库中，并使用 login 函数将用户登录到系统中。

扩展 User 模型

如果我们需要在 User 模型中添加自定义的字段，可以使用 Django 提供的 AbstractBaseUser 和 BaseUserManager 类来自定义 User 模型。

# models.py
from django.contrib.auth.models import AbstractBaseUser, BaseUserManager

class CustomUserManager(BaseUserManager):
    def create_user(self, email, password=None, **extra_fields):
        if not email:
            raise ValueError('The Email field must be set')
        email = self.normalize_email(email)
        user = self.model(email=email, **extra_fields)
        user.set_password(password)
        user.save(using=self._db)
        return user

    def create_superuser(self, email, password=None, **extra_fields):
        extra_fields.setdefault('is_staff', True)
        extra_fields.setdefault('is_superuser', True)
        return self.create_user(email, password, **extra_fields)

class CustomUser(AbstractBaseUser):
    email = models.EmailField(unique=True)
    first_name = models.CharField(max_length=30)
    last_name = models.CharField(max_length=30)
    is_active = models.BooleanField(default=True)
    is_staff = models.BooleanField(default=False)

    objects = CustomUserManager()

    USERNAME_FIELD = 'email'
    REQUIRED_FIELDS = ['first_name', 'last_name']

    def __str__(self):
        return self.email

    def has_perm(self, perm, obj=None):
        return True

    def has_module_perms(self, app_label):
        return True

在上面的示例中，我们定义了一个 CustomUserManager 类和一个 CustomUser 类来扩展 User 模型。在 CustomUserManager 类中，我们重写了 create_user 和 create_superuser 方法来创建普通用户和超级用户。在 CustomUser 类中，我们定义了自定义的字段，如 email、first_name 和 last_name。还重写了 str、has_perm 和 has_module_perms 方法。

接下来，我们需要在 settings.py 文件中配置 AUTH_USER_MODEL 为我们自定义的 User 模型：

# settings.py
AUTH_USER_MODEL = 'myapp.CustomUser'

现在我们就可以使用自定义的 User 模型了。例如，在视图中创建用户：

from django.contrib.auth import get_user_model

CustomUser = get_user_model()

def create_user(request):
    user = CustomUser.objects.create_user(email='[e-mail]', password='password123', first_name='John', last_name='Doe')
    # ...

总结

以上就是 Django auth 应用模块的完整攻略，我们学习了如何使用内置的视图和表单来处理用户认证相关的请求，以及如何自定义视图和表单。还学习了如何扩展 User 模型来添加自定义的字段。使用 Django auth 应用模块可以快速方便地实现用户认证和授权功能，大大提高开发效率。