欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

python-django中的APPEND_SLASH实现

程序员文章站 2022-07-10 22:38:53
关于django中的APPEND_SLASH 它是啥? 看变量名大概能知道做什么,就是添加斜线,用路由系统那里。 路由文件,只写了路由关系代码 APPEND_SLASH这个常量默认为True,就是假如你没有添加斜线,他会帮你添加上(总体是这样,具体得看源码怎么写的了) 执行命名行代码启动django ......

关于django中的append_slash

append_slash 它是啥?

看变量名大概能知道做什么,就是添加斜线,用路由系统那里。

路由文件,只写了路由关系代码

......
urlpatterns = [
    url(r'^test/$', views.test),
]
......

append_slash这个常量默认为true,就是假如你没有添加斜线,他会帮你添加上(总体是这样,具体得看源码怎么写的了)

执行命名行代码启动django项目

python manage.py runserver

目前append_slash=true,我们打开浏览器的开发者工具,查看网络请求,输入127.0.0.1:8000/test 这里我是没有加斜线的

python-django中的APPEND_SLASH实现

仔细看下网络请求,我们输入127.0.0.1:8000/test,看起来只发送了一次,其实真实发送了两次请求。

我们继续再访问这个url:127.0.0.1:8000/test11,看看请求

python-django中的APPEND_SLASH实现

我们也同样访问了一个url,但是这次和上面不同的是,只发送了一次请求。

两次都是发送一个get请求,访问服务器的一个资源。

第一次请求的url为127.0.0.1:8000/test,我们的路由关系中是没有这个url的,对没错,如果访问想要访问到服务器的资源必须为这样的url才行127.0.0.1:8000/test/,虽说这两个url看起来差不多,但其实差很多的。但是第一次请求的url只需在最后加上/,就能访问到资源了,这就是append_slash的作用。

第二次请求的url为127.0.0.1:8000/test11,这个地址也不在我们的路由关系中,况且加上了/,也不能访问到资源。所以总共发送了一次,最终返回了404错误。

先大致总结下:append_slash=true的情况下,先会根据前端传来的url,先检测这个url能不能访问资源,如果可以访问的话,那么就去执行相应的业务代码,最后返回。如果这个url不能访问到资源的话,会判断这个url最后有没有/,有/的话,则返回404错误;如果没有/的话,便会帮你加上/,生成一个新的url,再去检测这个新的url能不能访问到资源,如果能访问的话,则返回301的状态码,并将这个新的url传到前端,进行重定向操作(这就是我们第一次请求出现的情况),如果这个新的url(帮你加上/的)还是不能访问到资源的话,也会返回404错误(这就是我们第二次请求出现的情况)。这就是对上面出现情况的总结吧(具体流程还得去看源码)

那么append_slash=false的情况,就不会帮你加/,你前台传怎样的url,那就用这个url去访问资源,能不能访问还得看你url对不对。

在走到路由层之前,请求会先走到中间件这一层,在这一层就执行了上面分析的逻辑

这一个中间件实现了上面的逻辑 'django.middleware.common.commonmiddleware',请求来的时候,会走这个中间件的process_request方法,下面来看这个方法写了什么

python-django中的APPEND_SLASH实现

看这一句注释:# check if a slash should be appended,检测是否需要加上斜线

看这个方法should_redirect_with_slash,返回值为bool类型。返回true的情况是,append_slash=true,这个url不是以/结尾的,并且这个url添加上了/,能够访问资源的。必须满足这三种情况,返回值为true,其他情况的话返回就是false。

下面贴上should_redirect_with_slash的源码

def should_redirect_with_slash(self, request):
    """
    return true if settings.append_slash is true and appending a slash to
    the request path turns an invalid path into a valid one.
    """
    if settings.append_slash and not request.path_info.endswith('/'):
        urlconf = getattr(request, 'urlconf', none)
        return (
            not is_valid_path(request.path_info, urlconf) and
            is_valid_path('%s/' % request.path_info, urlconf)
        )
    return false

就说下 is_valid_path方法有啥作用吧。你可以去看源码具体了解

is_valid_path 检测传进去的url,是否能访问到资源。(说白了就是判断这个url是否存在我们定义的url映射中)

这样的话,上面这段代码就很简单了。首先判断append_slash,如果为false的。那么这个方法should_redirect_with_slash直接返回false。如果append_slash为true的话,再对请求的url进行判断,request.path_info它的值并不是一个完整的url,而是ip+端口后面的那一部分(也就是例子中的/test),判断它是否以斜线(/)结尾的,如果是的话,那么not request.path_info.endswith('/') 整体就为false,所以if判断后面的表达式就为false,最终返回了false。如果不是以斜线(/)结尾的话,那么if后面的表达式就为true,那么继续执行条件为真的代码块,这个代码块最终返回了一个表达式的结果,这个表达式类型是这样 bool and bool。也就是根据方法is_valid_pathd的返回值进行判断的,如果request.path_info(代码能分析到这里说明它不是以斜线结尾的),首先判断这个值能不能在我们写的路由关系映射中存不存在。存在的话,方法is_valid_path返回真,那么not true就为false,and左边的表达式为false,整体的表达式就为false,所以最终返回的就是false。如果request.path_info的值在路由关系映射中不存在,那么and左边的表达式为true,那就继续看and右边表达式的布尔值。and右边还是调用了方法is_valid_path,只不过传的参数是request.path_info + /,如果在路由映射中存在,那么最终返回true,如果不存在,那么就返回了false了。

should_redirect_with_slash方法分析完毕,继续看源码

# check if a slash should be appended
if self.should_redirect_with_slash(request):
    path = self.get_full_path_with_slash(request)
else:
    path = request.get_full_path()

后面根据should_redirect_with_slash方法的返回值,做了不同的操作。不严格来说,不管true还是false,最终执行了requests.get_full_path这个方法,只不过传入的参数不同的,最终返回了一个完整的url请求地址。

继续往下看

# return a redirect if necessary
if redirect_url or path != request.get_full_path():
    redirect_url += path
    return self.response_redirect_class(redirect_url)

如果if后面的表达式为true的话,最终稿返回了一个状态码为301的httpresponse对象,这个对象里带这一个数据,这个数据就是在原url基础上加上斜线(/)的新url,前端接收到状态码为301的响应,则会继续请求响应中携带的新地址。为false的话,返回默认返回none。

django的中间件会根据每个中间件里的process_request方法或者process_response方法不同的返回值会执行相应的操作,具体操作不说了,不是这个知识点的内容。

那么中间件的process_request返回none的话,则会执行下一个中间件的process_request的方法。如果返回的是httpresponse对象的话,则不会继续执行下一个中间件的process_request方法,则会执行process_response方法。具体从哪个中间件执行和django的版本有关系,反正是不会执行路由对应的视图代码的代码,会直接返回给前端httpresoonse对象。

好了,关于append_slash的知识总结完毕。append_slash它默认为true,如果想要修改的话,需要在settings.py文件中定义这个常量,赋值为false,这样就可以覆盖原django中配置文件里对应的常量了。至于django内部怎么操作的,下次再总结吧

最后还是补个图吧,我把append_slash设置为false,访问127.0.0.1:8000/test

python-django中的APPEND_SLASH实现

如果你设置了append_slash为false,访问上面这个url,还是能访问到页面的话,清理下浏览器的缓存,就可以了