技術文章 » Python Django 模版全解與實戰

Python Django 模版全解與實戰

2023-07-08 18:00:23

本文首先介紹了Django模板系統的基礎知識，接著探討了如何安裝和設定Django模板系統，然後深入解析了Django模板的基本結構、標籤和過濾器的用法，闡述瞭如何在模板中展示模型資料，最後使用一個實際專案的例子來演示如何在實際開發中使用Django模板系統。

Django模板系統的簡介

Django模板系統是一個強大的元件，它允許我們根據所提供的資料動態生成HTML、XML等結構化文字。模板系統不僅易於使用，且功能豐富。它包括一個內建的語言：Django模板語言 (DTL)，這是一種簡單、非侵入式的語言，用於定義模板的結構和邏輯。

例如，在一個Django模板中，我們可以使用變數和標籤來動態地生成內容：

# Django模板範例
{{ book.title }} <!-- 輸出: Python程式設計基礎 -->
{% if user.is_authenticated %} <!-- 如果使用者已登入 -->
  Hello, {{ user.username }}! <!-- 輸出: Hello, John! -->
{% endif %}

以上程式碼中，花括號{{ }}用於輸出變數的值，標籤{% %}用於執行邏輯操作。

模板的基本結構

Django模板是由一系列特殊的語法構成的文字檔案，用於動態生成HTML、XML或其他標示語言。下面我們來詳細瞭解一下Django模板的基本結構。

模板語法

Django模板主要使用兩種語法：

  • 變數：用雙大括號（{{ }}）包裹。比如{{ variable }}，Django將會將其替換為變數的值。
  • 標籤：用大括號和百分號（{% %}）包裹。標籤提供了模板的控制結構，比如迴圈、條件語句等。比如{% for item in list %}...{% endfor %}。

模板繼承

Django模板系統支援模板繼承。這是一種DRY（Don't Repeat Yourself）的設計原則。你可以定義一個基礎模板（base template），然後讓其他模板繼承這個基礎模板並覆蓋其中的某些部分。

例如，定義一個基礎模板base.html：

<!-- base.html -->
<html>
<body>
{% block content %}{% endblock %}
</body>
</html>

然後，定義一個子模板child.html，繼承base.html並覆蓋content塊：

<!-- child.html -->
{% extends "base.html" %}

{% block content %}
<p>Hello, Django!</p>
{% endblock %}

其他模板

除了繼承，Django模板還支援包含（include）其他模板，這可以幫助你將模板分解為小的、可重用的部分。

例如，定義一個模板header.html：

<!-- header.html -->
<header>
  <h1>Welcome to My Website</h1>
</header>

然後，在另一個模板中包含這個模板：

{% include "header.html" %}

<p>This is the main content...</p>

設定Django模板

設定Django模板系統

Django模板系統預設已經被包含在Django專案中。你可以在專案的settings.py檔案中找到模板的設定資訊：

TEMPLATES = [
    {
        'BACKEND': 'django.template.backends.django.DjangoTemplates',
        'DIRS': [BASE_DIR / 'templates'],
        ...
    },
]

你可以在'DIRS'設定項中新增模板的路徑。預設情況下，Django會在每個應用的templates目錄下查詢模板檔案。

設定模板載入方式

Django模板系統可以從多個位置載入模板。預設情況下，Django會在每個應用的templates目錄下查詢模板檔案。你可以通過修改TEMPLATES設定中的'DIRS'選項來新增其他模板目錄。例如，你可以新增一個全域性的模板目錄：

# settings.py

import os
BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))

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

在此設定中，所有的模板檔案都會在專案根目錄下的templates資料夾中查詢。

設定模板引擎

在TEMPLATES設定中，'BACKEND'選項用於指定使用哪個模板引擎。Django預設使用的是自帶的模板引擎，即django.template.backends.django.DjangoTemplates。你也可以切換到其他模板引擎，例如Jinja2：

TEMPLATES = [
    {
        'BACKEND': 'django.template.backends.jinja2.Jinja2',
        ...
    },
]

注意，不同的模板引擎可能需要不同的設定，並且提供的模板語言也可能不同。

設定自定義模板標籤和過濾器

如果你有自定義的模板標籤和過濾器，你需要把它們放在某個應用下的templatetags目錄中。然後在INSTALLED_APPS設定中新增該應用，Django就會自動載入你的自定義模板標籤和過濾器：

# settings.py

INSTALLED_APPS = [
    ...
    'myapp',
    ...
]

模板標籤詳解

Django模板系統中的標籤（Tags）提供了各種控制結構，包括迴圈、條件語句、模板繼承等。接下來我們詳細介紹一些常用的標籤。

for標籤

for標籤用於在模板中迴圈遍歷序列：

{% for item in item_list %}
    <p>{{ item.name }}</p> <!-- 輸出每個專案的名稱 -->
{% endfor %}

if標籤

if標籤用於條件判斷。你可以使用elif和else進行多分支判斷：

{% if user.is_authenticated %}
    <p>Welcome back, {{ user.username }}.</p> <!-- 如果使用者已經認證，列印歡迎資訊 -->
{% else %}
    <p>Please log in.</p> <!-- 如果使用者未認證，提示使用者登入 -->
{% endif %}

extends標籤和block標籤

extends標籤用於模板繼承，block標籤用於定義可被子模板覆蓋的區塊：

<!-- base.html -->
<html>
<body>
{% block content %}{% endblock %}
</body>
</html>

<!-- child.html -->
{% extends "base.html" %}

{% block content %}
<p>Hello, Django!</p>
{% endblock %}

include標籤

