HelloDjango 第 05 篇:Django 的接客之道


文中涉及的示例代碼,已同步更新到 HelloGitHub-Team 倉庫

Web 服務簡單的說就是處理請求,每個請求就像是一個“顧客”。首先熱情地把顧客迎接進來,然后滿足用戶的個性化需求,最后讓顧客心滿意足的離開。Django 作為一個 web 框架,能夠讓開發者有更多的精力和時間去應付復雜多變的需求,而不是把時間花費在招店小二、做飯的廚子、服務員等。那么下面我們就來看看 Django 的接客之道吧。

Django 處理 HTTP 請求

Web 應用的交互過程其實就是 HTTP 請求與響應的過程。無論是在 PC 端還是移動端,我們通常使用瀏覽器來上網,上網流程大致來說是這樣的:

  1. 我們打開瀏覽器,在地址欄輸入想訪問的網址,比如 https://zmrenwu.com/ (當然你也可能從收藏夾里直接打開網站,但本質上都是一樣的)。
  2. 瀏覽器知道我們想要訪問哪個網址后,它在后台幫我們做了很多事情。主要就是把我們的訪問意圖包裝成一個 HTTP 請求,發給我們想要訪問的網址所對應的服務器。通俗點說就是瀏覽器幫我們通知網站的服務器,說有人來訪問你啦,訪問的請求都寫在 HTTP 報文里了,你按照要求處理后告訴我,我再幫你回應他!
  3. 服務器處理了HTTP 請求,然后生成一段 HTTP 響應給瀏覽器。瀏覽器解讀這個響應,把相關的內容在瀏覽器里顯示出來,於是我們就看到了網站的內容。比如你訪問了我的博客主頁 https://zmrenwu.com/ ,服務器接收到這個請求后就知道用戶訪問的是首頁,首頁顯示的是全部文章列表,於是它從數據庫里把文章數據取出來,生成一個寫着這些數據的 HTML 文檔,包裝到 HTTP 響應里發給瀏覽器,瀏覽器解讀這個響應,把 HTML 文檔顯示出來,我們就看到了文章列表的內容。

因此,django 作為一個 Web 框架,它的使命就是處理流程中的第二步。即接收瀏覽器發來的 HTTP 請求,返回相應的 HTTP 響應。於是引出這么幾個問題:

  1. django 如何接收 HTTP 請求?
  2. django 如何處理這個 HTTP 請求?
  3. django 如何生成 HTTP 響應?

對於如何處理這些問題,django 有其一套規定的機制。我們按照 django 的規定,就能開發出所需的功能。

Hello 視圖函數

我們先以一個最簡單的 Hello World 為例來看看 django 處理上述問題的機制是怎么樣的。

綁定 URL 與視圖函數

首先 django 需要知道當用戶訪問不同的網址時,應該如何處理這些不同的網址(即所說的路由)。django 的做法是把不同的網址對應的處理函數寫在一個 urls.py 文件里,當用戶訪問某個網址時,django 就去會這個文件里找,如果找到這個網址,就會調用和它綁定在一起的處理函數(叫做視圖函數)。

下面是具體的做法,首先在 blog 應用的目錄下創建一個 urls.py 文件,這時你的目錄看起來是這樣:

blog\
    __init__.py
    admin.py
    apps.py
    migrations\
    	0001_initial.py
        __init__.py
    models.py
    tests.py
    views.py
    urls.py

在 blog\urls.py 中寫入這些代碼:

from django.urls import path

from . import views

urlpatterns = [
    path('', views.index, name='index'),
]

我們首先從 django.urls 導入了 path 函數,又從當前目錄下導入了 views 模塊。然后我們把網址和處理函數的關系寫在了 urlpatterns 列表里。

綁定關系的寫法是把網址和對應的處理函數作為參數傳給 path 函數(第一個參數是網址,第二個參數是處理函數),另外我們還傳遞了另外一個參數 name,這個參數的值將作為處理函數 index 的別名,這在以后會用到。

注意這里我們的網址實際上是一個規則,django 會用這個規則去匹配用戶實際輸入的網址,如果匹配成功,就會調用其后面的視圖函數做相應的處理。

