基於django的視訊點播網站開發-step4-首頁功能

geeeeeeeek發表於2019-02-13
Django網站

在本講中，我們開始首頁功能的開發，在開發過程中，大家將會學習到Django中的通用檢視類、分頁物件paginator以及foreignKey外來鍵的使用。

效果演示

基於django的視訊點播網站開發-step4-首頁功能

整體功能

大家可先通過 網站演示地址 瀏覽一下首頁的效果。我們首頁呢，比較簡潔大方，讓人一目瞭然。我這樣設計的目的呢，是讓大家把精力放到學習django上面來，不必過度關注花哨的頁面效果。

我們把首頁拆解為4個小的業務模組來開發，分別是：列表顯示、分頁功能、搜尋功能、分類功能。下面我們分別對這四個功能模組進行開發講解。

開發思路

開發一個功能的基本思路是：先新建應用，然後分析功能涉及到哪些業務，從而分析出需要的資料庫欄位，然後編寫模型，之後就是展示階段，通過url路由配置檢視函式，來將模型裡面的資料顯示出來。

ok，我們通過命令建立應用，命名為video。執行後，django將為我們新建video資料夾。

python3 manage.py startapp video
複製程式碼

下面的功能模組開發都在該應用(video)下進行。

建模型

此處，我們需要建立兩個模型，分別是分類表(classification)和視訊表(video)。他們是多對一的關係(一個分類對應多個視訊，一個視訊對應一個分類)。

首先編寫Classification表，在model.py下面，我們鍵入如下程式碼。 欄位有title(分類名稱)和status(是否啟用)

class Classification(models.Model):
    list_display = ("title",)
    title = models.CharField(max_length=100,blank=True, null=True)
    status = models.BooleanField(default=True)

    class Meta:
        db_table = "v_classification"
複製程式碼

欄位說明

  • title 分類名稱。資料型別是CharField，最大長度為max_length=100，允許為空null=True
  • status 是否啟用。資料型別是BooleanField,預設為default=True
  • db_table 表名

然後編寫Video模型，根據網站業務，我們設定了title(標題)、 desc(描述)、 classification(分類)、file(視訊檔案)、cover(封面)、status(釋出狀態)等欄位。其中classification是一個ForeignKey外來鍵欄位，表示一個分類對應多個視訊，一個視訊對應一個分類(多對一)

class Video(models.Model):
    STATUS_CHOICES = (
        ('0', '釋出中'),
        ('1', '未釋出'),
    )
    title = models.CharField(max_length=100,blank=True, null=True)
    desc = models.CharField(max_length=255,blank=True, null=True)
    classification = models.ForeignKey(Classification, on_delete=models.CASCADE, null=True)
    file = models.FileField(max_length=255)
    cover = models.ImageField(upload_to='cover/',blank=True, null=True)
    status = models.CharField(max_length=1 ,choices=STATUS_CHOICES, blank=True, null=True)
    create_time = models.DateTimeField(auto_now_add=True, blank=True, max_length=20)

複製程式碼

欄位說明

  • title 視訊標題。資料型別是charField，最大長度為max_length=100，允許為空null=True
  • desc 視訊描述。資料型別是charField，最大長度為max_length=255，允許為空null=True
  • file 視訊檔案地址。資料型別是fileField。其中存的是視訊檔案的地址，在之後的視訊管理中我們將會對視訊的上傳進行具體的講解。
  • cover 視訊封面。資料型別是ImageField。儲存目錄為upload_to='cover/'，允許為空null=True
  • status 視訊狀態。是一個選擇狀態，用choices設定多選元祖。
  • create_time 建立時間。資料型別是DateTimeField 。設定自動生成時間auto_now_add=True

ForeignKey 表明一種一對多的關聯關係。比如這裡我們的視訊和分類的關係，一個視訊只能對應一個分類，而一個分類下可以有多個視訊。 更多關於ForeinkKey的說明，可以參看 ForeignKey官方介紹

列表顯示

要想訪問到首頁，必須先配置好路由。在video下建立urls.py檔案，寫入如下程式碼

from django.urls import path
from . import views

