示例用法¶

为什么要使用站点？通过示例进行解释是最好的。

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 创建一个单独的设置文件（可能从通用设置文件导入，以避免复制共享设置），然后为每个站点指定适当的 DJANGO_SETTINGS_MODULE。

缓存当前 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() 将仅返回与当前站点关联的 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 框架 中，title 和 description 的模板会自动访问变量 {{ site }}，它是表示当前站点的 Site 对象。此外，如果你未指定完全限定域名，用于提供项目 URL 的钩子会使用当前 Site 对象的 domain。
• 在 authentication 框架 中，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 头部明确指定了端口时，request.get_host() 可能会返回域和端口，例如 example.com:80。在这种情况下，如果查找失败，因为主机与数据库中的记录不匹配，则会去掉端口，并仅使用域部分重试查找。这不适用于 RequestSite，它始终会使用未修改的主机。