使用 Django 进行静态文件版本控制

Question

我正在为 CSS/Javascript 设置远期过期标头，以便浏览器在缓存文件后就不会再次请求这些文件。我还有一个简单的版本控制机制，这样如果文件发生更改，客户端就会知道。

基本上我有一个模板标签，我做了类似

将变为

。

模板标记打开一个文件javascript/c/c.js.v，在其中查找版本号并将其附加到查询字符串。该版本由 shell 脚本生成（目前手动运行，可能会添加预提交挂钩），该脚本检查文件是否已更改（使用 git diff）。

这一切都工作正常，除了：

我也想为图像实现相同类型的版本控制。但图像可以从 CSS 引用 - 这是一个静态文件（由 nginx 提供） - 所以那里没有模板标签。

文件版本控制的更好方法是什么？

或者，我正在考虑用中间件替换模板标签，该中间件在返回响应之前更改所有链接。这比模板标记要好，模板标记可能会被错误地省略。但仍然没有解决CSS引用图像的问题。

另外，我知道将版本作为查询字符串的一部分可能会导致某些代理不缓存文件而出现问题 - 因此我考虑将版本作为文件名的一部分 - 例如 javascript/c/c.123456 .js。

注意：看起来没有办法使用 Django 解决这个问题（显然 - 因为我什至不通过 Django 提供 CSS）。但必须有一个解决方案，也许涉及一些 nginx 技巧。

Answer 1

样式表资源

对于样式表引用的资源，最好使用 Sass 和 Sass。罗盘。 Compass 有一个 mixin，它会自动在样式表中引用的静态资源末尾添加版本查询参数。仅当您重建样式表时，版本号才会发生变化（在本地开发时，这对于 compass watch 来说是微不足道的）。

模板资源

对于其他文件，我实际上会使用某种后拉钩子来重写 python 模块，其唯一目的是包含当前版本。

/var/www/aweso.me/
    ./files/
    ./private-files/
    ./static/
    ./project/
        ./manage.py
        ./fabfile.py
        ./.gitignore
        ./base/
            ./__init__.py
            ./wsgi.py
            ./settings/
                ./__init__.py
                ./modules
                    ./__init__.py
                    ./users.py
                    ./email.py
                    ./beta.py
                    ./redis.py
                    ./haystack.py
                ./version.py
                ./default.py
                ./local.py
                ./live.py

您的帖子拉钩将创建：

/var/www/aweso.me/project/base/settings/version.py

其中包含最新（或以前）的 git commit 哈希：

__version__ = "0763j34bf"

然后在您的 settings.live 中使用简单的 from .version import __version__ as ApplicationVersion ，您的模板标记可以简单地使用 from settings import ApplicationVersion 将该查询参数写入为缓存破坏程序。

Answer 2

我们使用这个简单的模板标签根据文件修改时间生成版本号：

import os
import posixpath
import stat
import urllib

from django import template
from django.conf import settings
from django.contrib.staticfiles import finders

register = template.Library()

@register.simple_tag
def staticfile(path):
    normalized_path = posixpath.normpath(urllib.unquote(path)).lstrip('/')
    absolute_path = finders.find(normalized_path)
    if not absolute_path and getattr(settings, 'STATIC_ROOT', None):
        absolute_path = os.path.join(settings.STATIC_ROOT, path)
    if absolute_path:
        return '%s%s?v=%s' % (settings.STATIC_URL, path, os.stat(absolute_path)[stat.ST_MTIME])
    return path

对于 1.3 之前的 Django，该标签还有更简单的版本：

@register.simple_tag
def staticfile(path):
    file_path = os.path.join(settings.MEDIA_ROOT, path)
    url = '%s%s?v=%s' % (settings.MEDIA_URL, path, os.stat(file_path)[stat.ST_MTIME])
    return url

用法：

<link rel="stylesheet" href="{%  staticfile "css/style.css" %}" type="text/css" media="screen" />

Answer 3

将在我的预提交脚本中添加另一个步骤，以将所有直接链接替换为最小化 CSS 中版本化文件的链接。

看来没有更好的办法了。如果您想到任何答案，请告诉我，我会考虑将该答案标记为已接受的答案。

感谢您的评论！

Answer 4

这也可能有帮助：http://www.fanstatic.org/

Answer 5

我认为一个简单的解决方案可能是：

1. 将 css 文件编写为 Django 模板。
2. 编写一个 Django 命令来呈现您的 css 模板（并将它们存储在可访问的位置）
3. 在您的部署脚本中调用此命令。