博客

详解Django的 login_required() 函数：装饰器，限制未登录用户访问视图

  • Post category:Python

login_required()函数是Django中一个非常常用的装饰器（Decorator），它的作用是限制访问某些页面的权限，只有在用户登录的情况下才能访问，否则会自动重定向到登录页。接下来将详细介绍它的用法和两个实例说明。

使用方法

在使用login_required()函数时，需要在视图函数前加上装饰器，并且如用户未登录，则重定向到指定的登录页面，示例代码如下：

from django.contrib.auth.decorators import login_required

@login_required(login_url='user_login')
def index(request):
    pass

上述代码中，将login_required()函数作为装饰器，应用到index视图函数上。当用户未登录时，会自动跳转到user_login页面。

login_required()函数还支持自定义功能，在login_required装饰器中可以配置以下参数：

  • login_url: 用于存储需要重定向的网页地址，例如，login_url='user_login'，Django 会自动跳转到名为user_login的url，即登录页面。默认值是settings.LOGIN_URL。
  • redirect_field_name: 当用户被重定向至登录页面类型的url时，redirect_field_name参数可指定需要被存储在会话中的键名，默认值是next。

第一个实例

在这个例子中，我们的应用只在用户登录后才能够访问，并在登录成功后，重定向到主页。

from django.contrib.auth.decorators import login_required
from django.shortcuts import render
from django.urls import reverse

@login_required(login_url='user_login')
def home(request):
    return render(request, 'home.html')

def user_login(request):
    if request.method == 'POST':
        # insert authentication logic here
        return redirect(reverse('home'))
    else:
        return render(request, 'login.html')

上述的示例代码中，我们定义了两个视图函数–home和user_login，分别对应主页视图和登录视图。由于登录之后才能进入主页视图，所以我们在home函数中添加了login_required()函数作为装饰器，在用户未登录时自动跳转到user_login视图页面。

在user_login视图中，我们采用了一个简单的表单来处理用户认证逻辑，当用户通过表单验证时，我们使用redirect()函数让应用重定向到主页。

第二个实例

在此示例中，我们将演示如何禁止用户访问特定角色或权限下的页面。假定我们想要禁止普通用户访问一个面向管理员的视图。

from django.contrib.auth.decorators import login_required, user_passes_test
from django.shortcuts import render

def is_admin(user):
    return user.is_authenticated and user.is_superuser

@login_required(login_url='accounts/login/')
@user_passes_test(is_admin, login_url='user_home')
def admin_dashboard(request):
    return render(request, 'admin_dashboard.html')

上述代码中，is_admin()函数用于检查用户是否为管理员。 如果用户是通过验证的超级用户（即拥有管理员权限），则返回True。

在admin_dashboard视图中，将login_required()和user_passes_test()函数作为装饰器使用，并提供了两个登录url。因此，如果用户未登录，则会重定向到默认的登录页面，如果用户已登录，但不是管理员，则会重定向到自定义的无权限访问页面，即user_home页面。

总结：

login_required()是Django框架下的一种非常重要的装饰器，可以用于限制用户的访问权限，同时提高了应用的安全性。 在应用程序开发中，我们可以根据需要使用各种参数，如自定义登录页面，禁止特定角色或权限的页面等，实现更为灵活的应用场景。

Tags: