Django的View(视图)和路由系统

一、Django的View(视图)
1、介绍
一个视图函数（类），简称视图，是一个简单的Python 函数（类），它接受Web请求并且返回Web响应。
响应可以是一张网页的HTML内容，一个重定向，一个404错误，一个XML文档，或者一张图片。
无论视图本身包含什么逻辑，都要返回响应。
代码写在哪里也无所谓，只要它在你当前项目目录下面。
大家约定俗成将视图放置在项目（project）或应用程序（app）目录中的名为views.py的文件中。


2、FBV和CBV（Function Base View和Class Base View）
1. 基于函数的视图:FBV
    视图函数中通过request.method的不同进而执行不同的代码

例如：
urls.py代码
urlpatterns = [
    url(r‘^login/‘, views.login),
]


views.py代码
def login(request):
    if request.method == ‘POST‘:
        username = request.POST.get(‘username‘)
        pwd = request.POST.get(‘pwd‘)
        ret = UserInfo.objects.filter(username=username, pwd=pwd)
        if ret:
            return HttpResponse(‘登录成功‘)
        else:
            return render(request, ‘login.html‘)
    return render(request, ‘login.html‘)
    
    
2. 基于类的视图：CBV
    1. 视图类必须继承django.views.View
    2. 在类中定义和请求方法同名的方法
    3. urls.py中注册基于类的视图的时候要区别于FBV要写成：类名.as_view()

例如：
urls.py代码
urlpatterns = [
    url(r‘^login/‘, views.LoginView.as_view()),
]


views.py代码
from django import views
class LoginView(views.View):

    def get(self, request):
        return render(request, ‘login.html‘)

    def post(self, request):
        username = request.POST.get(‘username‘)
        pwd = request.POST.get(‘pwd‘)
        ret = UserInfo.objects.filter(username=username, pwd=pwd)
        if ret:
            return HttpResponse(‘登录成功‘)
        else:
            return render(request, ‘login.html‘)



二、request对象
1、请求相关的常用值：
path_info       返回用户访问url，不包括域名
method          请求中使用的HTTP方法的字符串表示，全大写表示。
GET              包含所有HTTP  GET参数的类字典对象
POST            包含所有HTTP POST参数的类字典对象
body             请求体，byte类型 request.POST的数据就是从body里面提取到的
FILES             一个类似于字典的对象，包含所有的上传文件信息。

例如：上面的登录示例
在浏览器输入：http://127.0.0.1:8000/login/?id=1
request.path_info           --> login                   --> 只能取到url，取不到url的参数
request.path                       --> login                   --> 只能取到url，取不到url的参数
request.get_full_path()   --> /login/?id=1      --> 可以取到url和url参数


body             请求体，byte类型 request.POST的数据就是从body里面提取到的
request.body 返回的是一个bytes类型的数据，是POST提交上来的数据，是没有进行过修饰的数据，
request.POST 的内容就是在request.body数据的基础上进行分割组成的字典。

例如：
request.body：
b‘csrfmiddlewaretoken=0o2Lc8UH2uhLbaKySq7j3gFm3afb8IBrfD6YHTUM7cD5KVSYtIlPcC7Vsx9xwcIx&username=zbj&pwd=123‘

request.POST：
<QueryDict: {‘csrfmiddlewaretoken‘: [‘0o2Lc8UH2uhLbaKySq7j3gFm3afb8IBrfD6YHTUM7cD5KVSYtIlPcC7Vsx9xwcIx‘], ‘username‘: [‘zbj‘], ‘pwd‘: [‘123‘]}>


2、属性
所有的属性应该被认为是只读的，除非另有说明。
属性：
    django将请求报文中的请求行、头部信息、内容主体封装成 HttpRequest 类中的属性。
    除了特殊说明的之外，其他均为只读的。


0.HttpRequest.scheme
   表示请求方案的字符串（通常为http或https）

1.HttpRequest.body
    一个字符串，代表请求报文的主体。在处理非 HTTP 形式的报文时非常有用，例如：二进制图片、XML,Json等。
    但是，如果要处理表单数据的时候，推荐还是使用 HttpRequest.POST 。
    另外，我们还可以用 python 的类文件方法去操作它，详情参考 HttpRequest.read() 。

 

2.HttpRequest.path
    一个字符串，表示请求的路径组件（不含域名）。
    例如："/music/bands/the_beatles/"



3.HttpRequest.method
    一个字符串，表示请求使用的HTTP 方法。必须使用大写。
    例如："GET"、"POST"

 

