現(xiàn)在我們已經(jīng)很熟悉Django的MTV模式了。模板（template）負(fù)責(zé)如何去展示數(shù)據(jù)，而視圖（view）負(fù)責(zé)篩選出正確的數(shù)據(jù)。因此通常來說邏輯都是放到視圖中的，但模板也需要一些 和表示相關(guān)的邏輯 ：比如循環(huán)展示（如 {% for ... %} ）、或者以某種特定格式輸出（如 {{ ...|date:'Y-m-d' }} ）等，這些功能都是靠模板的 過濾器（filters） 和 標(biāo)簽（tags） 實(shí)現(xiàn)的。

Django的模板語言包含了很多內(nèi)置的過濾器和標(biāo)簽，設(shè)計(jì)目的是滿足應(yīng)用需要占位邏輯需求。但有的時(shí)候這些通用的功能滿足不了你的某些需求，這時(shí)候就需要自定義過濾器和標(biāo)簽來實(shí)現(xiàn)了。

前置條件

要在Django中使用模板過濾器或標(biāo)簽，就首先得 注冊(cè) 它們。

注冊(cè)方法如下：

• 在APP中新建名為 templatetags 的目錄（方便起見，教程選擇了 article 這個(gè)APP）
• 在此目錄中新建名為 __init__.py 的空文件，使得此目錄被視作一個(gè)Python的包
• 在此目錄中新建python文件（比如 my_filters_and_tags.py ），就可以在里面愉快的寫代碼啦

完成后的目錄結(jié)構(gòu)如下：

article/
  __init__.py
  views.py
  models.py
  # 新增目錄
  templatetags/
    __init__.py # 空文件
    my_filters_and_tags.py # 即將寫代碼的地方
  ...

請(qǐng)注意：

• 目錄必須位于已注冊(cè)的APP中，這是出于安全性的考慮
• 新建目錄后，必須手動(dòng)重啟服務(wù)器，里面的過濾器和標(biāo)簽才能生效
  

前置條件就完成了，接下來我們看看如何寫一個(gè)模板過濾器。

模板過濾器

過濾器 filter 的表現(xiàn)形式為緊跟在上下文后面的管道符 | ，管道符后面是filter的名稱： {{ ...|filter_name }} 。有的filter還可以帶有參數(shù)： {{ ...|filter_name:var }} 。

注意過濾器名稱的冒號(hào)后面不能有空格。

filter 這個(gè)名字可能會(huì)讓你誤認(rèn)為它只是用來篩選某些特定數(shù)據(jù)的，但實(shí)際上它遠(yuǎn)不止這點(diǎn)功能。它可以改變上下文的最終展示效果，也可以將上下文通過運(yùn)算輸出為特定的值。

小試牛刀

要成為一個(gè)可用的 filter ，文件中必須包含一個(gè)名為 register 的模塊級(jí)變量，它是一個(gè) template.Library 實(shí)例，所有的 filters 均在其中注冊(cè)。所以在 my_filter_and_tags.py 文件中輸入以下內(nèi)容:

article/templatetags/my_filter_and_tags.py

from django import template
register = template.Library()

接下來就可以像寫普通的Python函數(shù)一樣寫過濾器了：

article/templatetags/my_filter_and_tags.py
from django import template
register = template.Library()
@register.filter(name='transfer')
def transfer(value, arg):
  """將輸出強(qiáng)制轉(zhuǎn)換為字符串 arg """
  return arg
@register.filter()
def lower(value):
  """將字符串轉(zhuǎn)換為小寫字符"""
  return value.lower()

filter可以通過裝飾器進(jìn)行注冊(cè)。若注冊(cè)裝飾器中攜帶了 name 參數(shù)，則其值為此filter的名稱；若未攜帶，則函數(shù)名就是filter的名稱。

filter必須是有一到兩個(gè)參數(shù)的Python函數(shù)。第一個(gè)參數(shù)是上下文本身，第二個(gè)參數(shù)則由filter提供。舉個(gè)栗子，在過濾器 {{ var|foo:"bar" }} 中，變量 var 為第一個(gè)參數(shù)，變量 bar 則作為第二個(gè)參數(shù)。

