“站点”框架

使用实例

为什么要用站点？通过例子来解释是最好的。

from django.contrib.sites.models import Site
from django.db import models

class Article(models.Model):
    headline = models.CharField(max_length=200)
    # ...
    sites = models.ManyToManyField(Site)

from django.contrib.sites.models import Site
from django.db import models

class Article(models.Model):
    headline = models.CharField(max_length=200)
    # ...
    site = models.ForeignKey(Site, on_delete=models.CASCADE)

from django.conf import settings

def my_view(request):
    if settings.SITE_ID == 3:
        # Do something.
        pass
    else:
        # Do something else.
        pass

from django.contrib.sites.shortcuts import get_current_site

def my_view(request):
    current_site = get_current_site(request)
    if current_site.domain == 'foo.com':
        # Do something
        pass
    else:
        # Do something else.
        pass

from django.contrib.sites.models import Site

def my_function_without_request():
    current_site = Site.objects.get_current()
    if current_site.domain == 'foo.com':
        # Do something
        pass
    else:
        # Do something else.
        pass

from django.contrib.sites.shortcuts import get_current_site
from django.core.mail import send_mail

def register_for_newsletter(request):
    # Check form values, etc., and subscribe the user.
    # ...

    current_site = get_current_site(request)
    send_mail(
        'Thanks for subscribing to %s alerts' % current_site.name,
        'Thanks for your subscription. We appreciate it.\n\n-The %s team.' % (
            current_site.name,
        ),
        'editor@%s' % current_site.domain,
        [user.email],
    )

    # ...

from django.core.mail import send_mail
from django.template import loader

def register_for_newsletter(request):
    # Check form values, etc., and subscribe the user.
    # ...

    subject = loader.get_template('alerts/subject.txt').render({})
    message = loader.get_template('alerts/message.txt').render({})
    send_mail(subject, message, 'editor@ljworld.com', [user.email])

    # ...

>>> from django.contrib.sites.models import Site
>>> obj = MyModel.objects.get(id=3)
>>> obj.get_absolute_url()
'/mymodel/objects/3/'
>>> Site.objects.get_current().domain
'example.com'
>>> 'https://%s%s' % (Site.objects.get_current().domain, obj.get_absolute_url())
'https://example.com/mymodel/objects/3/'

缓存当前 Site 对象

由于当前站点存储在数据库中，每次调用 Site.objects.get_current() 都可能导致数据库查询。但 Django 比这更聪明：在第一次请求时，当前站点会被缓存，随后的任何调用都会返回缓存的数据，而不是打到数据库。

如果你出于任何原因想要强制查询数据库，你可以使用 Site.objects.clear_cache() 告诉 Django 清除缓存：

# First call; current site fetched from database.
current_site = Site.objects.get_current()
# ...

# Second call; current site fetched from cache.
current_site = Site.objects.get_current()
# ...

# Force a database query for the third call.
Site.objects.clear_cache()
current_site = Site.objects.get_current()

CurrentSiteManager

class managers.CurrentSiteManager

如果 Site 在你的应用中起着关键作用，请考虑在你的模型中使用有用的 CurrentSiteManager。它是一个模型 管理器，可以自动过滤查询，只包含与当前 Site 相关的对象。

使用 CurrentSiteManager，将其显式添加到你的模型中。例如：

from django.contrib.sites.models import Site
from django.contrib.sites.managers import CurrentSiteManager
from django.db import models

class Photo(models.Model):
    photo = models.FileField(upload_to='photos')
    photographer_name = models.CharField(max_length=100)
    pub_date = models.DateField()
    site = models.ForeignKey(Site, on_delete=models.CASCADE)
    objects = models.Manager()
    on_site = CurrentSiteManager()

在这种模式下，Photo.objects.all() 将返回数据库中的所有 Photo 对象，但 Photo.on_site.all() 将根据 SITE_ID 设置，只返回与当前站点相关的 Photo 对象。

换个角度看，这两种说法是等价的：

Photo.objects.filter(site=settings.SITE_ID)
Photo.on_site.all()

CurrentSiteManager 怎么知道 Photo 的哪个字段是 Site？默认情况下， CurrentSiteManager 会寻找一个名为 site 的 ForeignKey 或者一个名为 sites 的 ManyToManyField 来进行过滤。如果你使用一个名为 site 或 sites 以外的字段来识别你的对象与哪些 Site 对象相关，那么你需要显式地将自定义字段名作为参数传递给你的模型上的 CurrentSiteManager。下面的模型，它有一个叫做 publish_on 的字段，演示了这一点：

