Flask-Konfigurationsverwaltung

Jede Anwendung benötigt Konfiguration – Datenbankadressen, Schlüssel, Debug-Modus-Schalter und so weiter.

Flask bietet ein flexibles Konfigurationssystem, das das Laden von Konfiguration aus mehreren Quellen unterstützt, um unterschiedliche Anforderungen in Entwicklung und Produktion zu erfüllen.

Grundlagen des Konfigurationsobjekts

Flask-Anwendungskonfiguration wird inapp.configgespeichert. Sie ist wie ein Wörterbuch, und Sie können jeden Konfigurationswert über den Schlüsselnamen lesen und schreiben:

Namen der KonfigurationsschlüsselMüssen vollständig in Großbuchstaben geschrieben seinDies ist eine Flask-Konvention, die zusammen mit den Methoden zum Laden der Konfiguration verwendet wird.

Integrierte Konfigurationselemente

Flask verfügt über eine große Anzahl integrierter Konfigurationselemente, um das Verhalten des Frameworks zu steuern. Die folgenden werden in der Entwicklung am häufigsten verwendet:

Aus Python-Datei laden — from_pyfile

Die gängigste Praxis ist, die Konfiguration in eine separate Python-Datei zu schreiben und sie dann zu laden:

# 文件路径：config.py（与 app.py 同级目录）
# 注意：所有键名必须大写
SECRET_KEY = "your-production-secret-key"
DATABASE_URL = "postgresql://user:pass@localhost/db"
MAX_CONTENT_LENGTH = 16 * 1024 * 1024  # 限制上传文件大小 16MB

# 开发配置
DEBUG = True

app.py-Code:

# 文件路径：app.py
from flask import Flask

app = Flask(__name__)

# 加载 config.py 中所有大写的变量到 app.config
app.config.from_pyfile("config.py")

print(app.config["DATABASE_URL"])  # 输出: postgresql://user:pass@localhost/db

Aus Umgebungsvariablen laden——from_prefixed_env

Das Laden aus Umgebungsvariablen ist eine empfohlene Praxis der 12-Faktor-App und am besten für den Produktionseinsatz geeignet.

Flask liest standardmäßigFLASK_Umgebungsvariablen mit dem Präfix, und es wird versucht, die Werte als JSON-Typ zu parsen:

# 在终端设置环境变量（或写入 .flaskenv 文件）
export FLASK_SECRET_KEY="prod-secret"
export FLASK_MAX_CONTENT_LENGTH=16777216

app.py-Code:

from flask import Flask
from datetime import timedelta

app = Flask(__name__)

# 加载默认配置
app.config["PERMANENT_SESSION_LIFETIME"] = timedelta(days=7)

# 自动加载所有以 FLASK_ 开头的环境变量
# 例如 FLASK_SECRET_KEY 会成为 config["SECRET_KEY"]
app.config.from_prefixed_env()

# 也可以自定义前缀
# app.config.from_prefixed_env("EXAMPLE")  # 加载 EXAMPLE_ 前缀的变量

Verschachtelte Konfiguration

Verwendung doppelter Unterstriche__Verschachtelte Konfiguration kann festgelegt werden:

$ export FLASK_DATABASE__HOST="localhost"
$ export FLASK_DATABASE__PORT="5432"

Ergebnis nach dem Laden:

Aus JSON/TOML laden — from_file

Neben Python-Dateien und Umgebungsvariablen unterstützt Flask auch das Laden von Konfiguration aus Formaten wie JSON und TOML:

Laden aus einem Objekt——from_object

Lade alle Attribute in Großbuchstaben direkt aus einem Python-Objekt (Modul oder Klasse):

Der Instanzordner – private Konfiguration

Einige Konfigurationen eignen sich nicht zum Committen in ein Code-Repository (wie Produktionsgeheimnisse). Sie können iminstance-Ordner liegen:

myflaskapp/
├── app.py
├── config.py         # 公共配置（可提交到 Git）
└── instance/          # 不提交到 Git（.gitignore）
    └── config.py     # 私密配置（密钥等）

Priorität beim Laden der Konfiguration

Eine übliche Reihenfolge zum Laden der Konfiguration in der Praxis:

Diese Priorität stellt sicher: Standardwerte sind am schwächsten, Dateikonfiguration ist mittel und Umgebungsvariablen sind am stärksten – entsprechend den Best Practices der 12-Factor App.