视图
- 视图一般都写在
app
的views.py
中。并且视图的第一个参数永远都是request
(一个HttpRequest)对象。这个对象存储了这个http请求的所有信息,其中包括携带的参数以及一些头部信息等。 - 在视图函数中,一般是完成逻辑相关的操作。比如这个请求是添加一篇博客,那么可以通过request来接收到这些数据,然后存储到数据库中,最后再把执行的结果返回给浏览器。
- 视图函数的返回结果必须是
HttpResponseBase
对象或者其子类的对象。
URL映射
- 视图写完后,要与URL进行映射,也即用户在浏览器中输入什么
url
的时候可以请求到这个视图函数。 - 在用户输入了某个
url
,请求到我们的网站的时候,django
会从项目的urls.py
文件中寻找对应的视图。在urls.py
文件中有一个urlpatterns
变量,以后django
就会从这个变量中读取所有的匹配规则。 - 匹配规则需要使用
django.urls.path
函数进行包裹,这个函数会根据传入的参数返回URLPattern
或者是URLResolver
的对象。
URL中添加参数
- 有时候,
url
中包含了一些参数需要动态调整。比如简书某篇文章的详情页的url,是https://www.jianshu.com/p/a5aab9c4978e
后面的a5aab9c4978e
就是这篇文章的id
,那么简书的文章详情页面的url就可以写成https://www.jianshu.com/p/<id>
,其中id就是文章的id。 - 如何在
django
中实现这种需求呢。这时候我们可以在path
函数中,使用尖括号的形式来定义一个参数。例如:path('book/<book_id>/',views.book_detail)
。这时需要在视图函数中接收这个参数,且名字需要和尖括号的内容保持一致。 - 另外,也可以通过查询字符串的方式传递一个参数过去
book/detail/?id=123
。例如path('book/detail/',views.book_detail)
。这时在视图函数中就可以通过request.GET.get("id")
的方式获取到这个参数。
URL中包含另外一个urls模块
在项目中,不可能只有一个app
,如果把所有的app
的views
中的视图都放在urls.py
中进行映射,肯定会让代码显得非常乱。因此django
给我们提供了一个方法,可以在app
内部包含自己的url
匹配规则,而在项目的urls.py
中再统一包含这个app
的urls
。使用这个技术需要借助include
函数。
# 项目中的urls.py文件:
from django.contrib import admin
from django.urls import path,include
urlpatterns = [
path('admin/', admin.site.urls),
path('book/',include("book.urls"))
]
在urls.py
文件中把所有的和book
这个app
相关的url
都移动到app/urls.py
中了,然后在first_project/urls.py
中,通过include
函数包含book.urls
,以后在请求book
相关的url的时候都需要加一个book
的前缀。
# book这个app中的/urls.py文件:
from django.urls import path
from . import views
urlpatterns = [
path('list/',views.book_list),
path('detail/<book_id>/',views.book_detail)
]
path函数
path
函数的参数为:path(route,view,name=None,kwargs=None)
route
参数:url
的匹配规则。这个参数中可以指定url
中需要传递的参数,比如在访问文章详情页的时候,可以传递一个id
。传递参数是通过<>
尖括号来进行指定的。并且在传递参数的时候,可以指定这个参数的数据类型,比如文章的id
都是int
类型,那么可以这样写<int:id>
,以后匹配的时候,就只会匹配到id
为int
类型的url
,而不会匹配其他的url
,并且在视图函数中获取这个参数的时候,就已经被转换成一个int类型了。其中还有几种常用的类型:str
:非空的字符串类型。默认的转换器。但是不能包含斜杠。int
:匹配任意的零或者正数的整形。到视图函数中就是一个int类型。slug
:由英文中的横杠-
,或者下划线_
连接英文字符或者数字而成的字符串。uuid
:匹配uuid
字符串。path
:匹配非空的英文字符串,可以包含斜杠。
view
参数:可以为一个视图函数或者是类视图.as_view()
或者是django.urls.include()
函数的返回值。name
参数:这个参数是给这个url
命名的,这在项目比较大,url
比较多的时候用处很大。kwargs
参数:如果想给视图函数传递一些额外的参数,就可以通过kwargs
参数进行传递。这个参数接收一个字典。传到视图函数中的时候,会作为一个关键字参数传过去。
re_path函数
如果在写url匹配的时候,想要写使用正则表达式来实现一些复杂的需求,那么这时候我们可以使用re_path
来实现。re_path
的参数和path
参数一模一样,只不过第一个参数也就是route
参数可以为一个正则表达式。
例如:re_path(r'articles/(?P<year>[0-9]{4})/', views.year_archive)
以上例子中我们可以看到,所有的route字符串前面都加了一个r,表示这个字符串是一个原生字符串。在写正则表达式中是推荐使用原生字符串的,这样可以避免在python这一层面进行转义。而且,使用正则表达式捕获参数的时候,是用一个圆括号进行包裹,然后这个参数的名字是通过尖括号<year>
进行包裹,之后才是写正则表达式的语法。
include函数
在项目变大以后,经常不会把所有的url
匹配规则都放在项目的urls.py
文件中,而是每个app
都有自己的urls.py
文件,在这个文件中存储的都是当前这个app
的所有url
匹配规则。然后再统一注册到项目的urls.py
文件中。include
函数有多种用法,这里讲下两种常用的用法。
include(pattern,namespace=None)
:直接把其他app
的urls
包含进来include(pattern_list)
:可以包含一个列表或者一个元组,这个元组或者列表中又包含的是path
或者是re_path
函数。include((pattern,app_namespace),namespace=None)
:在包含某个app
的urls
的时候,可以指定命名空间,这样做的目的是为了防止不同的app
下出现相同的url
,这时候就可以通过命名空间进行区分。但是这样做的前提是已经包含了应用命名空间。即在myapp.urls.py
中添加一个和urlpatterns
同级别的变量app_name
。
指定默认的参数
使用path
或者是re_path
的后,在route
中都可以包含参数,而有时候想指定默认的参数,这时候可以通过以下方式来完成。示例代码如下:
from django.urls import path
from . import views
urlpatterns = [
path('blog/', views.page),
path('blog/page<int:num>/', views.page),
]
# View (in blog/views.py)
def page(request, num=1):
# Output the appropriate page of blog entries, according to num.
...
当在访问blog/
的时候,因为没有传递num
参数,所以会匹配到第一个url,这时候就执行view.page
这个视图函数,而在page
函数中,又有num=1
这个默认参数。因此这时候就可以不用传递参数。而如果访问blog/1
的时候,因为在传递参数的时候传递了num
,因此会匹配到第二个url
,这时候也会执行views.page
,然后把传递进来的参数传给page
函数中的num
。
URL反转
通过视图函数获取其url
,可以通过reverse
来实现。示例代码如下:
reverse("list")
> /book/list/
如果有应用命名空间或者有实例命名空间,那么应该在反转的时候加上命名空间。示例代码如下:
reverse('book:list')
> /book/list/
如果这个url
中需要传递参数,那么可以通过kwargs
来传递参数。示例代码如下:
reverse("book:detail",kwargs={"book_id":1})
> /book/detail/1
因为django
中的reverse
反转url
的时候不区分GET
请求和POST
请求,因此不能在反转的时候添加查询字符串的参数。如果想要添加查询字符串的参数,只能手动的添加。示例代码如下:
login_url = reverse('login') + "?next=/"
自定义URL转换器:
之前已经学到过一些django内置的url
转换器,包括有int
、uuid
等。有时候这些内置的url转换器
并不能满足我们的需求,因此django给我们提供了一个接口可以让我们自己定义自己的url转换器。
自定义url
转换器按照以下五个步骤来走就可以了:
- 定义一个类。
- 在类中定义一个属性
regex
,这个属性是用来保存url
转换器规则的正则表达式。 - 实现
to_python(self,value)
方法,这个方法是将url
中的值转换一下,然后传给视图函数的。 - 实现
to_url(self,value)
方法,这个方法是在做url
反转的时候,将传进来的参数转换后拼接成一个正确的url。 - 将定义好的转换器,注册到
django
中。