調(diào)用這些filter的方法是在模板文件中用 {% load ... %} 將filter文件的名稱加載進(jìn)去，像這樣：

# 任意模板文件中
{% load my_filters_and_tags %}
{{ 'ABC'|transfer:'cool' }} # 輸出：'cool'
{{ 'ABC'|lower }} # 輸出： 'abc'

更人性化的時(shí)間

了解完filter的使用方法后，下面來寫點(diǎn)更實(shí)用的功能。

對(duì)人類這種生物來說， 相對(duì)時(shí)間 通常比 絕對(duì)時(shí)間 要更容易閱讀。 發(fā)表于 3天前 可以輕易得知此文章剛發(fā)表不久；而 發(fā)表于 2019年8月10日 你還得想想今天到底幾號(hào)來著。

因此寫一個(gè)顯示相對(duì)日期的 time_since_zh 過濾器：

article/templatetags/my_filter_and_tags.py
...
from django.utils import timezone
import math
# 獲取相對(duì)時(shí)間
@register.filter(name='timesince_zh')
def time_since_zh(value):
  now = timezone.now()
  diff = now - value
  if diff.days == 0 and diff.seconds >= 0 and diff.seconds < 60:
    return '剛剛'
  if diff.days == 0 and diff.seconds >= 60 and diff.seconds < 3600:
    return str(math.floor(diff.seconds / 60)) + "分鐘前"
  if diff.days == 0 and diff.seconds >= 3600 and diff.seconds < 86400:
    return str(math.floor(diff.seconds / 3600)) + "小時(shí)前"
  if diff.days >= 1 and diff.days < 30:
    return str(diff.days) + "天前"
  if diff.days >= 30 and diff.days < 365:
    return str(math.floor(diff.days / 30)) + "個(gè)月前"
  if diff.days >= 365:
    return str(math.floor(diff.days / 365)) + "年前"

代碼功能很簡(jiǎn)單，就是將文章發(fā)布時(shí)間和當(dāng)前時(shí)間作比較，然后返回適當(dāng)?shù)淖址?/p>

修改文章列表模板文件中與發(fā)布時(shí)間相關(guān)的代碼，把剛寫的filter用上：

templates/article/list.html
...
{% load my_filters_and_tags %}
...
<!-- 舊代碼
{{ article.created|date:'Y-m-d' }}
-->
<!-- 新代碼 -->
{{ article.created|timesince_zh }}
...

效果如下：

實(shí)際上Django內(nèi)置了一個(gè) timesince 過濾器，只不過顯示日期是英文的，不夠友好。

模板標(biāo)簽

模板標(biāo)簽（tag）比過濾器更復(fù)雜，功能也更強(qiáng)大。

標(biāo)簽 tag 的表現(xiàn)形式為 {% tag_name ... %} ，比如我們非常熟悉的內(nèi)置標(biāo)簽 {% url ... %} 、 {% static ... %} 等。如果內(nèi)置標(biāo)簽滿足不了你的需求，Django 提供了很多快捷方式，簡(jiǎn)化了編寫絕大多數(shù)類型的標(biāo)簽過程。

簡(jiǎn)單標(biāo)簽

simple_tag 就是最重要的標(biāo)簽類型。標(biāo)簽的注冊(cè)方法跟過濾器非常類似：

@register.simple_tag
def change_http_to_https(url):
  new_url = url.replace('http://', 'https://')
  return new_url

調(diào)用時(shí)同樣記得在模板文件中用 {% load... %} 引入。用法你應(yīng)該猜得到： {% change_http_to_https ... %} ，這個(gè)標(biāo)簽的作用是將http鏈接替換為https鏈接。

用 Django-allauth 進(jìn)行微博登錄，默認(rèn)返回的用戶頭像是 http 鏈接（雖然微博有 https 版本的頭像）。如果你的站點(diǎn)已經(jīng)升級(jí)為 https 了，又不想花時(shí)間去研究微博的接口，那么這個(gè)標(biāo)簽就可以派上用場(chǎng)了。
順帶一說， Django-allauth 第三方登錄的頭像 url 保存在 User.socialaccount_set.all.0.get_avatar_url 中。