比如說我們本地開發服務器的域名是 http://127.0.0.1:8000 ,那么當用戶輸入網址 http://127.0.0.1:8000 后,django 首先會把協議 http、域名 127.0.0.1 和端口號 8000 去掉,此時只剩下一個空字符串,而 '' 的模式正是匹配一個空字符串,於是二者匹配,django 便會調用其對應的 views.index 函數。

注意

在 blogproject\ 目錄下(即 settings.py 所在的目錄),原本就有一個 urls.py 文件,這是整個工程項目的 URL 配置文件。而我們這里新建了一個 urls.py 文件,且位於 blog 應用下。這個文件將用於 blog 應用相關的 URL 配置,這樣便於模塊化管理。不要把兩個文件搞混了。

編寫視圖函數

第二步就是要實際編寫我們的 views.index 視圖函數了,按照慣例視圖函數定義在 views.py 文件里:

blog/views.py

from django.http import HttpResponse

def index(request):
    return HttpResponse("歡迎訪問我的博客首頁!")

我們前面說過,Web 服務器的作用就是接收來自用戶的 HTTP 請求,根據請求內容作出相應的處理,並把處理結果包裝成 HTTP 響應返回給用戶。

這個兩行的函數體現了這個過程。它首先接受了一個名為 request 的參數,這個 request 就是 django 為我們封裝好的 HTTP 請求,它是類 HttpRequest 的一個實例。然后我們便直接返回了一個 HTTP 響應給用戶,這個 HTTP 響應也是 django 幫我們封裝好的,它是類 HttpResponse 的一個實例,只是我們給它傳了一個自定義的字符串參數。

瀏覽器接收到這個響應后就會在頁面上顯示出我們傳遞的內容 :歡迎訪問我的博客首頁!

配置項目 URL

還差最后一步了,我們前面建立了一個 urls.py 文件,並且綁定了 URL 和視圖函數 index,但是 django 並不知道。django 匹配 URL 模式是在 blogproject\ 目錄(即 settings.py 文件所在的目錄)的 urls.py 下的,所以我們要把 blog 應用下的 urls.py 文件包含到 blogproject\urls.py 里去,打開這個文件看到如下內容:

blogproject/urls.py

"""
一大段注釋
"""

from django.contrib import admin
from django.urls import path

urlpatterns = [
    path('admin/', admin.site.urls),
]

修改成如下的形式:

from django.contrib import admin
from django.urls import path, include

urlpatterns = [
    path('admin/', admin.site.urls),
    path('', include('blog.urls')),
]

我們這里導入了一個 include 函數,然后利用這個函數把 blog 應用下的 urls.py 文件包含了進來。此外 include 前還有一個 '',這是一個空字符串。這里也可以寫其它字符串,django 會把這個字符串和后面 include 的 urls.py 文件中的 URL 拼接。比如說如果我們這里把 '' 改成 'blog/',而我們在 blog\urls.py 中寫的 URL 是 '',即一個空字符串。那么 django 最終匹配的就是 blog/ 加上一個空字符串,即 blog/。

運行結果

運行 pipenv run python manage.py runserver 打開開發服務器,在瀏覽器輸入開發服務器的地址 http://127.0.0.1:8000/ ,可以看到 django 返回的內容了。

歡迎訪問我的博客首頁!

使用 django 模板系統

這基本上就上 django 的開發流程了,寫好處理 HTTP 請求和返回 HTTP 響應的視圖函數,然后把視圖函數綁定到相應的 URL 上。

但是等一等!我們看到在視圖函數里返回的是一個 HttpResponse 類的實例,我們給它傳入了一個希望顯示在用戶瀏覽器上的字符串。但是我們的博客不可能只顯示這么一句話,它有可能會顯示很長很長的內容。比如我們發布的博客文章列表,或者一大段的博客文章。我們不能每次都把這些大段大段的內容傳給 HttpResponse

django 對這個問題給我們提供了一個很好的解決方案,叫做模板系統。django 要我們把大段的文本寫到一個文件里,然后 django 自己會去讀取這個文件,再把讀取到的內容傳給 HttpResponse。讓我們用模板系統來改造一下上面的例子。

