Django:之Sitemap站点地图、通用视图和上下文渲染器

Django中自带了sitemap框架，用来生成xml文件

Django sitemap演示：

sitemap很重要，可以用来通知搜索引擎页面的地址，页面的重要性，帮助站点得到比较好的收录。

开启sitemap功能的步骤

settings.py文件中django.contrib.sitemaps和django.contrib.sites要在INSTALL_APPS中

INSTALLED_APPS = (
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',
    'django.contrib.sites',
    'django.contrib.sitemaps',
    'django.contrib.redirects',

    #####
    #othther apps
    #####
)

Django 1.7及以前版本：

TEMPLATE_LOADERS中要加入‘django.template.loaders.app_directories.Loader’,像这样：

TEMPLATE_LOADERS ＝ (
    'django.template.loaders.filesystem.Loader',
    'django.template.loaders.app_directories.Loader',
 )

Django 1.8及以上版本新加入了TEMPLATES设置，其中APP_DIRS要为True,比如：

# NOTICE: code for Django 1.8, not work on Django 1.7 and below
TEMPLATES = [
    {
        'BACKEND': 'django.template.backends.django.DjangoTemplates',
        'DIRS': [
            os.path.join(BASE_DIR,'templates').replace('\\', '/'),
        ],
        'APP_DIRS': True,
    },
]

然后在urls.py中如下配置：

from django.conf.urls import url
from django.contrib.sitemaps import GenericSitemap
from django.contrib.sitemaps.views import sitemap

from blog.models import Entry

sitemaps = {
    'blog': GenericSitemap({'queryset': Entry.objects.all(), 'date_field': 'pub_date'}, priority=0.6),
    # 如果还要加其它的可以模仿上面的
}

