如何在 Django 中建立自訂模板標籤？

Django模板標籤：簡化數據顯示，提升代碼復用性

在Django開發中，模板用於將數據動態渲染到HTML頁面。本文將介紹如何使用Django模板標籤來簡化數據顯示邏輯，避免在視圖中重複編寫代碼。

Django模板基礎示例

假設你有一個簡單的課程列表HTML模板：

對應的視圖代碼如下：

視圖將課程數據傳遞給模板，最終在網頁上顯示如下：

問題：顯示課程總數

現在，假設你需要在網頁上顯示總課程數。一種方法是在視圖中添加計算邏輯：

<code class="language-python">def course_list(request):
    total_courses = Course.objects.count()
    return render(request, 'courses.html', {'courses': courses, 'total_courses': total_courses})</code>

但如果你的網站有多個頁面（例如博客頁面、作者頁面、講師頁面），都需要顯示課程總數，則需要在每個視圖中重複此邏輯，這將導致代碼冗餘且難以維護。這時，Django模板標籤就派上用場了。

什麼是模板標籤？

簡單來說，Django模板標籤是一種特殊的標籤，允許你在Django模板系統中添加自定義功能。它能提高代碼復用性，避免在視圖中重複編寫相同的邏輯。

為什麼使用模板標籤？

假設你的課程應用需要顯示以下數據：

• 總課程數
• 可用課程數
• 已註冊學生數

與其在每個視圖中都添加計算邏輯，不如使用模板標籤來簡化操作。

步驟1：創建模板標籤

1. 創建templatetags文件夾: 在你的課程應用（courses app）下創建templatetags文件夾：

你的文件夾結構如下：

<code>   courses/
       ├── templatetags/
           ├── __init__.py
           └── course_tags.py</code>

2. 在course_tags.py文件中，定義計算總課程數、可用課程數和已註冊學生數的模板標籤：

<code class="language-python">from django import template
from courses.models import Course

register = template.Library()

@register.simple_tag
def total_courses():
    return Course.objects.count()

@register.simple_tag
def available_courses():
    return Course.objects.filter(is_available=True).count()

@register.simple_tag
def enrolled_students(course_id):
    course = Course.objects.get(id=course_id)
    return course.enrolled_students.count()</code>

步驟2：在模板中加載和使用模板標籤

現在，你可以在HTML模板中加載並使用這些自定義標籤來顯示相關數據。

示例1：在課程列表頁面顯示課程總數

在course_list.html模板中，加載自定義標籤並使用它們來顯示總課程數和可用課程數：

<code class="language-html">{% load course_tags %}

<h1>所有课程</h1>

<p>总课程数：{% total_courses %}</p>
<p>可用课程数：{% available_courses %}</p>

{% for course in courses %}
    - {{ course.name }} - {{ course.description }}
{% endfor %}</code>

這個模板將顯示：

• 總課程數
• 可用課程數

示例2：在課程詳情頁面顯示已註冊學生數

在課程詳情頁面，可以使用enrolled_students模板標籤來顯示特定課程的已註冊學生數：

<code class="language-python">def course_list(request):
    total_courses = Course.objects.count()
    return render(request, 'courses.html', {'courses': courses, 'total_courses': total_courses})</code>

enrolled_students標籤接收course.id作為參數，並傳回該課程的已註冊學生數。

使用模板標籤的優勢

1. 定義好模板標籤後，可以在應用程式中的多個地方重複使用，無需在每個視圖中重複編寫相同的邏輯。
2. 如果需要修改課程計數的計算方式，只需更新模板標籤即可，無需修改每個視圖或模板。

最終輸出

結論

本文透過範例示範如何在Django中使用模板標籤來避免在視圖中重複新增課程和學生計數的邏輯。模板標籤提高了程式碼的可重複使用性和可維護性。

---

聯絡方式 - @syedamahamfahim ?

以上是如何在 Django 中建立自訂模板標籤？的詳細內容。更多資訊請關注PHP中文網其他相關文章！