下面這個(gè)例子可以返回指定格式的時(shí)間字符串：

import datetime

@register.simple_tag
def current_time(format_string):
  return datetime.datetime.now().strftime(format_string)

調(diào)用時(shí)你可以將其保存為模板變量，以便你在期望的位置多次調(diào)用：

{% current_time "%Y-%m-%d %I:%M %p" as the_time %}
<p>The time is {{ the_time }}.</p>
<p>Again, the time is {{ the_time }}.</p>

模板標(biāo)簽也可以訪問當(dāng)前的上下文，只需要在注冊(cè)標(biāo)簽時(shí)傳入 takes_context 參數(shù):

@register.simple_tag(takes_context=True)
def current_time(context, format_string):
  timezone = context['timezone']
  return your_get_current_time_method(timezone, format_string)

注意，第一個(gè)參數(shù)必須是 context 。

與過濾器不同的是，標(biāo)簽可以接受任意數(shù)量的位置或關(guān)鍵字參數(shù)。例如:

@register.simple_tag
def my_tag(a, b, *args, **kwargs):
  warning = kwargs['warning']
  profile = kwargs['profile']
  ...
  return ...

在模板中調(diào)用時(shí)，任意數(shù)量的、以空格分隔的參數(shù)會(huì)被傳遞給模板標(biāo)簽。與 Python 中類似，關(guān)鍵字參數(shù)的賦值使用等號(hào)（" = "），且必須在位置參數(shù)后提供：

{% my_tag 123 "abcd" book.title warning=message profile=user.profile %}

包含標(biāo)簽

包含標(biāo)簽可以讓另一個(gè)模板為當(dāng)前模板渲染數(shù)據(jù)。聽起來比較拗口，還是通過例子來理解。

假設(shè)現(xiàn)在有一個(gè)需求，是要在文章詳情頁(yè)面中，顯示所有相關(guān)評(píng)論的發(fā)布時(shí)間。因此在 my_filter_and_tags.py 中寫入：

my_filter_and_tags.py

...

@register.inclusion_tag('article/tag_list.html')
def show_comments_pub_time(article):
  """顯示文章評(píng)論的發(fā)布時(shí)間"""
  comments = article.comments.all()
  return {'comments': comments}

函數(shù)傳入的參數(shù)可以是模板中的上下文變量。函數(shù)體內(nèi)部取得了所有相關(guān)評(píng)論的查詢集，然后把結(jié)果 comments 返回。注意返回結(jié)果是進(jìn)入到 tag_list.html 這個(gè)模板中去了，因此新建它并寫入：

templates/article/tag_list.html

<ul>
{% for comment in comments %}
  <li> {{ comment.created }} </li>
{% endfor %}
</ul>

然后在文章詳情頁(yè)面的模板中，隨便找一個(gè)位置寫入：

templates/article/detail.html
...
{% load my_filters_and_tags %}
...
{% show_comments_pub_time article %}

刷新詳情頁(yè)面，順利的話就能看到所有評(píng)論的發(fā)表時(shí)間都展示出來了。

包含標(biāo)簽的另一個(gè)應(yīng)用場(chǎng)景就是各種按鈕了。有的按鈕看上去長(zhǎng)得都差不多，但是根據(jù)頁(yè)面不同會(huì)有不同的功能，這時(shí)候也可以用包含標(biāo)簽來實(shí)現(xiàn)。

總之，包含標(biāo)簽可以將常用的模板代碼打包成小組件，方便重復(fù)利用。

目前的博客項(xiàng)目中暫時(shí)還用不到包含標(biāo)簽，所以放心的刪除上面的代碼吧。

總結(jié)

以上所述是小編給大家介紹的Django自定義模板過濾器和標(biāo)簽的實(shí)現(xiàn)方法，希望對(duì)大家有所幫助，如果大家有任何疑問歡迎給我留言，小編會(huì)及時(shí)回復(fù)大家的！

最新評(píng)論