模板層詳解

模板及其配置

　　作為一個Web框架，Django需要一種動態生成HTML的便捷方法。最常用的方法依賴於模板。模板包含所需HTML輸出的靜態部分以及描述動態內容將被插入的一些特殊語法。

　　Django項目可以配置一個或多個模板引擎（或者如果不使用模板，甚至為零）。Django後端內置一個自己的模板系統，創造性地稱為Django template language（DTL），和一個流行的替代品Jinja2。後端也可以使用第三方提供其他可用的模板語言。

配置：參考https://www.cnblogs.com/wlx97e6/p/9563135.html

Django模板語言

Django的模板語言分為變量和標簽兩大塊，只需要記兩種特殊符號：

{{ }}和 {% %}

變量相關的用{{}}，標簽（邏輯相關）的用{%%}。

變量

在Django的模板語言中按此語法使用：{{ 變量名 }}。

當模版引擎遇到一個變量，它將計算這個變量，然後用結果替換掉它本身。 變量的命名包括任何字母數字以及下劃線 ("_")的組合。 變量名稱中不能有空格或標點符號。

調用方式

點（.）在模板語言中有特殊的含義。當模版系統遇到點(".")，它將以這樣的順序查詢：

字典查詢（Dictionary lookup）
屬性或方法查詢（Attribute or method lookup）
數字索引查詢（Numeric index lookup）

def template_test(request):
    l = [11, 22, 33]
    d = {"name": "alex"}

    class Person(object):
        def __init__(self, name, age):
            self.name = name
            self.age = age

        def dream(self):
            return "{} is dream...".format(self.name)

    Alex = Person(name="Alex", age=34)
    Egon = Person(name="Egon", age=9000)
    Eva_J = Person(name="Eva_J", age=18)

    person_list = [Alex, Egon, Eva_J]
    return render(request, "template_test.html", {"l": l, "d": d, "person_list": person_list})

　　在模板中調用

