django-ultracache 2.2

概述

缓存视图、模板片段和任意Python代码。一旦缓存，我们就可以根据用例避免数据库查询和昂贵的计算。在所有情况下，当对象“红”或“蓝”被修改时，受影响的缓存将自动过期，我们无需显式使缓存意识到“红”或“蓝”。

视图

from ultracache.decorators import ultracache

# The decorator with no parameters automatically caches on the request path
# and a minimal
# set of hidden parameters.
@ultracache(300)
class MyView(TemplateView):
    template_name = "my_view.html"

    def get_context_data(self, **kwargs):
        context = super().get_context_data(**kwargs)

        # The URL that was called is eg. http://mysite.com/myview/blue.
        # This view remains cached until "blue" is modified by any other
        # code.
        context["color"] = Color.objects.get(slug=kwargs["color_slug"])

        # Retrieve "red". Even though we never use red further in this code
        # the cached view is still expired when red is modified by any
        # other code.
        red = Color.objects.get(slug="red")

        return context

模板

{# variable "color" is the object "blue" #}
{% load ultracache_tags %}
{% ultracache 300 "color-info" color.pk %}
    {# expensive properties follow #}
    {{ color.compute_valid_hex_codes }}
    {{ color.name_in_all_languages }}
{% endultracache %}

任意Python

from ultracache.utils import Ultracache

...

color_slug = request.GET["color_slug"]
uc = Ultracache(300, "another-identifier", color_slug)
if uc:
    codes = uc.cached
else:
    color = Color.objects.get(slug=color_slug)
    codes = color.compute_valid_hex_codes()
    uc.cache(codes)
print(codes)

具有更具体规则的视图

from ultracache.decorators import ultracache

# Serve different cached versions for anonymous and authenticated users. "request"
# is always in scope in the decorator.
@ultracache(300, "request.user.is_authenticated")
class MyView(TemplateView):
    template_name = "my_view.html"

    def get_context_data(self, **kwargs):
        context = super().get_context_data(**kwargs)
        context["show_private_messages"] = self.request.user.is_authenticated
        return context

安装

1. 将 django-ultracache 安装或添加到您的Python路径。

2. 将 ultracache 添加到您的 INSTALLED_APPS 设置。

3. 将 ultracache.middleware.UltraCacheMiddleware 添加到您的 MIDDLEWARE 设置。建议将其添加为第一个条目之一。

4. 确保 django.template.context_processors.request 在上下文处理器设置中。

功能

1. 缓存模板片段、视图、Django Rest Framework视图集。

2. 它考虑了站点框架，允许每个站点进行不同的缓存。

3. 关键的是，它知道受其缓存影响的模型对象。当一个对象被修改时，所有受影响的缓存键都会自动过期。这使用户可以设置较长的过期时间，而不必担心过期的内容。

4. 缓存失效可以扩展到向Varnish、Nginx或其他反向缓存代理发出清除命令。

用法

from ultracache.decorators import cached_get, ultracache


class CachedView(TemplateView):
    template_name = "cached_view.html"

    @cached_get(300, "request.is_secure()", 456)
    def get(self, *args, **kwargs):
        return super(CachedView, self).get(*args, **kwargs)

@ultracache(300, "request.is_secure()", 456)
class AnotherCachedView(TemplateView):
    template_name = "cached_view.html"

from ultracache.decorators import cached_get

url(
    r"^cached-view/$",
    cached_get(3600)(TemplateView.as_view(
        template_name="myproduct/template.html"
    )),
    name="cached-view"
)

{% load ultracache_tags %}
{% ultracache 3600 "my_identifier" object 123 undefined "string" %}
    {{ object.title }}
{% endultracache %}

{% load ultracache_tags %}
{% ultracache 1200 "outer" %}
    {% ultracache 1200 "inner_one" %}
        title = {{ one.title }}
    {% endultracache %}
    {% ultracache 1200 "inner_two" %}
        title = {{ two.title }}
    {% endultracache %}
{% endultracache %}

# Cache all viewsets
ULTRACACHE = {
    "drf": {"viewsets": {"*": {}}}

}

# Cache a specific viewset by name
ULTRACACHE = {
    "drf": {"viewsets": {"my.app.MyViewset": {}}}

}

# Cache a specific viewset by class
ULTRACACHE = {
    "drf": {"viewsets": {MyViewset: {}}}

}

# Timeouts default to 300 seconds
ULTRACACHE = {
    "drf": {"viewsets": {"*": {"timeout": 1200}}}

}

# Evaluate code to append to the cache key. This example caches differently
# depending on whether the user is logged in or not.
ULTRACACHE = {
    "drf": {"viewsets": {"*": {"evaluate": "request.user.is_anonymous"}}}

}

# Evaluate code to append to the cache key via a callable.
def mycallable(viewset, request):
    if viewset.__class__.__name__ == "foo":
        return request.user.id

ULTRACACHE = {
    "drf": {"viewsets": {"*": {"evaluate": mycallable}}}

}

ULTRACACHE = {
    "purge": {"method": "myproduct.purgers.squid"}
}

virtualenv ve
./ve/bin/pip install -e .
./ve/bin/python bin/cache-purge-consumer.py -c config.yaml

ULTRACACHE = {
    "invalidate": False
}

ULTRACACHE = {
    "max-registry-value-size": 10000
}

ULTRACACHE = {
    "consider-headers": ["cookie"]
}

ULTRACACHE = {
    "consider-cookies": ["sessionid", "some-other-cookie"]
}

它是如何工作的？

django-ultracache通过修改django.template.base.Variable._resolve_lookup和django.db.models.Model.__getattribute__来记录在解析时模型对象的记录。模板标签、装饰器和上下文管理器检查它们包含的对象列表，并在Django的缓存后端中保持注册表。一个信号处理器监视对象的变化并使相应的缓存键过期。

技巧

1. 如果您运行一组Django节点，请确保它们使用共享缓存后端。

2.2

1. Django 4.0兼容性。

2.1.1

1. 确保清除器失败时缓存一致性。

2.1.0

1. Django 3兼容性。

2. 修复潜在的线程局部残留数据问题。

2.0.0

1. 在所有地方删除对站点框架的依赖。如果安装了应用程序，站点框架仍然会自动考虑。

2. 不再在请求中存储元数据，而是在线程局部列表中。

3. 引入类utils.Ultracache，将任意Python代码块提交给缓存。

4. 停止对Django 1的支持。

1.11.12

1. 更简单的基于类的装饰器。

2. 添加Django 2.1和Python 3.6测试。

1.11.11

1. 添加任务测试。

1.11.10

1. 如果找不到pika，则明确抛出异常。

2. cached_get现在考虑在get_context_data中访问的任何对象，而不仅仅是视图模板中访问的对象。

3. 现在将原始请求头与路径一起发送到清除器。这可以实现细粒度的代理失效。

4. Django 2.0和Python 3兼容性。已删除Django 1.9支持。

1.11.9

1. 简化DRF缓存实现。它现在还考虑了子序列化器接触到的对象。

1.11.8

1. DRF设置现在接受点分名称。

2. DRF设置现在接受一个可调用对象，其结果构成了缓存键的一部分。

1.11.7

1. 使用pickle缓存DRF数据，因为DRF使用Python的json库不识别的Decimal类型。

1.11.6

1. 调整DRF装饰器，使其可以在更多地方使用。

1.11.5

1. Django Rest Framework缓存不再缓存整个响应，而只缓存数据和头。

1.11.4

1. 将twisted工作移至django-ultracache-twisted。

2. 如果找不到库，则明确抛出异常。

1.11.3

1. 将twisted目录向下移动一个级别。

1.11.2

1. 正确打包产品，以便包括所有目录。

1.11.1

1. 引入更多防御性代码，以确保在测试运行中的迁移期间不干扰。

1.11.0

1. 为broadcast_purge任务引入rabbitmq-url设置。

2. Django 1.11支持。

3. 弃用Django 1.6支持。

1.10.2

1. 移除依赖于 SITE_ID 的逻辑，以便可以从请求中推断出站点。

1.10.1

1. 为 Django Rest Framework 视图集添加缓存。

2. 与 Django 1.10 兼容。

1.9.1

1. 添加缺失的导入，仅在特定代码路径中暴露。

2. Invalidatesetting 设置未正确加载。已修复。

3. 处理内容类型尚未迁移时的 RuntimeError。

1.9.0

1. 将测试移至 tox。

2. 与 Django 1.9 兼容。

0.3.8

1. 尊重 loaddata 发送的 raw 参数。它防止了冗余的 post_save 处理。

0.3.7

1. 撤销添加模板名称。它在 WSGI 环境中引入了性能惩罚。

2. 进一步减少对缓存的写入次数。

0.3.6

1. （如果可能）将模板名称添加到缓存键中。

2. 减少对 set_many 的调用次数。

0.3.5

1. 检查元数据缓存大小，以防止无限增长。

0.3.4

1. 防止重复设置。

2. 解决与 di[k].append(v) 和 di[k] = di[k] + [v] 相关的明显 Python 错误。后者是安全的。

0.3.3

1. 处理一个缓存的视图在内部渲染另一个缓存的视图的情况，从而可能共享相同的缓存键。

0.3.2

1. ultracache 模板标记现在仅缓存 HEAD 和 GET 请求。

0.3.1

1. 为解决当天 PyPi 错误而发布的简单版本。

0.3

1. 将循环中的 cache.get 替换为 cache.get_many。

0.2

1. 如果 request.get_full_path()、request.path 或 request.path_info 中的任何一个参数是 cached_get 的参数，则不要自动添加 request.get_full_path()。

0.1.6

1. 也缓存响应头。

0.1.5

1. 显式检查 GET 和 HEAD 请求方法，并仅缓存这些请求。

0.1.4

1. 将装饰器重写为基于函数的，而不是基于类的，以便在 urls.py 中更容易使用。

0.1.3

1. cached_get 装饰器现在如果请求包含消息则不缓存。

0.1.2

1. 修复 HTTPResponse 缓存错误。

0.1.1

1. 处理视图返回 HTTPResponse 对象的情况。

0.1

1. 首次发布。