【问题标题】:Django routing with VueJS single page has unexpected behaviour when there is no trailing slash in the URL当 URL 中没有斜杠时,带有 VueJS 单页的 Django 路由会出现意外行为
【发布时间】:2020-03-17 04:10:57
【问题描述】:

我有一个 Django 后端和 VueJS 前端组合,我通过 Django 提供 REST API 和一个带有 VueJS 和 vue-router 的单页应用程序。

来自this 的问题,我得到了在我的主要 urls.py 中使用以下 url 的提示:

urlpatterns = [
    re_path(r'^(?P<filename>(robots.txt)|(humans.txt))$', views.home_files, name='home-files'),
    path('api/', include('backend.urls', namespace='api')),
    path('auth/', include('auth.urls')),
    path('admin/', admin.site.urls),
    re_path(r'^.*$', views.vue), # VueJS frontend
]

所以我希望 URL 的行为如下:

{baseDomain}/api/users/1/ -> go to backend.urls  
{baseDomain}/auth/login/ -> go to auth.urls  
{baseDomain}/admin/ -> go to admin page  
{baseDomain}/de/home -> vue-router takes over

现在这些 URL 工作得很好,但是我希望 {baseDomain}/api/users/1(没有尾部斜杠)仍然会转到 backend.urls,但是发生的情况是我登陆了 Vue 页面。

在 settings.py 中添加 APPEND_SLASH = True 也无济于事,因为它只会在找不到要加载的页面时附加斜线。但由于我的前端的正则表达式匹配任何东西,它总是重定向到 Vue。

我的尝试是通过添加以下内容来修复它:

re_path(r'.*(?<!/)$', views.redirect_with_slash)

使用以下代码:

def redirect_with_slash(request):
    '''Redirects a requested url with a slash at the end'''
    if request.path == '/':
        return render(request, 'frontend/index.html')
    return redirect(request.path + '/')

但它不是一个非常优雅的。还要注意if request.path == '/':。奇怪的是,Django 会将“/”与正则表达式 r'.*(?&lt;!/)$' 匹配,然后重定向到“//”,这是一个无效的 URL 并显示错误页面,所以我必须包含这个 if 语句。

有人对此有解决方案吗?在引用的问题中,这似乎不是问题,所以我想知道为什么它在我的项目中。

编辑:后端 urls.py

"""
backend urls.py
"""
from django.urls import include, path
from rest_framework_nested import routers
from auth.views import UserViewSet, GroupViewSet, ProjectViewSet
from .views import IfcViewSet, IfcFileViewSet

app_name = 'api'

router = routers.DefaultRouter() #pylint: disable=C0103
router.register(r'users', UserViewSet)
router.register(r'groups', GroupViewSet)
router.register(r'projects', ProjectViewSet)
projects_router = routers.NestedSimpleRouter(router, r'projects', lookup='project')
projects_router.register(r'models', IfcFileViewSet, base_name='projects-models')

urlpatterns = [
    path('', include(router.urls)),
    path('', include(projects_router.urls))
]

"""
auth urls.py
"""
from django.urls import path, include
from rest_framework import routers
from rest_framework_jwt.views import obtain_jwt_token, refresh_jwt_token
from .views import RegistrationViewSet

app_name = 'authentication'
router = routers.DefaultRouter()
router.register('register', RegistrationViewSet)

urlpatterns = [
    path('', include(router.urls)),
    path('', include('rest_auth.urls')),
    path('refresh_token/', refresh_jwt_token),
]

【问题讨论】:

  • 请添加您的backend.urls
  • @heemayl 刚刚添加了它们。我使用pypi.org/project/django-rest-framework-nested,您认为这可能是问题所在吗?
  • @heemayl 但 auth urls.py 中的 url 不应该工作吗?我在这里导入 vanilla DRF,但 {baseDomain}/auth/login 的行为仍然不像 {baseDomain}/auth/login/。

标签: python django vue.js routing trailing-slash


【解决方案1】:

问题是您在re_path(r'^.*$', views.vue) 中有一个包罗万象,因此如果任何URL 与早先的paths 不完全匹配,这将被触发。

Django 的 CommonMiddleware 实际上会附加一个尾部斜杠并重定向,当它找到一个 404 并且 URL 路径不以 / 结尾(取决于 APPEND_SLASH 设置),但这是响应。

在您的情况下,如果请求路径未以 / 结尾,您可以拥有一个附加斜杠的小型请求中间件,例如:

from django.shortcuts import redirect

class AppendTrailingSlashOnRequestMiddleware:

    def __init__(self, get_response):
        self.get_response = get_response

    def __call__(self, request):

        if not request.path.endswith('/'):
            query_string = request.META['QUERY_STRING']
            query_string = f'?{query_string}' if query_string else ''
            to_url = f'{request.path}/{query_string}'
            return redirect(to_url, permanent=True)

        response = self.get_response(request)

        return response

显然,将中间件添加到settings.MIDDLEWARE,最好将其放在顶部,以防止来自其他中间件的不必要处理,因为无论如何我们都会重定向,然后也需要处理。


但这有一个问题;进行重定向时,来自 POST/PUT/PATCH 的数据将丢失(这里我们正在执行 301,但同样适用于 302。Temporary Redirect 307 在这方面可以为我们提供帮助,而且好消息都是常规的 包括 IE 在内的浏览器都支持这个。但是 Django 没有开箱即用的功能。所以我们需要自己实现:

from django.http.response import HttpResponseRedirectBase

class HttpTemporaryResponseRedirect(HttpResponseRedirectBase):
    status_code = 307

现在,在中间件中导入它,并使用它来代替 redirect

class AppendTrailingSlashOnRequestMiddleware:

    def __init__(self, get_response):
        self.get_response = get_response

    def __call__(self, request):

        if not request.path.endswith('/'):
            query_string = request.META['QUERY_STRING']
            query_string = f'?{query_string}' if query_string else ''
            to_url = f'{request.path}/{query_string}'
            return HttpTemporaryResponseRedirect(to_url)  # here

        response = self.get_response(request)

        return response

注意:如果您想为 GET 保留浏览器缓存设施,您可以根据 request.method 重定向到 301/307。

【讨论】:

  • 像魅力一样工作!太感谢了。但是有两个后续问题:临时重定向和永久重定向(即 HTTP 308)有什么区别?我应该做一个 if 语句,其中我为 GET 和 HEAD 提供 status_code 301,为 POST 等提供 308 吗?第二个问题:为什么我在其他任何地方都找不到这个?我的设置有那么不寻常吗?有没有更聪明的方法来使用 Django 提供单页 web 应用程序?再次感谢
  • @Truning 哇。这么多问题:) 浏览器将缓存所有永久重定向,而临时重定向则不缓存。我使用 DRF 为我的 SPA 提供服务的方式是 Nginx 位于前面并将所有请求发送到 Vue 前端(它有自己的路由启用以访问各种东西),除了后端 API 路由,它直接进入 uWSGI(然后是 Django /DRF)。
  • 是的很多问题,很抱歉:D 完美,谢谢您的回答。我想 Apache 也可以实现类似的功能?
猜你喜欢
  • 1970-01-01
  • 1970-01-01
  • 2015-09-07
  • 2011-04-27
  • 2015-09-06
  • 1970-01-01
  • 2021-01-18
  • 1970-01-01
  • 2010-12-08
相关资源
最近更新 更多