{# 取l中的第一個參數 #}
{{ l.0 }}
{# 取字典中key的值 #}
{{ d.name }}
{# 取對象的name屬性 #}
{{ person_list.0.name }}
{# .操作只能調用不帶參數的方法 #}
{{ person_list.0.dream }}

註意事項：

1. 如果計算結果的值是可調用的，它將被無參數的調用。 調用的結果將成為模版的值。
2. 如果使用的變量不存在， 模版系統將插入 string_if_invalid 選項的值， 它被默認設置為‘‘ (空字符串) 。

Filters（過濾器）

在Django的模板語言中，通過使用 過濾器 來改變變量的顯示。

過濾器的語法： {{ value|filter_name:參數 }}

使用管道符"|"來應用過濾器。

例如：{{ name|lower }}會將name變量應用lower過濾器之後再顯示它的值。lower在這裏的作用是將文本全都變成小寫。

註意事項：

1. 過濾器支持“鏈式”操作。即一個過濾器的輸出作為另一個過濾器的輸入。
2. 過濾器可以接受參數，例如：{{ sss|truncatewords:30 }}，這將顯示sss的前30個詞。
3. 過濾器參數包含空格的話，必須用引號包裹起來。比如使用逗號和空格去連接一個列表中的元素，如：{{ list|join:‘, ‘ }}
4. ‘|‘左右沒有空格，沒有空格，沒有空格。

Django的模板語言中提供了大約六十個內置過濾器，這裏只講解較為重要的一部分

• default

如果一個變量是false或者為空，使用給定的默認值。 否則，使用變量的值。

{{ value|default:"nothing"}}

如果value沒有傳值或者值為空的話就顯示nothing

• length

返回值的長度，作用於字符串和列表。

{{ value|length }}

返回value的長度，如 value=[‘a‘, ‘b‘, ‘c‘, ‘d‘]的話，就顯示4.

• filesizeformat

將值格式化為一個 “人類可讀的” 文件尺寸 （例如 ‘13 KB‘, ‘4.1 MB‘, ‘102 bytes‘, 等等）。例如：

{{ value|filesizeformat }}

如果 value 是 123456789，輸出將會是 117.7 MB。

• slice

切片

{{value|slice:"2:-1"}}

• date

格式化

{{ value|date:"Y-m-d H:i:s"}}

可用的參數：

• safe

Django的模板中會對HTML標簽和JS等語法標簽進行自動轉義成字符串，原因顯而易見，這樣是為了安全，如果不自動轉義，容易被XSS攻擊。但是有的時候我們可能不希望這些HTML元素被轉義，比如我們做一個內容管理系統，後臺添加的文章中是經過修飾的，這些修飾可能是通過一個類似於FCKeditor編輯加註了HTML修飾符的文本，如果自動轉義的話顯示的就是保護HTML標簽的源文件。為了在Django中關閉HTML的自動轉義有兩種方式，如果是一個單獨的變量我們可以通過過濾器“|safe”的方式告訴Django這段代碼是安全的不必轉義，可能會被嵌入到html文件中。

比如：

value = "<a href=‘#‘>點我</a>"

{{ value|safe}}

• truncatechars

如果字符串字符多於指定的字符數量，那麽會被截斷。截斷的字符串將以可翻譯的省略號序列（“...”）結尾。摘要，簡介等有用。

參數：截斷的字符數

{{ value|truncatechars:9}}

• truncatewords

在一定數量的字後截斷字符串。

{{ value|truncatewords:9}}

• cut

移除value中所有的與給出的變量相同的字符串

{{ value|cut:‘ ‘ }}

如果value為‘i love you‘，那麽將輸出‘iloveyou‘.

• join

使用字符串連接列表，例如Python的str.join(list)

• timesince

將日期格式設為自該日期起的時間（例如，“4天，6小時”）。

采用一個可選參數，它是一個包含用作比較點的日期的變量（不帶參數，比較點為現在）。 例如，如果blog_date是表示2006年6月1日午夜的日期實例，並且comment_date是2006年6月1日08:00的日期實例，則以下將返回“8小時”：

{{ blog_date|timesince:comment_date }}

分鐘是所使用的最小單位，對於相對於比較點的未來的任何日期，將返回“0分鐘”。

• timeuntil

似於timesince，除了它測量從現在開始直到給定日期或日期時間的時間。 例如，如果今天是2006年6月1日，而conference_date是保留2006年6月29日的日期實例，則{{ conference_date | timeuntil }}將返回“4周”。

使用可選參數，它是一個包含用作比較點的日期（而不是現在）的變量。 如果from_date包含2006年6月22日，則以下內容將返回“1周”：

{{ conference_date|timeuntil:from_date }}

自定義filter

自定義過濾器只是帶有一個或兩個參數的Python函數，若想接收更多參數請看下一個:

• 變量（輸入）的值 - -不一定是一個字符串
• 參數的值 - 這可以有一個默認值，或完全省略

例如，在過濾器{{var | foo:‘bar‘}}中，過濾器foo將傳遞變量var和參數“bar”。

下面是自定義filter的定義方式

自定義filter代碼文件擺放位置：（文件名隨意，主要是註冊的語句）

app01/
    __init__.py
    models.py
    templatetags/  # 第一步：在app01下面新建一個package package
        __init__.py
        app01_filters.py  # 第二步：建一個存放自定義filter的文件
    views.py

編寫自定義filter

# 第三步，編寫自定義的文件
from django import template
register = template.Library()
# 前兩行固定寫法，連register的名字都不能換

# 告訴Django的模板語言，我現在有一個自定義的filter的方法，叫cut
@register.filter(name="cut")
def cut(value, arg):  # 第一個參數始終是管道符前面的變量，後面的參數為冒號後面的參數
    return value.replace(arg, "")

# 告訴Django的模板語言，我現在有一個自定義的filter的方法，叫addSB
@register.filter(name="addSB")
def add_sb(value):
    return "{} SB".format(value)

自定義時可以自己設定參數，但函數的第一個參數一定是管道符前面的變量，後面的參數，接收的是冒號後面的變量

使用自定義filter

{# 第四步：使用時要先導入我們自定義filter那個文件 #}
{% load app01_filters %}

{# 第五步：使用我們自定義的filter #}
{{ somevariable|cut:"0" }}
{{ d.name|addSB }}

記得重啟一下Django，不然可能會報錯

自定義simpletag

和自定義filter類似，只不過接收更靈活的參數。

自定義simpletag代碼文件擺放位置和自定義filter位置類似，和在myfilter.py同級目錄下創建一個mysimpletag.py，然後在裏面註冊

定義註冊simple tag

# 編寫自定義的文件
from django import template
register = template.Library()
# 前兩行固定寫法，連register的名字都不能換
@register.simple_tag(name="plus")
def plus(a, b, c):
    return "{} + {} + {}".format(a, b, c)

使用自定義simple tag

{% load app01_demo %}

{# simple tag #}
{% plus "1" "2" "abc" %}

自定義inclusion_tag

多用於返回html代碼片段

示例：

templatetags/my_inclusion.py

from django import template
register = template.Library()


@register.inclusion_tag(‘result.html‘)
def show_results(n):
    n = 1 if n < 1 else int(n)
    data = ["第{}項".format(i) for i in range(1, n+1)]
    return {"data": data}

templates/snippets/result.html

<ul>
  {% for choice in data %}
    <li>{{ choice }}</li>
  {% endfor %}
</ul>

templates/index.html

<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8">
  <meta http-equiv="x-ua-compatible" content="IE=edge">
  <meta name="viewport" content="width=device-width, initial-scale=1">
  <title>inclusion_tag test</title>
</head>
<body>

{% load inclusion_tag_test %}

{% show_results 10 %}
</body>
</html>

Tags（標簽-邏輯語句）

Django自帶了大約24個內置的模版標簽。 你可以在 內置標簽索引中閱讀全部關於它們的內容。 為了體驗一下它們的作用，這裏有一些常用的標簽：

• for

<ul>
{% for user in user_list %}
    <li>{{ user.name }}</li>
{% endfor %}
</ul>

for循環可用的一些參數：

• for ... empty

如果for 後面跟的變量為空，則如何如何，不為空不走empty

<ul>
{% for user in user_list %}
    <li>{{ user.name }}</li>
{% empty %}
    <li>空空如也</li>
{% endfor %}
</ul>

• if,elif和else

{% if user_list %}
  用戶人數：{{ user_list|length }}
{% elif black_list %}
  黑名單數：{{ black_list|length }}
{% else %}
  沒有用戶
{% endif %}

當然也可以只有if和else

{% if user_list|length > 5 %}
  七座豪華SUV
{% else %}
    黃包車
{% endif %}

if語句支持 and 、or、==、>、<、!=、<=、>=、in、not in、is、is not判斷。

• with

定義一個中間變量，相當於替換變量名

{% with total=business.employees.count %}
    {{ total }} employee{{ total|pluralize }}
{% endwith %}

• csrf_token

這個標簽用於跨站請求偽造保護。

在頁面的form表單裏面寫上{% csrf_token %}

• 註釋

{# ... #}

註意事項

1. Django的模板語言不支持連續判斷，即不支持以下寫法：

{% if a > b > c %}
...
{% endif %}

Python支持連續判斷a>b>c相當於(a>b)&&(b>c),結果為True,js也支持連續判斷，但有區別，a>b>c相當於（a>b）>c,如果abc為100,10,1，結果為1>1為false

2. Django的模板語言中屬性的優先級大於方法

def xx(request):
    d = {"a": 1, "b": 2, "c": 3, "items": "100"}
    return render(request, "xx.html", {"data": d})

如上，我們在使用render方法渲染一個頁面的時候，傳的字典d有一個key是items並且還有默認的 d.items() 方法，此時在模板語言中:

{{ data.items }}

默認會取d的items key的值。

母板

什麽是母板和繼承：

把多個頁面公用的部分提取出來，放在一個模板裏面，這個模板就叫母版。
其他的頁面只需要繼承母版就可以都擁有公共的部分了，如導航欄，側邊欄，底部版權信息。

<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8">
  <meta http-equiv="x-ua-compatible" content="IE=edge">
  <meta name="viewport" content="width=device-width, initial-scale=1">
  <title>Title</title>
  {# 定義特定的css塊存放子頁面單獨需要的css代碼 #}
  {% block page-css %}
  
  {% endblock %}
</head>
<body>

<h1>這是母板的標題</h1>

{# 每個子模板不同的地方，定義塊，用於繼承實現 #}
{% block page-main %}

{% endblock %}
<h1>母板底部內容</h1>
{# 定義特定的js塊存放子頁面單獨需要的js代碼 #}
{% block page-js %}

{% endblock %}
</body>
</html>

註意：我們通常會在母板中定義頁面專用的CSS塊和JS塊，方便子頁面替換。

繼承母板

在子頁面中在頁面最上方使用下面的語法來繼承母板。

{% extends ‘layouts.html‘ %}

塊（block）

通過在母板中使用{% block xxx %}來定義"塊"，然後子頁面去實現（填充）母版的相應的塊。

子頁面中通過定義母板中的block名來對應替換母板中相應的內容。

{% block page-main %}
  <p>世情薄</p>
  <p>人情惡</p>
  <p>雨送黃昏花易落</p>
{% endblock %}

這裏的page-main中的內容會替換模板中page-main

使用母版和繼承的註意事項：

• {% extends ‘base.html‘ %} --> 繼承時寫母版文件:base.html要加引號
• {% extends ‘base.html‘ %}必須放在子頁面的第一行！！！
• 可以在base.html中定義很多block，通常我們會額外定義page-css和page-js兩個塊，子頁面實現時寫上自己的link，style或者script
• view.py相應的函數中返回的是對應的子頁面文件，不是、不是、不是 base.html

繼承實例

組件

可以將常用的頁面內容如導航條，頁尾信息等組件保存在單獨的文件中，然後在需要使用的地方按如下語法導入即可。

{% include ‘navbar.html‘ %}

包含組件的語句要寫在html文件裏面或者塊語句裏面，不能單獨拎出來寫例如

因為組件一般都是div等標簽，要包含在html標簽裏，直接在最外層單獨include是無效的，應將include語句寫在block page-main語句塊裏，或直接寫在html標簽裏

靜態文件相關

可以動態的讀取static文件別名，進行拼接，如下

{# 下面一句相當於去settings.py裏面找靜態文件夾的別名是什麽 #}
{% load static %}
{# 下面一句作用是把上面讀取出來的路徑和後面的參數拼接起來 #}
<img src="{% static "images/hi.jpg" %}" alt="Hi!" />

引用JS文件時使用：

{% load static %}
<script src="{% static "mytest.js" %}"></script>

某個文件多處被用到可以存為一個變量

{% load static %}
{% static "images/hi.jpg" as myphoto %}
<img src="{{ myphoto }}"></img>

get_static_prefix（自己手動憑借靜態文件的路徑，用的少，上面用的多）

get_static_prefix獲取靜態文件的路徑，然後自己拼接

{% load static %}
<img src="{% get_static_prefix %}images/hi.jpg" alt="Hi!" />

或者

{% load static %}
{% get_static_prefix as STATIC_PREFIX %}

<img src="{{ STATIC_PREFIX }}images/hi.jpg" alt="Hi!" />
<img src="{{ STATIC_PREFIX }}images/hi2.jpg" alt="Hello!" />

總目錄https://www.cnblogs.com/wlx97e6/p/9143284.html

Django學習筆記3