app_name = 'video'
urlpatterns = [
    path('index', views.IndexView.as_view(), name='index'),
]
複製程式碼

一條path語句就代表一條路由資訊。這樣我們就可以在瀏覽器輸入127.0.0.1:8000/video/index來訪問首頁了。

顯示列表資料非常簡單，我們使用django中內建的檢視模版類ListView來顯示，首先在view.py中編寫IndexView類，用它來顯示列表資料。鍵入如下程式碼

class IndexView(generic.ListView):
    model = Video
    template_name = 'video/index.html'
    context_object_name = 'video_list'  
複製程式碼

此處，我們使用了django提供的通用檢視類ListView, ListView使用很簡單，只需要我們簡單的配置幾行程式碼，即可將資料庫裡面的資料渲染到前端。比如上述程式碼中，我們配置了

  • model = Video, 作用於Video模型
  • template_name = 'video/index.html' ，告訴ListView要使用我們已經建立的模版檔案。
  • context_object_name = 'video_list' ，上下文變數名，告訴ListView，在前端模版檔案中，可以使用該變數名來展現資料。

之後，我們在templates資料夾下，建立video目錄，用來存放視訊相關的模板檔案，首先我們建立首頁檔案index.html。並將剛才獲取到的資料顯示出來。

<div class="ui grid">
    {% for item in video_list %}
    <div class="four wide column">
        <div class="ui card">
            <a class="image">
                {% thumbnail item.cover "300x200" crop="center" as im %}
                <img class="ui image" src="{{ im.url }}">
                {% empty %}
                {% endthumbnail %}
                <i class="large play icon v-play-icon"></i>
            </a>
            <div class="content">
                <a class="header">{{ item.title }}</a>
                <div class="meta">
                    <span class="date">釋出於{{ item.create_time|time_since}}</span>
                </div>
                <div class="description">
                    {{ item.view_count}}次觀看
                </div>
            </div>
        </div>
    </div>
    {% empty %}
    <h3>暫無資料</h3>
    {% endfor %}
</div>
複製程式碼

通過for迴圈，將video_list渲染到前端。這裡我們使用到了django中的內建標籤，比如for語句、empty語句。這些都是django中非常常用的語句。在之後的教程中我們會經常遇到。

另外，還使用了thumbnail標籤來顯示圖片，thumbnail是一個很常用的python庫，常常被用來做圖片顯示。

顯示結果如下

首頁展示

分類功能

在寫分類功能之前，我們先學習一個回撥函式 get_context_data() 這是ListView檢視類中的一個函式，在 get_context_data() 函式中，可以傳一些額外內容到模板。因此我們可以使用該函式來傳遞分類資料。

要使用它，很簡單。

只需要在IndexView類下面，追加get_context_data()的實現即可。

class IndexView(generic.ListView):
    model = Video
    template_name = 'video/index.html'
    context_object_name = 'video_list' 

    def get_context_data(self, *, object_list=None, **kwargs):
        context = super(IndexView, self).get_context_data(**kwargs)
        classification_list = Classification.objects.filter(status=True).values()
        context['classification_list'] = classification_list
        return context
複製程式碼

在上述程式碼中，我們將分類資料通過Classification.objects.filter(status=True).values()從資料庫裡面過濾出來，然後賦給classification_list，最後放到context字典裡面。

在前端模板（templates/video/index.html）中，就可以通過classification_list來取資料。新增程式碼

<div class="classification">
    <a class="ui red label" href="">全部</a>
    {% for item in classification_list %}
    <a class="ui label" href="">{{ item.title }}</a>
    {% endfor %}
</div>
複製程式碼

顯示效果如下

基於django的視訊點播網站開發-step4-首頁功能

當然現在只是實現了分類展示效果，我們還需要繼續實現點選效果，即點選不同的分類，顯示不同的視訊列表。

我們先給每個分類按鈕加上href連結

<div class="classification">
    <a class="ui red label" href="{% url 'home' %}">全部</a>
    {% for item in classification_list %}
    <a class="ui label" href="?c={{ item.id }}">{{ item.title }}</a>
    {% endfor %}
</div>
複製程式碼

