如何在Django中读取外部配置文件并实现全局可用

方案一：借助AppConfig实现初始化加载 #

在你的app的apps.py里，把配置变量提升为模块级变量，这样ready方法读取后就能全局复用：

from django.apps import AppConfig
import yaml
import os
from django.conf import settings

# 定义模块级变量，初始为None
config = None

class YourAppConfig(AppConfig):
    default_auto_field = 'django.db.models.BigAutoField'
    name = 'your_app'  # 替换成你的app名称

    def ready(self):
        global config
        # 用项目根目录拼接路径，避免环境差异导致找不到文件
        config_path = os.path.join(settings.BASE_DIR, "config.yml")
        with open(config_path, "r", encoding="utf-8") as f:
            config = yaml.safe_load(f)

之后在views.py或其他文件里直接导入使用：

from your_app.apps import config

def test_view(request):
    # 直接访问配置项
    api_key = config.get("api_key")
    # ... 业务逻辑

方案二：单独创建配置模块（更推荐） #

如果不想和apps.py耦合，单独建一个config.py文件更清晰：

# your_app/config.py
import yaml
import os
from django.conf import settings

# 模块第一次被导入时自动读取配置，之后所有导入复用同一个变量
config_path = os.path.join(settings.BASE_DIR, "config.yml")
with open(config_path, "r", encoding="utf-8") as f:
    config = yaml.safe_load(f)

在任何需要的地方导入即可：

from your_app.config import config

# 直接使用config中的配置项
print(config["database"]["host"])

关键注意点 #

• 路径正确性：一定要用settings.BASE_DIR拼接配置文件路径，避免本地开发和生产环境的路径差异。
• 敏感信息处理：不要把数据库密码、API密钥这类敏感内容写在YAML文件里，建议用Django自带的secrets.py或者环境变量管理。
• 静态加载限制：这种方式是服务启动时读取一次配置，修改YAML文件后需要重启服务才会生效；如果需要动态重载配置，得额外实现文件监听逻辑，生产环境一般不推荐。

内容的提问来源于stack exchange，提问作者Peter Kronenberg