include標籤用於包含其他模板，使得模板可重用：

{% include "header.html" %}

url標籤

url標籤用於生成URL。它接受一個檢視函數的名稱或URL模式的名稱，以及可選的引數，然後返回對應的URL：

<a href="{% url 'home' %}">Home</a> <!-- 生成首頁的URL -->

csrf_token標籤

在使用POST表單時，csrf_token標籤用於生成CSRF令牌，以防止跨站請求偽造攻擊：

<form method="post">
{% csrf_token %}
<!-- 表單內容 -->
</form>

模板過濾器

在Django模板中，過濾器可以在變數被顯示之前對其進行修改。過濾器的語法是在變數名後面新增一個豎線（|）和過濾器的名稱。如果過濾器需要引數，可以使用冒號（:）新增。讓我們詳細瞭解一下。

基本使用

比如，我們可以使用date過濾器來格式化日期：

{{ date_var|date:"F j, Y" }} <!-- 輸出: July 8, 2023 -->

使用lower過濾器將文字轉換為小寫：

{{ "Hello World"|lower }} <!-- 輸出: hello world -->

連結過濾器

你還可以連結多個過濾器，他們會按照從左到右的順序執行：

{{ "Hello World"|lower|capfirst }} <!-- 輸出: Hello world -->

自定義過濾器

除了使用Django內建的過濾器，你還可以建立自己的過濾器。為此，你需要在某個應用下的templatetags目錄中建立一個Python檔案，然後在其中定義你的過濾器函數，並使用register.filter裝飾器註冊它：

from django import template

register = template.Library()

@register.filter
def my_filter(value):
    # 這是一個簡單的過濾器，它返回值的第一個字元
    return value[0]

然後你就可以在模板中使用這個過濾器了：

{{ "Hello World"|my_filter }} <!-- 輸出: H -->

Django模板中展示模型資料

Django框架將模型資料和模板檢視分離，這讓我們在模板中方便地展示模型資料。在檢視函數中，我們可以查詢模型資料，然後將它傳遞給模板。在模板中，我們使用特殊的語法來存取和展示這些資料。

在檢視中準備資料

假設我們有一個Blog模型，它有一個title欄位和一個content欄位。在我們的檢視函數中，我們可以查詢所有的部落格：

from django.shortcuts import render
from .models import Blog

def blog_list(request):
    blogs = Blog.objects.all()  # 查詢所有的部落格
    return render(request, 'blog_list.html', {'blogs': blogs})

在模板中展示資料

然後，在我們的blog_list.html模板中，我們可以使用for標籤來遍歷所有的部落格，並使用變數語法來展示每個部落格的標題和內容：

{% for blog in blogs %}
<h2>{{ blog.title }}</h2>  <!-- 展示部落格標題 -->
<p>{{ blog.content }}</p>  <!-- 展示部落格內容 -->
{% endfor %}

使用過濾器格式化資料

在模板中，我們還可以使用過濾器來對模型資料進行格式化。例如，我們可以使用date過濾器來格式化日期，或者使用truncatechars過濾器來限制文字的長度：

{% for blog in blogs %}
<h2>{{ blog.title }}</h2>
<p>{{ blog.publish_date|date:"F j, Y" }}</p>  <!-- 使用date過濾器格式化釋出日期 -->
<p>{{ blog.content|truncatechars:100 }}</p>  <!-- 使用truncatechars過濾器限制內容長度 -->
{% endfor %}

在實際的專案中使用Django模板

Django模板系統在實際的專案開發中扮演著重要的角色。下面我們就以一個簡單的部落格系統作為例子，演示如何在實際專案中使用Django模板。

第一步：定義你的模型

首先，我們需要在我們的應用中定義一個模型。在這個例子中，我們定義一個Post模型來表示部落格文章：

from django.db import models

class Post(models.Model):
    title = models.CharField(max_length=200)  # 文章標題
    content = models.TextField()  # 文章內容
    pub_date = models.DateTimeField(auto_now_add=True)  # 釋出日期

第二步：建立檢視

接著，我們需要建立一個檢視來處理使用者的請求。在這個檢視中，我們可以獲取所有的部落格文章，並將它們傳遞給模板：

from django.shortcuts import render
from .models import Post

def post_list(request):
    posts = Post.objects.all()  # 獲取所有的部落格文章
    return render(request, 'blog/post_list.html', {'posts': posts})  # 將文章傳遞給模板

第三步：編寫模板

然後，我們可以建立一個模板來展示部落格文章。在這個模板中，我們使用for標籤來遍歷所有的文章，並使用變數來展示文章的標題和內容：

{% for post in posts %}
<h2>{{ post.title }}</h2>
<p>{{ post.content }}</p>
<p>Published on {{ post.pub_date|date:"F j, Y" }}</p>
{% endfor %}

第四步：設定URLs

最後，我們需要在urls.py檔案中設定URL，使得使用者可以存取我們的檢視：

from django.urls import path
from . import views

urlpatterns = [
    path('posts/', views.post_list, name='post_list'),  # 當用戶存取/posts/時，顯示部落格文章列表
]

以上就是在實際專案中使用Django模板的基本步驟。通過這個例子，我們可以看到Django模板系統的強大和靈活性，它可以幫助我們快速地建立動態的網頁。

如有幫助，請多關注
個人微信公眾號：【Python全視角】
TeahLead_KrisChang，10+年的網際網路和人工智慧從業經驗，10年+技術和業務團隊管理經驗，同濟軟體工程本科，復旦工程管理碩士，阿里雲認證雲服務資深架構師，上億營收AI產品業務負責人。