4.HttpRequest.encoding
    一个字符串，表示提交的数据的编码方式（如果为 None 则表示使用 DEFAULT_CHARSET 的设置，默认为 ‘utf-8‘）。
    这个属性是可写的，你可以修改它来修改访问表单数据使用的编码。
    接下来对属性的任何访问（例如从 GET 或 POST 中读取数据）将使用新的 encoding 值。
    如果你知道表单数据的编码不是 DEFAULT_CHARSET ，则使用它。

 

5.HttpRequest.GET 
    一个类似于字典的对象，包含 HTTP GET 的所有参数。详情请参考 QueryDict 对象。

 

6.HttpRequest.POST
    一个类似于字典的对象，如果请求中包含表单数据，则将这些数据封装成 QueryDict 对象。
    POST 请求可以带有空的 POST 字典 —— 如果通过 HTTP POST 方法发送一个表单，但是表单中没有任何的数据，QueryDict 对象依然会被创建。
    因此，不应该使用 if request.POST  来检查使用的是否是POST 方法；应该使用 if request.method == "POST" 
    另外：如果使用 POST 上传文件的话，文件信息将包含在 FILES 属性中。

 7.HttpRequest.COOKIES
    一个标准的Python 字典，包含所有的cookie。键和值都为字符串。

 

8.HttpRequest.FILES
    一个类似于字典的对象，包含所有的上传文件信息。
    FILES 中的每个键为<input type="file" name="" /> 中的name，值则为对应的数据。
    注意，FILES 只有在请求的方法为POST 且提交的<form> 带有enctype="multipart/form-data" 的情况下才会
    包含数据。否则，FILES 将为一个空的类似于字典的对象。

 

9.HttpRequest.META
    一个标准的Python 字典，包含所有的HTTP 首部。具体的头部信息取决于客户端和服务器，下面是一些示例：

    CONTENT_LENGTH —— 请求的正文的长度（是一个字符串）。
    CONTENT_TYPE —— 请求的正文的MIME 类型。
    HTTP_ACCEPT —— 响应可接收的Content-Type。
    HTTP_ACCEPT_ENCODING —— 响应可接收的编码。
    HTTP_ACCEPT_LANGUAGE —— 响应可接收的语言。
    HTTP_HOST —— 客服端发送的HTTP Host 头部。
    HTTP_REFERER —— Referring 页面。
    HTTP_USER_AGENT —— 客户端的user-agent 字符串。
    QUERY_STRING —— 单个字符串形式的查询字符串（未解析过的形式）。
    REMOTE_ADDR —— 客户端的IP 地址。
    REMOTE_HOST —— 客户端的主机名。
    REMOTE_USER —— 服务器认证后的用户。
    REQUEST_METHOD —— 一个字符串，例如"GET" 或"POST"。
    SERVER_NAME —— 服务器的主机名。
    SERVER_PORT —— 服务器的端口（是一个字符串）。
 　　从上面可以看到，除 CONTENT_LENGTH 和 CONTENT_TYPE 之外，请求中的任何 HTTP 首部转换为 META 的键时，
    都会将所有字母大写并将连接符替换为下划线最后加上 HTTP_  前缀。
    所以，一个叫做 X-Bender 的头部将转换成 META 中的 HTTP_X_BENDER 键。

 
10.HttpRequest.user
    一个 AUTH_USER_MODEL 类型的对象，表示当前登录的用户。
    如果用户当前没有登录，user 将设置为 django.contrib.auth.models.AnonymousUser 的一个实例。你可以通过 is_authenticated() 区分它们。
    例如：
    if request.user.is_authenticated():
        # Do something for logged-in users.
    else:
        # Do something for anonymous users.
     

     　　user 只有当Django 启用 AuthenticationMiddleware 中间件时才可用。

     -------------------------------------------------------------------------------------

    匿名用户
    class models.AnonymousUser

    django.contrib.auth.models.AnonymousUser 类实现了django.contrib.auth.models.User 接口，但具有下面几个不同点：

    id 永远为None。
    username 永远为空字符串。
    get_username() 永远返回空字符串。
    is_staff 和 is_superuser 永远为False。
    is_active 永远为 False。
    groups 和 user_permissions 永远为空。
    is_anonymous() 返回True 而不是False。
    is_authenticated() 返回False 而不是True。
    set_password()、check_password()、save() 和delete() 引发 NotImplementedError。
    New in Django 1.8:
    新增 AnonymousUser.get_username() 以更好地模拟 django.contrib.auth.models.User。

 

11.HttpRequest.session
    一个既可读又可写的类似于字典的对象，表示当前的会话。只有当Django 启用会话的支持时才可用。
    完整的细节参见会话的文档。


