示例用法¶

为什么要使用站点？最好通过示例来解释。

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, "[email protected]", [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/'

启用站点框架¶

要启用站点框架，请按照以下步骤操作

1. 将'django.contrib.sites' 添加到您的INSTALLED_APPS 设置中。

2. 定义SITE_ID 设置

   SITE_ID = 1
   

3. 运行migrate。

django.contrib.sites 注册了一个 post_migrate 信号处理器，该处理器创建一个名为 example.com 的默认站点，其域名也是 example.com。Django 创建测试数据库后，也会创建此站点。要为您的项目设置正确的名称和域名，可以使用 数据迁移。

为了在生产环境中服务不同的站点，您可以为每个 SITE_ID 创建一个单独的 settings 文件（也许是从一个公共 settings 文件导入，以避免重复共享设置），然后为每个站点指定合适的 DJANGO_SETTINGS_MODULE。

缓存当前 Site 对象¶

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

如果由于任何原因您想强制进行数据库查询，您可以告诉 Django 使用 Site.objects.clear_cache() 清除缓存。

# 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() 将只返回与当前站点关联的 Photo 对象，这取决于 SITE_ID 设置。

换句话说，这两个语句是等效的

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。

最后，请注意，即使您使用 CurrentSiteManager，您可能也希望在您的模型上保留一个普通的（非站点特定的）Manager。如 管理器文档 中所述，如果您手动定义管理器，则 Django 不会为您创建自动的 objects = models.Manager() 管理器。另请注意，Django 的某些部分——即 Django 管理站点和通用视图——使用模型中首先定义的任何管理器，因此，如果您希望您的管理站点能够访问所有对象（而不仅仅是站点特定的对象），请在定义 CurrentSiteManager 之前，在您的模型中放入 objects = models.Manager()。

站点中间件¶

如果您经常使用这种模式

from django.contrib.sites.models import Site


def my_view(request):
    site = Site.objects.get_current()
    ...

为了避免重复，请将 django.contrib.sites.middleware.CurrentSiteMiddleware 添加到 MIDDLEWARE。该中间件在每个请求对象上设置 site 属性，因此您可以使用 request.site 获取当前站点。

Django 如何使用站点框架¶

虽然不需要您使用站点框架，但强烈建议您这样做，因为 Django 在一些地方会利用它。即使您的 Django 安装只为单个站点提供支持，您也应该花两秒钟的时间使用您的 domain 和 name 创建站点对象，并在您的 SITE_ID 设置中指向其 ID。

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

• 在 redirects framework 中，每个重定向对象都与特定站点关联。当 Django 搜索重定向时，它会考虑当前站点。

• 在 flatpages framework 中，每个静态页面都与特定站点关联。创建静态页面时，您需要指定其 Site，并且 FlatpageFallbackMiddleware 会在检索要显示的静态页面时检查当前站点。

• 在 syndication framework 中，title 和 description 的模板会自动访问变量 {{ site }}，它代表当前站点的 Site 对象。此外，如果未指定完全限定的域名，则提供项目 URL 的钩子将使用当前 Site 对象中的 domain。

• 在 authentication framework 中，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()查找当前站点。

当Host头明确指定端口时，例如example.com:80，request.get_host()可能会返回域名和端口。在这种情况下，如果查找失败（因为主机与数据库中的记录不匹配），则会去除端口，并仅使用域名部分重新尝试查找。这并不适用于RequestSite，它将始终使用未修改的主机。