Flask-Static-Digest 项目教程

1. 项目的目录结构及介绍

Flask-Static-Digest 是一个用于处理静态文件缓存问题的 Flask 扩展。以下是该项目的目录结构及其介绍：

flask-static-digest/
├── flask_static_digest/
│   ├── __init__.py
│   ├── digester.py
│   ├── gzipper.py
│   ├── brotli.py
│   └── utils.py
├── tests/
│   ├── __init__.py
│   ├── test_digester.py
│   ├── test_gzipper.py
│   └── test_brotli.py
├── setup.py
├── README.md
└── LICENSE

目录结构介绍

• flask_static_digest/: 核心代码目录，包含扩展的主要功能实现。
  • __init__.py: 初始化文件，定义了扩展的入口点。
  • digester.py: 处理静态文件的 MD5 标签功能。
  • gzipper.py: 处理静态文件的 Gzip 压缩功能。
  • brotli.py: 处理静态文件的 Brotli 压缩功能。
  • utils.py: 工具函数文件，包含一些辅助函数。
• tests/: 测试代码目录，包含各种测试用例。
  • __init__.py: 初始化文件，用于组织测试模块。
  • test_digester.py: 针对 digester.py 的测试用例。
  • test_gzipper.py: 针对 gzipper.py 的测试用例。
  • test_brotli.py: 针对 brotli.py 的测试用例。
• setup.py: 安装脚本，用于打包和分发扩展。
• README.md: 项目说明文档，包含项目的基本信息和使用方法。
• LICENSE: 项目许可证文件，声明项目的许可协议。

2. 项目的启动文件介绍

Flask-Static-Digest 的启动文件主要是 flask_static_digest/__init__.py。该文件定义了扩展的入口点，并初始化了扩展的主要功能。

__init__.py 文件介绍

from .digester import Digester
from .gzipper import Gzipper
from .brotli import Brotli
from .utils import get_hashed_filename

class StaticDigest:
    def __init__(self, app=None):
        if app is not None:
            self.init_app(app)

    def init_app(self, app):
        self.app = app
        self.digester = Digester(app)
        self.gzipper = Gzipper(app)
        self.brotli = Brotli(app)
        self.app.add_template_global(get_hashed_filename, name='get_hashed_filename')

启动文件功能介绍

• StaticDigest 类：定义了扩展的主要功能，包括初始化应用、创建 Digester、Gzipper 和 Brotli 实例，并添加模板全局函数 get_hashed_filename。
• init_app 方法：用于初始化应用，将扩展的功能绑定到 Flask 应用实例上。

3. 项目的配置文件介绍

Flask-Static-Digest 的配置文件主要是 Flask 应用的配置文件。以下是一些常用的配置项：

配置项介绍

class Config:
    STATIC_FOLDER = 'static'  # 静态文件目录
    STATIC_URL_PATH = '/static'  # 静态文件 URL 路径
    STATIC_DIGEST_ALGORITHM = 'md5'  # 静态文件哈希算法
    STATIC_DIGEST_EXTENSION = '.gz'  # 静态文件压缩扩展名
    STATIC_DIGEST_BROTLI = True  # 是否启用 Brotli 压缩

配置文件示例

from flask import Flask
from flask_static_digest import StaticDigest

app = Flask(__name__)
app.config['STATIC_FOLDER'] = 'static'
app.config['STATIC_URL_