通過新增?c={{ item.id }} 這裡用c代表分類的id，點選後，會傳到檢視類中，在檢視類中，我們使用 get_queryset() 函式，將get資料取出來。通過self.request.GET.get("c", None) 賦給c，判斷c是否為None，如果為None，就響應全部，如果有值，就通過get_object_or_404(Classification, pk=self.c)先獲取當前類，然後classification.video_set獲取外來鍵資料。

    def get_queryset(self):
        self.c = self.request.GET.get("c", None)
        if self.c:
            classification = get_object_or_404(Classification, pk=self.c)
            return classification.video_set.all().order_by('-create_time')
        else:
            return Video.objects.filter(status=0).order_by('-create_time')

複製程式碼

更多關於ForeignKey的使用方法，可參考 這裡

分頁功能

在Django中，有現成的分頁解決方案，我們開發者省了不少事情。如果是簡單的分頁，只需要配置一下paginate_by即可實現。

class IndexView(generic.ListView):
    model = Video
    template_name = 'video/index.html'
    context_object_name = 'video_list'
    paginate_by = 12
    c = None
複製程式碼
  • painate_by = 12每頁顯示12條

這樣每頁的分頁資料就能正確的顯示出來來，現在來完善底部的頁碼條。

基於django的視訊點播網站開發-step4-首頁功能

頁碼列表需要檢視類和模板共同來完成，我們先來寫檢視類。在前面我們已經寫過get_context_data了，該函式的主要功能就是傳遞額外的資料給模板。這裡，我們就利用get_context_data來傳遞頁碼資料。

我們先定義一個工具函式，叫get_page_list。 在專案根目錄下，新建一個檔案helpers.py該檔案當作一個全域性的工具類，用來存放各種工具函式。把get_page_list放到helpers.py裡面 該函式用來生產頁碼列表，不但這裡可以使用，以後在其他地方也可以呼叫該函式。

def get_page_list(paginator, page):

    page_list = []

    if paginator.num_pages > 10:
        if page.number <= 5:
            start_page = 1
        elif page.number > paginator.num_pages - 5:
            start_page = paginator.num_pages - 9
        else:
            start_page = page.number - 5

        for i in range(start_page, start_page + 10):
            page_list.append(i)
    else:
        for i in range(1, paginator.num_pages + 1):
            page_list.append(i)

    return page_list
複製程式碼

分頁邏輯：

if 頁數>=10:
    當前頁<=5時，起始頁為1
    當前頁>(總頁數-5)時，起始頁為(總頁數-9)
    其他情況 起始頁為(當前頁-5)
複製程式碼

舉例：

假設一共16頁
情況1: 當前頁==5  則頁碼列表為[1,2,3,4,5,6,7,8,9,10]
情況2: 當前頁==8  則頁碼列表為[3,4,5,6,7,8,9,10,11,12]
情況3: 當前頁==15 則頁碼列表為[7,8,9,10,11,12,13,14,15,16]
複製程式碼

當然你看到這個邏輯會有點亂，建議大家讀著程式碼，多試驗幾遍。

當拿到頁碼列表，我們繼續改寫get_context_data()函式。 將獲取到的classification_list追加到context字典中。

    def get_context_data(self, *, object_list=None, **kwargs):
        context = super(IndexView, self).get_context_data(**kwargs)
        paginator = context.get('paginator')
        page = context.get('page_obj')
        page_list = get_page_list(paginator, page)
        classification_list = Classification.objects.filter(status=True).values()
        context['c'] = self.c
        context['classification_list'] = classification_list
        context['page_list'] = page_list
        return context
複製程式碼

你或許對 paginator = context.get('paginator') page = context.get('page_obj')這兩行程式碼感到陌生，我們只需要知道context.get('page_obj')返回的是當前頁碼，context.get('paginator')返回的是分頁物件，就夠了。更加詳細的介紹，可參考官方。

當資料傳遞給模板之後，模板就負責顯示出來就行了。

因為分頁功能比較常用，所以需要把它單獨拿出來封裝到一個單獨的檔案中，我們新建templates/base/page_nav.html檔案。然後在index.html裡面我們將該檔案include進來。

{% include "base/page_nav.html" %}
複製程式碼

開啟page_nav.html，寫入程式碼

{% if is_paginated %}
<div class="video-page">
    <div class="ui circular labels">
        {% if page_obj.has_previous %}
        <a class="ui circular label" href="?page={{ page_obj.previous_page_number }}{% if c %}&c={{c}}{% endif %}{% if q %}&q={{q}}{% endif %}">&lt;</a>
        {% endif %}
        {% for i in page_list %}
        {% if page_obj.number == i %}
        <a class="ui red circular label">{{ i }}</a>
        {% else %}
        <a class="ui circular label" href="?page={{ i }}{% if c %}&c={{c}}{% endif %}{% if q %}&q={{q}}{% endif %}">{{ i }}</a>
        {% endif %}
        {% endfor %}
        {% if page_obj.has_next %}
        <a class="ui circular label" href="?page={{ page_obj.next_page_number }}{% if c %}&c={{c}}{% endif %}{% if q %}&q={{q}}{% endif %}">&gt;</a>
        {% endif %}
    </div>
</div>
{% endif %}
複製程式碼

上面程式碼中，我們用到了page_obj物件的幾個屬性：has_previous、previous_page_number、next_page_number。通過這幾個屬性，即可實現複雜的頁碼顯示效果。其中我們還這href裡面加了

{% if c %}&c={{c}}
複製程式碼

代表分類的id。

搜尋功能

要實現搜尋，我們需要一個搜尋框

因為搜尋框是很多頁面都需要的，所以我們把程式碼寫到templates/base/header.html檔案裡面。

<div class="ui small icon input v-video-search">
    <input class="prompt" value="{{ q }}" type="text" placeholder="搜尋視訊" id="v-search">
    <i id="search" class="search icon" style="cursor:pointer;"></i>
</div>
複製程式碼

點選搜尋或回車的程式碼寫在了static/js/header.js裡面。

我們還需要配置一下路由，新增一行搜尋的路由。

app_name = 'video'
urlpatterns = [
    path('index', views.IndexView.as_view(), name='index'),
    path('search/', views.SearchListView.as_view(), name='search'),
]
複製程式碼

搜尋路由指向的檢視類為SearchListView

下面我們來寫SearchListView的程式碼

class SearchListView(generic.ListView):
    model = Video
    template_name = 'video/search.html'
    context_object_name = 'video_list'
    paginate_by = 8
    q = ''

    def get_queryset(self):
        self.q = self.request.GET.get("q","")
        return Video.objects.filter(title__contains=self.q).filter(status=0)

    def get_context_data(self, *, object_list=None, **kwargs):
        context = super(SearchListView, self).get_context_data(**kwargs)
        paginator = context.get('paginator')
        page = context.get('page_obj')
        page_list = get_page_list(paginator, page)
        context['page_list'] = page_list
        context['q'] = self.q
        return context
複製程式碼

關鍵程式碼就是Video.objects.filter(title__contains=self.q).filter(status=0) title__contains是包含的意思，表示查詢title包含q的記錄。利用filter將資料過濾出來。這裡寫了兩層過濾，第一層過濾搜尋關鍵詞，第二層過濾status已釋出的視訊。

另外，這裡也用到了get_context_data來存放額外的資料，包括分頁資料、q關鍵詞。

配置模板檔案是templates/video/search.html

因此模板程式碼寫在search.html裡面

<div class="ui unstackable items">

    {% for item in video_list %}
    <div class="item">
        <div class="ui tiny image">
            {% thumbnail item.cover "300x200" crop="center" as im %}
            <img class="ui image" src="{{ im.url }}">
            {% empty %}
            {% endthumbnail %}
        </div>
        <div class="middle aligned content">
          <a class="header" href="{% url 'video:detail' item.pk %}">{{ item.title }}</a>
        </div>
    </div>
    {% empty %}
    <h3>暫無資料</h3>
    {% endfor %}

</div>

{% include "base/page_nav.html" %}
複製程式碼

搜尋功能效果

基於django的視訊點播網站開發-step4-首頁功能

相關文章