首先在我們的項目根目錄(即 manage.py 文件所在目錄)下建立一個名為 templates 的文件夾,用來存放我們的模板。然后在 templates\ 目錄下建立一個名為 blog 的文件夾,用來存放和 blog 應用相關的模板。

當然模板存放在哪里是無關緊要的,只要 django 能夠找到的就好。但是我們建立這樣的文件夾結構的目的是把不同應用用到的模板隔離開來,這樣方便以后維護。我們在 templates\blog 目錄下建立一個名為 index.html 的文件,此時你的目錄結構應該是這樣的:

HelloDjango-blog-tutorial\
    manage.py
 	...
    templates\
    	blog\
    		index.html

注意

再一次強調 templates\ 目錄位於項目根目錄,而 index.html 位於 templates\blog 目錄下,而不是 blog 應用下,如果弄錯了你可能會得到一個 TemplateDoesNotExist 異常。如果遇到這個異常,請回來檢查一下模板目錄結構是否正確。

在 templates\blog\index.html 文件里寫入下面的代碼:

<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8">
  <title>{{ title }}</title>
</head>
<body>
<h1>{{ welcome }}</h1>
</body>
</html>

這是一個標准的 HTML 文檔,只是里面有兩個比較奇怪的地方:{{ title }}{{ welcome }}。這是 django 規定的語法。用 {{ }} 包起來的變量叫做模板變量。django 在渲染這個模板的時候會根據我們傳遞給模板的變量替換掉這些變量。最終在模板中顯示的將會是我們傳遞的值。

注意:

index.html 必須以 UTF-8 的編碼格式保存,且小心不要往里面添加一些特殊字符,否則極有可能得到一個 UnicodeDecodeError 這樣的錯誤。

模板寫好了,還得告訴 django 去哪里找模板,在 settings.py 文件里設置一下模板文件所在的路徑。在 settings.py 找到 TEMPLATES 選項,它的內容是這樣的:

blogproject/settings.py

TEMPLATES = [
    {
        'BACKEND': 'django.template.backends.django.djangoTemplates',
        'DIRS': [],
        'APP_DIRS': True,
        'OPTIONS': {
            'context_processors': [
                'django.template.context_processors.debug',
                'django.template.context_processors.request',
                'django.contrib.auth.context_processors.auth',
                'django.contrib.messages.context_processors.messages',
            ],
        },
    },
]

其中 DIRS 就是設置模板的路徑,在 [] 中寫入 os.path.join(BASE_DIR, 'templates'),即像下面這樣:

blogproject/settings.py

TEMPLATES = [
    {
        ...
        'DIRS': [os.path.join(BASE_DIR, 'templates')],
     	...
    },
]

這里 BASE_DIR 是 settings.py 在配置開頭前面定義的變量,記錄的是工程根目錄 HelloDjango-blog-tutorial\ 的值。在這個目錄下有模板文件所在的目錄 templates\,於是利用os.path.join 把這兩個路徑連起來,構成完整的模板路徑,django 就知道去這個路徑下面找我們的模板了。

視圖函數可以改一下了:

blog/views.py

from django.shortcuts import render


def index(request):
    return render(request, 'blog/index.html', context={
        'title': '我的博客首頁',
        'welcome': '歡迎訪問我的博客首頁'
    })

這里我們不再是直接把字符串傳給 HttpResponse 了,而是調用 django 提供的 render 函數。這個函數根據我們傳入的參數來構造 HttpResponse

我們首先把 HTTP 請求傳了進去,然后 render 根據第二個參數的值 blog/index.html 找到這個模板文件並讀取模板中的內容。之后 render 根據我們傳入的 context 參數的值把模板中的變量替換為我們傳遞的變量的值,{{ title }} 被替換成了 context 字典中 title 對應的值,同理 {{ welcome }} 也被替換成相應的值。

最終,我們的 HTML 模板中的內容字符串被傳遞給 HttpResponse 對象並返回給瀏覽器(django 在 render 函數里隱式地幫我們完成了這個過程),這樣用戶的瀏覽器上便顯示出了我們寫的 HTML 模板的內容了。

關注公眾號加入交流群,一起討論有趣的技術話題


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM