1. 程式人生 > 程式設計 >自定義Django預設的sitemap站點地圖樣式

自定義Django預設的sitemap站點地圖樣式

Django 中自帶了 sitemap框架,用來生成 xml 檔案

Sitemap(站點地圖)是通知搜尋引擎頁面的地址,頁面的重要性,幫助站點得到比較好的收錄。 白話文就是:一個寫了你網站的所有url的xml檔案,告訴搜尋引擎,請及時收錄我的這些地址。

sitemap 很重要,可以用來通知搜尋引擎頁面的地址,頁面的重要性,幫助站點得到比較好的收錄。

一、站點地圖sitemap

一般在Web網站開發完成之際,如果對搜尋引擎優化(SEO)有一定的要求,我們都會為網站新增一個站點地圖sitemap,配合robot.txt的使用,以彙總和索引網站上所有允許被搜尋引擎搜尋、採集和索引的網頁,這樣搜尋引擎可以根據站點地圖快速地爬取到一個網站上的所有希望被收錄的網址。

在Django框架中,有一個自帶且基本完整的sitemap框架供我們使用。通過Django提供的sitemap,我們可以很快實現是個站點地圖的功能。

二、使用Django的sitemap功能

Django自帶的sitemap使用起來非常簡單,總結起來就是3步。下面,我們以MrDoc中的使用為例。

第一步,新建一個在應用資料夾下新建一個名為sitemap.py的檔案(在MrDoc中的路徑為/MrDoc/app_doc/sitemap.py),根據實際站點的需求,我們準備將首頁、公開的文集和已釋出的文件,放到sitemap中,所以我們要寫例項化幾個Sitemap類,先來引入它:

# MrDoc Sitemap.py
from django.contrib.sitemaps import Sitemap
from django.urls import reverse
from app_doc.models import Doc,Project

定義一個繼承自SiteMap的類,用來生成首頁的sitemap:

自定義Django預設的sitemap站點地圖樣式

接著定義一個文件的sitemap:

# 文件地圖
class DocSitemap(Sitemap):
 changefreq = "daily"
 priority = 0.8

 def __init__(self,pro):
  self.pro = pro

 def items(self):
  return Doc.objects.filter(status=1,top_doc=self.pro)

 def lastmod(self,obj):
  return obj.modify_time

文集的sitemap,我們通過呼叫文件的sitemap來生成:

自定義Django預設的sitemap站點地圖樣式

在sitemap.py檔案中的操作就完成了,我們移步到Django專案的頂級URL路由檔案urls.py中(在MrDoc中的路徑為/MrDoc/MrDoc/urls.py),進行第二步。

引入相關的模組:

from django.contrib.sitemaps import views
from app_doc.sitemaps import all_sitemaps as sitemaps

然後在urlpatterns中新增兩個URL的匹配路徑:

path('sitemap.xml',views.index,{'sitemaps': sitemaps},name='sitemap',),# 站點地圖索引
path('sitemap-<section>.xml',views.sitemap,# 站點地圖
  name='django.contrib.sitemaps.views.sitemap')

最後一步,我們在setting.py檔案中(在MrDoc中的路徑為/MrDoc/MrDoc/settings.py)的應用列表INSTALLED_APPS中將sitemap的功能應用新增進去:

自定義Django預設的sitemap站點地圖樣式

這樣,為Django建立的網站新增sitemap站點地圖功能就已經完成了。我們執行服務,訪問127.0.0.1/sitemap.xml就可以看到站點地圖:

自定義Django預設的sitemap站點地圖樣式

這就是Django自帶的sitemap的樣子了。

站點地圖是出來了,但是和我們平常在一些網站上看到了似乎不太一樣,不僅不能點選上面的連結,樣式也是很簡單的XML結構樹。而州的先生部落格(https://zmister.com)網站上的站點地圖就要美觀好看得多:

自定義Django預設的sitemap站點地圖樣式

如果把Django自帶的sitemap站點地圖美化一下呢?我們可以藉助Django提供了自定義sitemap模板功能。

三、自定義sitemap模板

在Django中,sitemap的樣式存在於\django\contrib\sitemaps\templates\資料夾下,一共有兩個XML模板檔案:

  • sitemap.xml
  • sitemap-index.xml

我們需要做的就是新建兩個xml檔案,在上述兩個檔案的基礎之上,引入XML的樣式檔案,讓XML樣式檔案對XML檔案進行渲染,以實現美化sitemap站點地圖的功能。

我們首先從州的先生部落格(https://zmister.com)上把站點地圖的樣式檔案複製到MrDoc的靜態檔案目錄中(也可以使用其他的XML樣式檔案):

自定義Django預設的sitemap站點地圖樣式

然後在模板目錄template檔案下新建了兩個同名的XML檔案:

自定義Django預設的sitemap站點地圖樣式

在原本的sitemap模板檔案內容中新增一行xml-stylesheet標籤程式碼,用於指示XML樣式檔案的路徑:

自定義Django預設的sitemap站點地圖樣式

最後,修改urls.py檔案,使用template_name鍵指定自定義sitemap模板的名稱:

path('sitemap.xml',# 站點地圖
  name='django.contrib.sitemaps.views.sitemap')

這樣,我們的sitemap站點地圖就是有樣式渲染的頁面了,如下圖所示:

自定義Django預設的sitemap站點地圖樣式

是不是比最開始的簡陋頁面要好多了?原始碼地址為: https://gitee.com/zmister/MrDoc

總結

到此這篇關於自定義Django預設的sitemap站點地圖樣式的文章就介紹到這了,更多相關Django Sitemap 站點地圖內容請搜尋我們以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援我們!