3、上传文件示例
注意：form表单提交的时候，enctype默认是application/x-www-form-urlencoded这个编码形式，
即使用键值对的形式POST数据，在只有文本数据提交时使用。
而如果POST请求中有文件类型的数据，则需指定enctype="multipart/form-data" 表明POST的数据中
既有文本类型数据(键值对传输数据)也有文件类型数据(二进制传输数据)。
upload.html代码
<!DOCTYPE html>
<html lang="zh-CN">
<head>
    <meta http-equiv="content-type" charset="utf-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge">
    <meta name="viewport" content="width=device-width, initial-scale=1">
    <title>Upload</title>
</head>

<body>

<form action="" method="post" enctype="multipart/form-data">
    {% csrf_token %}
    <p><input type="text" name="username"></p>
    <p><input type="file" name="file"></p>
    <p><input type="submit"></p>
</form>

</body>
</html>




views.py代码
class UploadView(views.View):

    def get(self, request):
        return render(request, ‘upload.html‘)

    def post(self, request):
        # 文本类型的数据用request.POST获取，键对应的值是字符串类型
        print(request.POST)
        # 文件类型的数据用request.FILES获取，键对应的值是类的对象
        print(request.FILES)
        # 获取文件对象(是一大串bytes类型的字节码)
        file_obj = request.FILES.get(‘file‘)
        # 文件对象有个内置的属性name，用于获取接收到的文件名
        filename = file_obj.name
        # 建一个同名的文件接收上传的数据
        # with open(filename, ‘wb‘) as f:
        #     for i in file_obj:
        #         f.write(i)

        # 跟上面的方法是一样的，只不过chunks是一个内置的方法，可以设置每次接收的数据大小
        with open(filename, ‘wb‘) as f:
            for chunk in file_obj.chunks(chunk_size=1024):
                f.write(chunk)

        return HttpResponse(‘收到啦！‘)



4、方法
1.HttpRequest.get_host()

　　根据从HTTP_X_FORWARDED_HOST（如果打开 USE_X_FORWARDED_HOST，默认为False）和 HTTP_HOST 头部信息返回请求的原始主机。
   如果这两个头部没有提供相应的值，则使用SERVER_NAME 和SERVER_PORT，在PEP 3333 中有详细描述。

　　USE_X_FORWARDED_HOST：一个布尔值，用于指定是否优先使用 X-Forwarded-Host 首部，仅在代理设置了该首部的情况下，才可以被使用。

　　例如："127.0.0.1:8000"

　　注意：当主机位于多个代理后面时，get_host() 方法将会失败。除非使用中间件重写代理的首部。

 

2.HttpRequest.get_full_path()

　　返回 path，如果可以将加上查询字符串。

　　例如："/music/bands/the_beatles/?print=true"

 

3.HttpRequest.get_signed_cookie(key, default=RAISE_ERROR, salt=‘‘, max_age=None)

　　返回签名过的Cookie 对应的值，如果签名不再合法则返回django.core.signing.BadSignature。

　　如果提供 default 参数，将不会引发异常并返回 default 的值。

　　可选参数salt 可以用来对安全密钥强力攻击提供额外的保护。max_age 参数用于检查Cookie 对应的时间戳以确保Cookie 的时间不会超过max_age 秒。

        >>> request.get_signed_cookie(‘name‘)
        ‘Tony‘
        >>> request.get_signed_cookie(‘name‘, salt=‘name-salt‘)
        ‘Tony‘ # 假设在设置cookie的时候使用的是相同的salt
        >>> request.get_signed_cookie(‘non-existing-cookie‘)
        ...
        KeyError: ‘non-existing-cookie‘    # 没有相应的键时触发异常
        >>> request.get_signed_cookie(‘non-existing-cookie‘, False)
        False
        >>> request.get_signed_cookie(‘cookie-that-was-tampered-with‘)
        ...
        BadSignature: ...    
        >>> request.get_signed_cookie(‘name‘, max_age=60)
        ...
        SignatureExpired: Signature age 1677.3839159 > 60 seconds
        >>> request.get_signed_cookie(‘name‘, False, max_age=60)
        False
         


4.HttpRequest.is_secure()

　　如果请求时是安全的，则返回True；即请求通是过 HTTPS 发起的。

 

5.HttpRequest.is_ajax()

　　如果请求是通过XMLHttpRequest 发起的，则返回True，方法是检查 HTTP_X_REQUESTED_WITH 相应的首部是否是字符串‘XMLHttpRequest‘。