from django.contrib.sites.models import Site
from django.contrib.sites.managers import CurrentSiteManager
from django.db import models

class Photo(models.Model):
    photo = models.FileField(upload_to='photos')
    photographer_name = models.CharField(max_length=100)
    pub_date = models.DateField()
    publish_on = models.ForeignKey(Site, on_delete=models.CASCADE)
    objects = models.Manager()
    on_site = CurrentSiteManager('publish_on')

如果你试图使用 CurrentSiteManager 并传递一个不存在的字段名，Django 将引发一个 ValueError。

最后，请注意，你可能会希望在你的模型上保留一个正常的（非特定站点的）``Manager``，即使你使用 CurrentSiteManager。正如 管理器文档 中解释的那样，如果你手动定义一个管理器，那么 Django 不会自动为你创建 objects = models.Manager() 管理器。另外要注意的是，Django 的某些部分——即 Django 的管理站点和通用视图——使用模型中 先 定义的管理器，所以如果你想让你的管理站点能够访问所有的对象（不仅仅是站点特定的对象），请在定义 CurrentSiteManager 之前，把 objects = models.Manager() 放在你的模型中。

Django 如何使用站点框架

虽然不要求你使用站点框架，但强烈鼓励你使用，因为 Django 在一些地方利用了它。即使你的 Django 只安装了一个站点，你也应该花两秒钟的时间用你的 domain 和 name 创建站点对象，并在你的 SITE_ID 配置中指向它的 ID。

下面是 Django 如何使用站点框架：

• 在 重定向框架 中，每个重定向对象都与一个特定的站点相关联。当 Django 搜索一个重定向时，它会考虑到当前的站点。
• 在 简单页面框架 中，每个简单页面都与一个特定的站点相关联。当创建一个简单页面时，你指定它的 Site、FlatpageFallbackMiddleware 在检索要显示的简单页面时检查当前站点。
• 在 聚合框架 中，title 和 description` 的模板会自动访问一个变量 {{ site }}，它是代表当前站点的 Site 对象。另外，如果你没有指定一个完全限定的域，提供项目 URL 的钩子将使用当前 Site 对象中的 domain。
• 在 认证框架 中， django.contrib.auth.views.LoginView 将当前 Site 名称作为 {{ site_name }} 传递给模板。
• 便捷工具视图（django.contrib.contenttypes.views.shortcut）在计算对象的 URL 时，使用当前 Site 对象的域名。
• 在管理框架中，“在站点上查看”链接使用当前的 Site 来计算出它将重定向到的站点的域名。

RequestSite 对象

有些 django.contrib 应用程序利用了站点框架的优势，但其架构方式并不 要求 在数据库中安装网站框架。(有些人不想，或者只是不 能 安装额外的数据库表，而这是网站框架所要求的。) 对于这些情况，框架提供了一个 django.contrib.sites.requests.RequestSite 类，当数据库支持的站点框架不可用时，它可以作为后备。

class requests.RequestSite

一个共享 Site 的主要接口的类（即它有 domain 和 name 属性），但它的数据是从 Django HttpRequest 对象而不是数据库中获取的。

__init__(request)

将 name 和 domain 属性配置为 get_host() 的值。

一个 RequestSite 对象的接口与普通的 Site 对象类似，只是它的 __init__() 方法采用了一个 HttpRequest 对象。它能够通过查看请求的域名来推断出 domain 和 name。它有 save() 和 delete() 方法，与 Site 的接口相匹配，但这些方法会引发 NotImplementedError。

get_current_site 便捷工具

最后，为了避免重复的回退代码，框架提供了一个 django.contrib.sites.shortcuts.get_current_site() 函数。

shortcuts.get_current_site(request)

一个检查是否安装了 django.contrib.sites 的函数，并根据请求返回当前的 Site 对象或一个 RequestSite 对象。如果没有定义 SITE_ID 的配置，它就会根据 request.get_host() 来查找当前站点。

当主机头有一个明确指定的端口时，例如 example.com:80，域名和端口都可能被 request.get_host() 返回。在这种情况下，如果因为主机与数据库中的记录不匹配而导致查找失败，那么端口将被剥离，并且只用域名部分重新进行查找。这不适用于 RequestSite，它将始终使用未修改的主机。