Django怎么生成XML格式的Sitemap

14次阅读

推荐使用 django 内置的 django.contrib.sitemaps 模块生成符合协议的 xml Sitemap,通过定义 Sitemap 类、注册到 URL 路由,自动支持分页与索引文件,并需注意域名配置、字段非空及路由验证。

Django怎么生成XML格式的Sitemap

Django 生成 XML 格式的 Sitemap,推荐使用内置的 django.contrib.sitemaps 模块,它专为生成符合 Sitemaps 协议 的 XML 文件而设计,无需手动拼接字符串或使用第三方库。

配置 Sitemap 类

在应用目录下(如 myapp/sitemaps.py)定义一个或多个继承Sitemap 的类。每个类需指定数据源(items())、URL 构造逻辑(location())、更新频率(changefreq)和权重(priority)等:

# myapp/sitemaps.py from django.contrib.sitemaps import Sitemap from .models import Article, Category 

class ArticleSitemap(Sitemap): changefreq = 'weekly' priority = 0.8

def items(self):     return Article.objects.filter(is_published=True)  def lastmod(self, obj):     return obj.updated_at  def location(self, obj):     return f'/article/{obj.slug}/'

class CategorySitemap(Sitemap): changefreq = 'monthly' priority = 0.5

def items(self):     return Category.objects.all()  def location(self, obj):     return f'/category/{obj.slug}/'

注册 Sitemap 到 URL 路由

在项目主 urls.py 中导入并注册 Sitemap 视图。Django 会自动渲染标准 XML 格式:

# urls.py from django.contrib.sitemaps.views import sitemap from myapp.sitemaps import ArticleSitemap, CategorySitemap 

sitemaps = { 'articles': ArticleSitemap, 'categories': CategorySitemap, }

urlpatterns = [

其他路由...

path('sitemap.xml', sitemap, {'sitemaps': sitemaps}, name='django.contrib.sitemaps.views.sitemap'),

]

访问 /sitemap.xml 即可看到结构清晰、带命名空间的 XML 输出,包含 等标准标签。

支持分页与大型站点

当条目超过 5 万或 XML 文件过大时,Django 会自动分片(如 sitemap-articles.xmlsitemap-categories.xml),并生成索引文件 sitemap.xml。只需确保:

  • 每个 Sitemap 类的 limit 属性未设为过小(默认 45000)
  • sitemaps 字典中为每个类使用唯一键名
  • 确认视图参数传入的是字典而非列表

部署前检查要点

确保生成的 Sitemap 可被搜索引擎正确抓取:

  • 域名必须匹配 request.get_host(),生产环境设置 ALLOWED_HOSTSSECURE_proxy_ssl_HEADER(若用 https
  • 模型字段如 updated_atslug 不为空,否则 location()lastmod() 可能报错
  • 可通过 python manage.py show_urls(需安装 django-extensions)验证路由是否生效

text=ZqhQzanResources