Django 中@login_required 配置详解

在 Django 中对 @login_required 进行配置，主要涉及全局配置和视图函数局部配置两方面，下面为你详细介绍配置方法。

全局配置

全局配置主要是设定默认的登录 URL，也就是当未登录用户尝试访问被 @login_required 装饰的视图时，会被重定向到的页面。你可以在项目的 settings.py 文件里对这个默认的登录 URL 进行配置。

步骤

1. 打开项目的 settings.py 文件。
2. 添加或修改 LOGIN_URL 设置。

示例

python

# settings.py# 其他配置...# 设置默认登录 URL
LOGIN_URL = '/custom-login/'# 其他配置...

在这个示例里，LOGIN_URL 被设置为 /custom-login/，这意味着当未登录用户访问被 @login_required 装饰的视图时，会被重定向到 /custom-login/ 页面进行登录。

局部配置

除了全局配置，你还能在视图函数中使用 @login_required 装饰器时，通过参数进行局部配置。

1. 指定登录 URL

实例一：保护视图函数

你可以使用 login_url 参数为特定的视图指定登录 URL，这样就会覆盖全局的 LOGIN_URL 设置。

python

# views.py
from django.contrib.auth.decorators import login_required
from django.shortcuts import render@login_required(login_url='/another-login/')
def protected_view(request):return render(request, 'protected.html')

在这个示例中，protected_view 视图使用 @login_required 装饰器时，通过 login_url 参数指定了登录 URL 为 /another-login/，所以未登录用户访问该视图时会被重定向到这个自定义的登录页面。

实例二：保护整个URL模式

如果我们有一组共享相同URL前缀的视图函数需要进行登陆认证，这时我们可以使用Django的URLDispatcher来保护整个URL模式，示例如下：

from django.urls import path
from django.contrib.auth.decorators import login_required
from .views import view1, view2, view3urlpatterns = [path('protected/', login_required(view1), name='url1'),path('protected/', login_required(view2), name='url2'),path('protected/', login_required(view3), name='url3'),
]

在这个例子中，我们给一组路由添加了 login_required 装饰器，这样只有在已登录的情况下才能访问它们。

2. 指定登录成功后的重定向参数名

可以使用 redirect_field_name 参数指定登录成功后重定向到原请求页面时使用的查询参数名，默认是 next。

python

# views.py
from django.contrib.auth.decorators import login_required
from django.shortcuts import render@login_required(redirect_field_name='redirect_to')
def another_protected_view(request):return render(request, 'another_protected.html')

在这个示例中，登录成功后，会尝试从请求的 redirect_to 参数中获取要重定向的 URL。

基于类的视图配置

如果你使用的是基于类的视图，需要使用 LoginRequiredMixin 来实现类似功能，同样可以进行配置。

python

# views.py
from django.views.generic import TemplateView
from django.contrib.auth.mixins import LoginRequiredMixinclass ProtectedTemplateView(LoginRequiredMixin, TemplateView):template_name = 'protected_template.html'login_url = '/custom-login/'  # 指定登录 URLredirect_field_name = 'go_to'  # 指定重定向参数名

在这个基于类的视图示例中，通过 login_url 和 redirect_field_name 属性进行了相应的配置。

综上所述，你可以根据需求对 @login_required 进行全局和局部配置，以满足不同视图的登录重定向需求。

其他特殊配置

可以使用 urls.py 中定义的 URL 名称（name）来配置 LOGIN_URL。在 Django 里，LOGIN_URL 不仅可以设置为具体的 URL 路径，还能使用 URL 名称，通过 Django 的 reverse 函数将其解析为对应的 URL。

步骤

1. 在 urls.py 中定义登录视图的 URL 并命名

首先，确保在你的 urls.py 文件里定义了登录视图的 URL，并且给它设置了一个名称。示例如下：

python

# myapp/urls.py
from django.urls import path
from .views import custom_login_viewurlpatterns = [path('custom-login/', custom_login_view, name='custom_login'),
]

2. 在 settings.py 中使用 URL 名称配置 LOGIN_URL

接着，在项目的 settings.py 文件中，使用 reverse_lazy 函数（它是 reverse 函数的惰性版本，适用于在设置文件中使用）来配置 LOGIN_URL。示例如下：

python

# settings.py
from django.urls import reverse_lazy# 其他配置...# 使用 URL 名称配置 LOGIN_URL
LOGIN_URL = reverse_lazy('custom_login')# 其他配置...

3. 确保 reverse_lazy 正常工作

要保证 reverse_lazy 能够正常解析 URL 名称，需要确保你的 urls.py 配置正确，并且在项目启动时可以被正确加载。

原理说明

• reverse_lazy 函数会在运行时将 URL 名称解析为对应的 URL 路径。
• 使用 reverse_lazy 而不是 reverse 是因为在设置文件加载时，URL 配置可能还未完全加载，reverse_lazy 会在实际需要解析 URL 时才进行操作，避免出现错误。

通过这种方式，你可以使用 urls.py 中定义的 URL 名称来配置 LOGIN_URL，这样在修改 URL 路径时，只需修改 urls.py 中的定义，而无需在 settings.py 中手动更新具体的 URL 路径。