　　大部分现代的 JavaScript 库都会发送这个头部。如果你编写自己的 XMLHttpRequest 调用（在浏览器端），你必须手工设置这个值来让 is_ajax() 可以工作。

　　如果一个响应需要根据请求是否是通过AJAX 发起的，并且你正在使用某种形式的缓存例如Django 的 cache middleware， 
   你应该使用 vary_on_headers(‘HTTP_X_REQUESTED_WITH‘) 装饰你的视图以让响应能够正确地缓存。



   
三、Response对象
1、介绍
与由Django自动创建的HttpRequest对象相比，HttpResponse对象是我们的职责范围了。我们写的每个视图都需要实例化，填充和返回一个HttpResponse。


2、使用
传递字符串
from django.shortcuts import HttpResponse
response = HttpResponse("Here‘s the text of the Web page.")
response = HttpResponse("Text only, please.", content_type="text/plain")


设置或删除响应头信息
response = HttpResponse()
response[‘Content-Type‘] = ‘text/html; charset=UTF-8‘
del response[‘Content-Type‘]


3、属性
HttpResponse.content：响应内容
HttpResponse.charset：响应内容的编码
HttpResponse.status_code：响应的状态码



四、JsonResponse对象
JsonResponse是HttpResponse的子类，专门用来生成JSON编码的响应。
1、使用HttpResponse返回字典
def json_data(request):
    d = {"name": "小明", "age": 24}
    import json
    str_d = json.dumps(d, ensure_ascii=False)
    return HttpResponse(str_d, content_type=‘application/json‘)
    
2、使用JsonResponse
上面的代码等于：
def json_data(request):
    d = {"name": "小明", "age": 24}
    from django.http import JsonResponse
    return JsonResponse(d)

注意：JsonResponse一般用于返回字典的Json序列化，列表一般不推荐使用，
如果你死皮赖脸就是想要返回列表，那么就需要添加safe=False参数
def json_data(request):
    l = ["a", "b", "c"]
    from django.http import JsonResponse
    return JsonResponse(l, safe=False)


    
五、render
结合一个给定的模板和一个给定的上下文字典，并返回一个渲染后的 HttpResponse 对象。
参数：
    request： 用于生成响应的请求对象。

    template_name：要使用的模板的完整名称，可选的参数

    context：添加到模板上下文的一个字典。默认是一个空字典。如果字典中的某个值是可调用的，视图将在渲染模板之前调用它。

    content_type：生成的文档要使用的MIME类型。默认为 DEFAULT_CONTENT_TYPE 设置的值。默认为‘text/html‘

    status：响应的状态码。默认为200。

    useing: 用于加载模板的模板引擎的名称。

    
例子：
from django.shortcuts import render

def my_view(request):
    # 视图的代码写在这里
    return render(request, ‘myapp/index.html‘, {‘foo‘: ‘bar‘})

上面的代码等于：
from django.shortcuts import HttpResponse
from django.template import loader

def my_view(request):
    # 视图代码写在这里
    t = loader.get_template(‘myapp/index.html‘)
    c = {‘foo‘: ‘bar‘}
    return HttpResponse(t.render(c, request))



六、redirect
参数可以是：
    一个模型：将调用模型的get_absolute_url() 函数
    一个视图，可以带有参数：将使用urlresolvers.reverse 来反向解析名称
    一个绝对的或相对的URL，将原封不动的作为重定向的位置。
默认返回一个临时的重定向；传递permanent=True 可以返回一个永久的重定向。

示例:

你可以用多种方式使用redirect() 函数。


1、传递一个具体的ORM对象
将调用具体ORM对象的get_absolute_url() 方法来获取重定向的URL：
from django.shortcuts import redirect
 
def my_view(request):
    ...
    object = MyModel.objects.get(...)
    return redirect(object)


2、传递一个视图的名称    
def my_view(request):
    ...
    return redirect(‘some-view-name‘, foo=‘bar‘)
    

3、传递要重定向到的一个具体的网址
def my_view(request):
    ...
    return redirect(‘/some/url/‘)
    
    
