z3c.caching 3.0

严格模式

默认情况下，在使用规则集之前不需要声明其类型。这很方便，但会增加出现拼写错误或语义上等效的规则集大量增加的风险。如果您想避免这种情况，可以将规则集放入显式模式，如下所示

from z3c.caching.registry import setExplicitMode
setExplicitMode(True)

最后修改日期/时间

可以使用ILastModified适配器接口来描述给定发布对象的最后修改日期。

class ILastModified(Interface):
    """An abstraction to help obtain a last-modified date for a published
    resource.

    Should be registered as an unnamed adapter from a published object
    (e.g. a view).
    """

    def __call__():
        """Return the last-modified date, as a Python datetime object.

        The datetime returned must be timezone aware and should normally
        be in the local timezone.

        May return None if the last modified date cannot be determined.
        """

为此接口提供了一个默认实现：当查询Zope浏览器视图时，它将委托给视图上下文上的ILastModified适配器。高级包可以选择为其他类型的发布资源以及/或不同类型的视图上下文实现此适配器。

缓存清除

高流量网站经常在Web应用程序服务器前面放置缓存代理，如Squid或Varnish，以卸载资源的缓存。这些代理可以通过响应头进行控制（可能是基于z3c.caching规则集查找的缓存操作设置的）。大多数缓存代理还支持所谓的PURGE请求，其中Web应用程序直接向缓存代理发送请求，要求其清除（可能是旧的）可能持有的资源副本（例如，因为该资源已更改）。

此包不实现与缓存代理的任何通信。如果您需要在Zope 2环境中需要，请考虑plone.cachepurging。然而，包括了一些组件来帮助包声明它们与支持清除的缓存代理相关的行为。

首先，z3.caching定义了一个Purge事件，该事件描述了接口z3c.caching.interfaces.IPurgeEvent。

class IPurgeEvent(IObjectEvent):
    """Event which can be fired to purge a particular object.

    This event is not fired anywhere in this package. Instead, higher level
    frameworks are expected to fire this event when an object may need to be
    purged.

    It is safe to fire the event multiple times for the same object. A given
    object will only be purged once.
    """

如果一个对象已经更改，可能需要清除，您可以触发此事件，如下所示

from z3c.caching.purge import Purge
from zope.event import notify

notify(Purge(context))

高级框架（如plone.cachepurging）可以监听此事件，为对象排队清除请求。

当然，清除对象缓存表示的最常见原因是它已被修改或删除。z3c.caching为标准事件提供了事件处理器：IObjectModifiedEvent、IObjectMovedEvent和IObjectRemovedEvent，这些事件重新广播修改/移动/删除对象的Purge事件。

要选择这些事件处理器，只需使用IPurgeable接口标记您的内容对象，例如

from z3c.caching.interfaces import IPurgeable

class MyContent(Persistent):
    implements(IPurgeable)

    ...

您也可以在ZCML中声明性地执行此操作，即使对于您无法控制的类

<class class=".content.MyContent">
    <implements interface="z3c.caching.interfaces.IPurgeable" />
</class>

这些助手可以向类似于plone.cachepurging的框架发送信号，表明对象需要被清除，但这不足以知道如何构造PURGE请求。缓存代理还需要被告知要清除哪个或哪些路径。这是IPurgePaths适配器接口的职责。

class IPurgePaths(Interface):
    """Return paths to send as PURGE requests for a given object.

    The purging hook will look up named adapters from the objects sent to
    the purge queue (usually by an IPurgeEvent being fired) to this interface.
    The name is not significant, but is used to allow multiple implementations
    whilst still permitting per-type overrides. The names should therefore
    normally be unique, prefixed with the dotted name of the package to which
    they belong.
    """

    def getRelativePaths():
        """Return a list of paths that should be purged. The paths should be
        relative to the virtual hosting root, i.e. they should start with a
        '/'.

        These paths will be rewritten to incorporate virtual hosting if
        necessary.
        """

    def getAbsolutePaths():
        """Return a list of paths that should be purged. The paths should be
        relative to the  domain root, i.e. they should start with a '/'.

        These paths will *not* be rewritten to incorporate virtual hosting.
        """

“相对”路径和“绝对”路径之间的区别只有在使用虚拟主机时才会生效。在大多数情况下，您希望实现getRelativePaths()以返回一个相对于当前虚拟主机根的路径。在Zope 2中，您可以通过任何可遍历项上的absolute_url_path()函数来获取这个路径。或者，您可以查找一个IAbsoluteURL适配器并丢弃域名部分。

getAbsolutePaths()主要对缓存代理的“特殊”路径有用。例如，您可以将Varnish配置为在向/_purge_all发送请求时清除整个缓存，然后实现getAbsolutePaths()以返回包含该字符串的迭代器。

以下是来自plone.cachepurging的默认实现，该实现清除由Zope 2的OFS.Traversable派生的对象的默认路径。

class TraversablePurgePaths(object):
    """Default purge for OFS.Traversable-style objects
    """

    implements(IPurgePaths)
    adapts(ITraversable)

    def __init__(self, context):
        self.context = context

    def getRelativePaths(self):
        return [self.context.absolute_url_path()]

    def getAbsolutePaths(self):
        return []

在ZCML中，这被注册为

<adapter factory=".paths.TraversablePurgePaths" name="default" />

Plone特定的plone.app.caching实现了其他适配器（具有其他唯一的名称），用于处理默认视图方法别名（/view）以及Archetypes图像和文件字段的下载路径。

3.0 (2023-02-08)

• 停止支持Python 2.7、3.5、3.6。[icemac]

• 添加对Python 3.9、3.10、3.11的支持。[icemac]

2.2 (2019-10-16)

• 修复弃用警告：从zope.component到zope.interface的导入移动。依赖zope.interface >= 3.8.0。[jensens]

• 添加对Python 3.8a3的支持。[icemac]

2.1 (2018-11-06)

• 将IRuleset的规则集更改为TextLine，以与zope.configuration >= 4.2一起使用。参见Products.CMFPlone#2591。[pbauer]

2.0 (2018-03-22)

• 添加对Python 3.5、3.6、3.7、PyPy2和PyPy3的支持。[icemac]

2.0a1 - 2010年4月22日

• 添加了Purge事件和IPurgeable和IPurgePaths接口。尽管这个包不提供任何清除支持，但为了方便其他包描述它们的缓存清除行为，这里保留必要的接口是有用的。这允许在通用代码中相对无害地依赖z3c.caching，而不是一个更高级的应用服务器特定框架。[optilude]

• 添加了显式声明规则集类型的概念。默认情况下是可选的，但可以通过将explicit设置为True来使其成为必需的。[optilude]

• 添加了ILastModified实现，用于将视图委派给视图的上下文。[optilude]

• 向注册表中添加了enumerateTypes()方法，用于列出所有当前使用的缓存规则ID。[optilude]

• 使注册表更直接地使用ZCA。[matthewwilkes]

1.0b1 - 2008年10月15日

• 初始版本 [wichert]