urlpatterns = [
    # some generic view using info_dict
    # ...

    # the sitemap
    url(r'^sitemap\.xml$', sitemap, {'sitemaps': sitemaps},
        name='django.contrib.sitemaps.views.sitemap'),

但是这样生成的sitemap，如果网站内容太多就很慢，很耗费资源，可以采用分页的功能：

from django.conf.urls import url
from django.contrib.sitemaps import GenericSitemap
from django.contrib.sitemaps.views import sitemap

from blog.models import Entry

from django.contrib.sitemaps import views as sitemaps_views
from django.views.decorators.cache import cache_page

sitemaps = {
    'blog': GenericSitemap({'queryset': Entry.objects.all(), 'date_field': 'pub_date'}, priority=0.6),
    # 如果还要加其它的可以模仿上面的
}

urlpatterns = [
    url(r'^sitemap\.xml$',
        cache_page(86400)(sitemaps_views.index),
        {'sitemaps': sitemaps, 'sitemap_url_name': 'sitemaps'}),
    url(r'^sitemap-(?P<section>.+)\.xml$',
        cache_page(86400)(sitemaps_views.sitemap),
        {'sitemaps': sitemaps}, name='sitemaps'),
]

这样就可以看到类似如下的sitemap，如果本地测试访问http://localhost:8000/sitemap.xml

<?xml version="1.0" encoding="UTF-8"?>
<sitemapindex xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<sitemap><loc>http://localhost:8000/sitemap-tutorials.xml</loc></sitemap>
<sitemap><loc>http://localhost:8000/sitemap-tutorials.xml?p=2</loc></sitemap>
<sitemap><loc>http://localhost:8000/sitemap-tutorials.xml?p=3</loc></sitemap>
<sitemap><loc>http://localhost:8000/sitemap-tutorials.xml?p=4</loc></sitemap>
<sitemap><loc>http://localhost:8000/sitemap-tutorials.xml?p=5</loc></sitemap>
<sitemap><loc>http://localhost:8000/sitemap-tutorials.xml?p=6</loc></sitemap>
<sitemap><loc>http://localhost:8000/sitemap-tutorials.xml?p=7</loc></sitemap>
<sitemap><loc>http://localhost:8000/sitemap-tutorials.xml?p=8</loc></sitemap>
<sitemap><loc>http://localhost:8000/sitemap-tutorials.xml?p=9</loc></sitemap>
</sitemapindex>

查看了下分页是实现了，但是全部显示成了?p=页面数，而且在百度站长平台上测试，发现这样的sitemap百度报错，于是看了下Django的源代码:

在这里 https://github.com/django/django/blob/1.7.7/django/contrib/sitemaps/views.py

于是对源代码作了修改，变成了本站的sitemap的样子，比?p=2这样更优雅

引入下面这个比如是sitemap_views.py

import warnings
from functools import wraps

from django.contrib.sites.models import get_current_site
from django.core import urlresolvers
from django.core.paginator import EmptyPage, PageNotAnInteger
from django.http import Http404
from django.template.response import TemplateResponse
from django.utils import six

def x_robots_tag(func):
    @wraps(func)
    def inner(request, *args, **kwargs):
        response = func(request, *args, **kwargs)
        response['X-Robots-Tag'] = 'noindex, noodp, noarchive'
        return response
    return inner

@x_robots_tag
def index(request, sitemaps,
          template_name='sitemap_index.xml', content_type='application/xml',
          sitemap_url_name='django.contrib.sitemaps.views.sitemap',
          mimetype=None):

    if mimetype:
        warnings.warn("The mimetype keyword argument is deprecated, use "
            "content_type instead", DeprecationWarning, stacklevel=2)
        content_type = mimetype

    req_protocol = 'https' if request.is_secure() else 'http'
    req_site = get_current_site(request)

    sites = []
    for section, site in sitemaps.items():
        if callable(site):
            site = site()
        protocol = req_protocol if site.protocol is None else site.protocol
        for page in range(1, site.paginator.num_pages + 1):
            sitemap_url = urlresolvers.reverse(
                    sitemap_url_name, kwargs={'section': section, 'page': page})
            absolute_url = '%s://%s%s' % (protocol, req_site.domain, sitemap_url)
            sites.append(absolute_url)

    return TemplateResponse(request, template_name, {'sitemaps': sites},
                            content_type=content_type)

@x_robots_tag
def sitemap(request, sitemaps, section=None, page=1,
            template_name='sitemap.xml', content_type='application/xml',
            mimetype=None):

    if mimetype:
        warnings.warn("The mimetype keyword argument is deprecated, use "
            "content_type instead", DeprecationWarning, stacklevel=2)
        content_type = mimetype

    req_protocol = 'https' if request.is_secure() else 'http'
    req_site = get_current_site(request)

    if section is not None:
        if section not in sitemaps:
            raise Http404("No sitemap available for section: %r" % section)
        maps = [sitemaps[section]]
    else:
        maps = list(six.itervalues(sitemaps))

    urls = []
    for site in maps:
        try:
            if callable(site):
                site = site()
            urls.extend(site.get_urls(page=page, site=req_site,
                                      protocol=req_protocol))
        except EmptyPage:
            raise Http404("Page %s empty" % page)
        except PageNotAnInteger:
            raise Http404("No page '%s'" % page)
    return TemplateResponse(request, template_name, {'urlset': urls},
                            content_type=content_type)

如果还不是很懂，可以下载附件查看：sitemap.zip

更多参考：

官方文档：https://docs.djangoproject.com/en/dev/ref/contrib/sitemaps/

Django通用视图

我们用Django开发，比如做一个博客，我们需要做一个博文列表，需要分页，这样我们需要计算出一共有多少篇文章，根据每页显示的博文数量，我们从数据库是显示出相应的页对应的文章，这样使用数据库的查询可以实现，但是这种需求是比较普遍的，所以Django中有更简单的方法来实现，最简单的方法就是使用generic类来做。

有时候我们想将一个模版直接显示出来，还不得不写一个视图函数，其实可以用TemplateView可以直接写在urls.py中，这样的例子还有很多，下面一一介绍：

在urls.py中使用类视图的时候都是调用它都.as_view()函数

一、Base Views

1、django.views.generic.base.View

这个类是通用类的基类，其它类都是继承类自这个类，一般不会用到这个类，个人感觉用函数更简单些。

# views.py
from django.http import HttpResponse
from django.views.generic import View

class MyView(View):

    def get(self, request, *args, **kwargs):
        return HttpResponse('Hello, World!')

# urls.py
from django.conf.urls import patterns, url

from myapp.views import MyView

urlpatterns = patterns('',
    url(r'^mine/$', MyView.as_view(), name='my-view'),
)

2、 django.views.generic.base.TemplateView

在get_context_data()函数中，可以传一些额外内容到模版

# views.py

from django.views.generic.base import TemplateView

from articles.models import Article

class HomePageView(TemplateView):

    template_name = "home.html"

    def get_context_data(self, **kwargs):
        context = super(HomePageView, self).get_context_data(**kwargs)
        context['latest_articles'] = Article.objects.all()[:5]
        return context

# urls.py

from django.conf.urls import patterns, url

from myapp.views import HomePageView

urlpatterns = patterns('',
    url(r'^$', HomePageView.as_view(), name='home'),
)

3. django.views.generic.base.RedirectView

用来进行跳转, 默认是永久重定向（301），可以直接在urls.py中使用，非常方便：

from django.conf.urls import patterns, url
from django.views.generic.base import RedirectView

urlpatterns = patterns('',
    url(r'^go-to-django/$', RedirectView.as_view(url='http://djangoproject.com'), name='go-to-django'),
    url(r'^go-to-ziqiangxuetang/$', RedirectView.as_view(url='http://localhost:8000',permant=False), name='go-to-wulaoer'),
)

其它的使用方式：(new in Django1.6)

# views.py
from django.shortcuts import get_object_or_404
from django.views.generic.base import RedirectView

from articles.models import Article

class ArticleCounterRedirectView(RedirectView):

    url = ' # 要跳转的网址，
    # url 可以不给，用 pattern_name 和 get_redirect_url() 函数 来解析到要跳转的网址

    permanent = False #是否为永久重定向, 默认为 True
    query_string = True # 是否传递GET的参数到跳转网址，True时会传递，默认为 False
    pattern_name = 'article-detail' # 用来跳转的 URL, 看下面的 get_redirect_url() 函数

    # 如果url没有设定，此函数就会尝试用pattern_name和从网址中捕捉的参数来获取对应网址
    # 即 reverse(pattern_name, args) 得到相应的网址，
    # 在这个例子中是一个文章的点击数链接，点击后文章浏览次数加1，再跳转到真正的文章页面
    def get_redirect_url(self, *args, **kwargs):
         If url is not set, get_redirect_url() tries to reverse the pattern_name using what was captured in the URL (both named and unnamed groups are used).
        article = get_object_or_404(Article, pk=kwargs['pk'])
        article.update_counter() # 更新文章点击数，在models.py中实现
        return super(ArticleCounterRedirectView, self).get_redirect_url(*args, **kwargs)

# urls.py
from django.conf.urls import patterns, url
from django.views.generic.base import RedirectView

from article.views import ArticleCounterRedirectView, ArticleDetail

urlpatterns = patterns('',

    url(r'^counter/(?P<pk>\d+)/$', ArticleCounterRedirectView.as_view(), name='article-counter'),
    url(r'^details/(?P<pk>\d+)/$', ArticleDetail.as_view(), name='article-detail'),
)

二，Generic Display View （通用显示视图）

1. django.views.generic.detail.DetailView

DetailView 有以下方法：

1. dispatch()

2. http_method_not_allowed()

3. get_template_names()

4. get_slug_field()

5. get_queryset()

6. get_object()

7. get_context_object_name()

8. get_context_data()

9. get()

10. render_to_response()

# views.py
from django.views.generic.detail import DetailView
from django.utils import timezone

from articles.models import Article

class ArticleDetailView(DetailView):

    model = Article # 要显示详情内容的类

    template_name = 'article_detail.html'
    # 模板名称，默认为 应用名/类名_detail.html（即 app/modelname_detail.html）

    # 在 get_context_data() 函数中可以用于传递一些额外的内容到网页
    def get_context_data(self, **kwargs):
        context = super(ArticleDetailView, self).get_context_data(**kwargs)
        context['now'] = timezone.now()
        return context

# urls.py
from django.conf.urls import url

from article.views import ArticleDetailView

urlpatterns = [
    url(r'^(?P<slug>[-_\w]+)/$', ArticleDetailView.as_view(), name='article-detail'),
]

article_detail.html

<h1>标题：{{ object.title }}</h1>
<p>内容：{{ object.content }}</p>
<p>发表人: {{ object.reporter }}</p>
<p>发表于: {{ object.pub_date|date }}</p>

<p>日期: {{ now|date }}</p>

2. django.views.generic.list.ListView

ListView 有以下方法：

1. dispatch()

2. http_method_not_allowed()

3. get_template_names()

4. get_queryset()

5. get_context_object_name()

6. get_context_data()

7. get()

8. render_to_response()

# views.py
from django.views.generic.list import ListView
from django.utils import timezone

from articles.models import Article

class ArticleListView(ListView):

    model = Article

    def get_context_data(self, **kwargs):
        context = super(ArticleListView, self).get_context_data(**kwargs)
        context['now'] = timezone.now()
        return context

# urls.py:

from django.conf.urls import url

from article.views import ArticleListView

urlpatterns = [
    url(r'^$', ArticleListView.as_view(), name='article-list'),
]

article_list.html

<h1>文章列表</h1>
<ul>
{% for article in object_list %}
    <li>{{ article.pub_date|date }} - {{ article.headline }}</li>
{% empty %}
    <li>抱歉，目前还没有文章。</li>
{% endfor %}
</ul>

Class-based views 官方文档:

https://docs.djangoproject.com/en/dev/ref/class-based-views/#built-in-class-based-views-api

Django 上下文渲染器

有时候我们想把一个变量在多个模板之间共用，这时候就可以用 Django 上下文渲染器。

一，初识上下文渲染器

我们从视图函数说起，在 views.py 中返回字典在模板中使用:

from django.shortcuts import render

def home(request):
    return render(request, 'home.html', {'info': 'Welcome to ziqiangxuetang.com !'})

这样我们就可以在模板中使用 info 这个变量了。

{{ info }}

模板对应的地方就会显示：Welcome to wulaoer.com !

但是如果我们有一个变量，比如用户的IP，想显示在每个网页上。再比如显示所有的栏目信息在每个网页上，该怎么做呢？

一种方法是用死代码，直接把栏目固定写在 模块中，这个对于不经常变动的来说也是一个办法，简单高效。但是要是用户的IP这样的因人而异的，或者经常变动的，我们不得不用其它的办法了。

由于上下文渲染器API在Django 1.8 时发生了变化，被移动到了 tempate 文件夹下，所以讲解的时候分两种，一种是 Django 1.8 及以后的，和Django 1.7及以前的。

我们来看Django官方自带的小例子：

Django 1.8 版本：

django.template.context_processors 中有这样一个函数

def request(request):
    return {'request': request}

Django 1.7 及以前的代码在这里：django.core.context_processors.request 函数是一样的。

在settings.py 中：

Django 1.8 版本 settings.py:

TEMPLATES = [
    {
        'BACKEND': 'django.template.backends.django.DjangoTemplates',
        'DIRS': [],
        'APP_DIRS': True,
        'OPTIONS': {
            'context_processors': [
                'django.template.context_processors.debug',
                'django.template.context_processors.request',
                'django.contrib.auth.context_processors.auth',
                'django.contrib.messages.context_processors.messages',
            ],
        },
    },
]

Django 1.7 版本 settings.py 默认是这样的：

TEMPLATE_CONTEXT_PROCESSORS = (
    "django.contrib.auth.context_processors.auth",
    "django.core.context_processors.debug",
    "django.core.context_processors.i18n",
    "django.core.context_processors.media",
    "django.core.context_processors.static",
    "django.core.context_processors.tz",
    "django.contrib.messages.context_processors.messages"
)

我们可以手动添加 request 的渲染器

TEMPLATE_CONTEXT_PROCESSORS = (
    ...
    "django.core.context_processors.request",
    ...
)

这里的 context_processors 中放了一系列的 渲染器，上下文渲染器 其实就是函数返回字典，这些值可以用在模板中。

request 函数就是在返回一个字典，每一个模板中都可以使用这个字典中提供的 request 变量。

比如 在template 中 获取当前访问的用户的用户名：

User Name: {{ request.user.username }}

二，动手写个上下文渲染器

2.1 新建一个项目，基于 Django 1.8，低版本的请自行修改对应地方：

django-admin.py startproject wulaoer
cd wulaoer
python manage.py startapp blog

我们新建了 wulaoer 项目和 blog 这个应用。

把 blog 这个app 加入到 settings.py 中

整个项目当前目录结构如下：

wulaoer
├── blog
│   ├── __init__.py
│   ├── admin.py
│   ├── migrations
│   │   └── __init__.py
│   ├── models.py
│   ├── tests.py
│   └── views.py
├── manage.py
└── wulaoer
    ├── __init__.py
    ├── settings.py
    ├── urls.py
    └── wsgi.py

2.2 我们在 wulaoer/wulaoer 这个目录下（与settings.py 在一起）新建一个 context_processor.py　　

#!/usr/bin/env python
# -*- coding: utf-8 -*-

from django.conf import settings as original_settings

def settings(request):
    return {'settings': original_settings}

def ip_address(request):
    return {'ip_address': request.META['REMOTE_ADDR']}

2.3 我们把新建的两个 上下文渲染器 加入到 settings.py 中：

TEMPLATES = [
    {
        'BACKEND': 'django.template.backends.django.DjangoTemplates',
        'DIRS': [],
        'APP_DIRS': True,
        'OPTIONS': {
            'context_processors': [
                'django.template.context_processors.debug',
                'django.template.context_processors.request',
                'django.contrib.auth.context_processors.auth',
                'django.contrib.messages.context_processors.messages',

                'zqxt.context_processor.settings',
                'zqxt.context_processor.ip_address',
            ],
        },
    },
]

最后面两个是我们新加入的，我们稍后在模板中测试它。

2.4 修改 blog/views.py

from django.shortcuts import render

def index(reuqest):
    return render(reuqest, 'blog/index.html')

def columns(request):
    return render(request, 'blog/columns.html')

2.5 新建两个模板文件，放在 wulaoer/blog/template/blog/ 中

index.html

<h1>Blog Home Page</h1>

DEBUG: {{ settings.DEBUG }}

ip: {{ ip_address }}

columns.html

<h1>Blog Columns</h1>

DEBUG: {{ settings.DEBUG }}

ip: {{ ip_address }}

2.6 修改 wulaoer/urls.py　　

from django.conf.urls import include, url
from django.contrib import admin
from blog import views as blog_views

urlpatterns = [
    url(r'^blog_home/$', blog_views.index),
    url(r'^blog_columns/$', blog_views.columns),
    url(r'^admin/', include(admin.site.urls)),
]

2.7 打开开发服务器并访问，进行测试吧：

python manage.py runserver

就会看到所有的模板都可以使用 settings 和 ip_address 变量：

http://127.0.0.1:8000/blog_home/

http://127.0.0.1:8000/blog_columns/