4、一个完整的网址
def my_view(request):
    ...
    return redirect(‘http://example.com/‘)
    

5、默认情况下，redirect() 返回一个临时重定向。以上所有的形式都接收一个permanent 参数；如果设置为True，将返回一个永久的重定向：
def my_view(request):
    ...
    object = MyModel.objects.get(...)
    return redirect(object, permanent=True)

临时重定向（响应状态码：302）和永久重定向（响应状态码：301）对普通用户来说是没什么区别的，它主要面向的是搜索引擎的机器人。
A页面临时重定向到B页面，那搜索引擎收录的就是A页面。
A页面永久重定向到B页面，那搜索引擎收录的就是B页面。



七、路由系统
1、URLconf配置
基本格式(django1.x版本)：参数都是字符串类型的
from django.conf.urls import url

urlpatterns = [
     url(正则表达式, views视图函数，参数，别名),
]


Django 2.0版本中的路由系统已经替换成下面的写法：参数支持整型
from django.urls import path

urlpatterns = [
    path(‘articles/2003/‘, views.special_case_2003),
    path(‘articles/<int:year>/‘, views.year_archive),
    path(‘articles/<int:year>/<int:month>/‘, views.month_archive),
    path(‘articles/<int:year>/<int:month>/<slug:slug>/‘, views.article_detail),
]


参数说明：
正则表达式：一个正则表达式字符串
views视图函数：一个可调用对象，通常为一个视图函数或一个指定视图函数路径的字符串
参数：可选的要传递给视图函数的默认参数（字典形式）
别名：一个可选的name参数


扩展：如果想在django2.x版本使用1.x版本的代码
from django.urls import re_path

urlpatterns = [
     re_path(正则表达式, views视图函数，参数，别名),
]


2、正则表达式详解
基本配置：
from django.conf.urls import url
from appname import views

urlpatterns = [
    url(r‘^articles/2003/$‘, views.special_case_2003),
    url(r‘^articles/([0-9]{4})/$‘, views.year_archive),
    url(r‘^articles/([0-9]{4})/([0-9]{2})/$‘, views.month_archive),
    url(r‘^articles/([0-9]{4})/([0-9]{2})/([0-9]+)/$‘, views.article_detail),
]


注意事项：
    urlpatterns中的元素按照书写顺序从上往下逐一匹配正则表达式，一旦匹配成功则不再继续。
    若要从URL中捕获一个值，只需要在它周围放置一对圆括号（分组匹配）。
    不需要添加一个前导的反斜杠，因为每个URL 都有。例如，应该是^articles 而不是 ^/articles。
    每个正则表达式前面的‘r‘ 是可选的但是建议加上。

    
补充说明：
# 是否开启URL访问地址后面不为/跳转至带有/的路径的配置项
APPEND_SLASH=True

Django settings.py配置文件中默认没有 APPEND_SLASH 这个参数，但 Django 默认这个参数为 APPEND_SLASH = True。 其作用就是自动在网址结尾加‘/‘。
其效果就是：

我们定义了urls.py：
from django.conf.urls import url
from appname import views

urlpatterns = [
        url(r‘^blog/$‘, views.blog),
]

访问 http://www.example.com/blog 时，默认将网址自动转换为 http://www.example/com/blog/ 。

如果在settings.py中设置了 APPEND_SLASH=False，此时我们再请求 http://www.example.com/blog 时就会提示找不到页面。



3、分组命名匹配
上面的示例使用简单的正则表达式分组匹配（通过圆括号）来捕获URL中的值并以位置参数形式传递给视图。
在更高级的用法中，可以使用分组命名匹配的正则表达式组来捕获URL中的值并以关键字参数形式传递给视图。
在Python的正则表达式中，分组命名正则表达式组的语法是(?P<name>pattern)，其中name是组的名称，pattern是要匹配的模式。

Django路由系统匹配URL路径的时候是从上到下按照注册顺序来的
Django的路由系统只匹配URL路径，不匹配域名、端口、URL参数

注意：分组匹配和分组命名匹配不能混合使用！！！
url(r‘^book/(?P<yyyy>[0-9]{4})/([0-9]{2})/$‘, views.book)   # 错误的


3-1、圆括号获取URL中的值并以位置参数形式传递给视图
urlpatterns = [
    url(r‘^book/([0-9]{4})/$‘, views.book),  # 这里([0-9]{4})获取到的值会当成位置参数传递给views.book
]

所以views.book定义的时候应该要定义多一个形参用来接收匹配到的实参
def book(request, year):
    print(year)
    return HttpResponse(‘book‘)


3-2、分组命名(?P<name>)匹配的正则表达式组来捕获URL中的值并以关键字参数形式传递给视图。
urlpatterns = [
    url(r‘^book/(?P<yyyy>[0-9]{4})/$‘, views.book),  # 这里([0-9]{4})获取到的值会当成关键字参数传递给views.book
]

所以views.book定义的时候应该要定义多一个关键字参数yyyy用来接收匹配到的实参
def book(request, yyyy):  # 只能使用yyyy接收，因为是关键字传参
    print(yyyy)
    return HttpResponse(‘book‘)