萬盛學電腦網

您现在的位置: 萬盛學電腦網 >> 程式設計 >  >> 網路程式設計 >> 程式語言綜合

Django 設定檔部署最佳實踐:多環境配置管理方案

傳統 local_settings.py 痛點


# settings.py 末尾
try:
    from local_settings import *
except ImportError:
    pass

弊端:

  • local_settings.py 不納入版控,生產環境配置易遺失
  • 無法區分開發/測試/生產多環境
  • 敏感資訊 (密鑰、資料庫密碼) 可能誤提交

推薦:模組化設定架構


myproject/
├── settings/
│   ├── __init__.py       # 入口,根據環境變數載入
│   ├── base.py           # 共用基礎配置
│   ├── development.py    # 開發環境
│   ├── testing.py        # 測試環境
│   ├── production.py     # 生產環境
│   └── local.py.sample   # 本地覆蓋範本 (不納入版控)

各層級配置內容

base.py (90% 共用配置)


# myproject/settings/base.py
import os
from pathlib import Path

BASE_DIR = Path(__file__).resolve().parent.parent.parent

SECRET_KEY = os.environ.get('DJANGO_SECRET_KEY', 'dev-only-insecure-key')

INSTALLED_APPS = [
    'django.contrib.admin',
    'django.contrib.auth',
    # ...
    'myapp',
]

MIDDLEWARE = [
    'django.middleware.security.SecurityMiddleware',
    # ...
]

DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.sqlite3',
        'NAME': BASE_DIR / 'db.sqlite3',
    }
}

# 靜態/媒體檔案
STATIC_URL = '/static/'
STATIC_ROOT = BASE_DIR / 'staticfiles'
MEDIA_URL = '/media/'
MEDIA_ROOT = BASE_DIR / 'media'

# 國際化
LANGUAGE_CODE = 'zh-hant'
TIME_ZONE = 'Asia/Taipei'
USE_I18N = True
USE_TZ = True

development.py (開發專用)


# myproject/settings/development.py
from .base import *

DEBUG = True
ALLOWED_HOSTS = ['*']

# 開發工具
INSTALLED_APPS += ['debug_toolbar', 'django_extensions']
MIDDLEWARE += ['debug_toolbar.middleware.DebugToolbarMiddleware']
INTERNAL_IPS = ['127.0.0.1']

# 資料庫可覆蓋為 PostgreSQL
# DATABASES = {...}

# 郵件輸出到主控台
EMAIL_BACKEND = 'django.core.mail.backends.console.EmailBackend'

production.py (生產專用)


# myproject/settings/production.py
from .base import *

DEBUG = False
ALLOWED_HOSTS = ['example.com', 'www.example.com']

# 安全設定
SECURE_SSL_REDIRECT = True
SESSION_COOKIE_SECURE = True
CSRF_COOKIE_SECURE = True
SECURE_HSTS_SECONDS = 31536000
SECURE_HSTS_INCLUDE_SUBDOMAINS = True
SECURE_HSTS_PRELOAD = True

# 資料庫從環境變數讀取
import dj_database_url
DATABASES = {
    'default': dj_database_url.config(conn_max_age=600)
}

# 快取
CACHES = {
    'default': {
        'BACKEND': 'django_redis.cache.RedisCache',
        'LOCATION': os.environ.get('REDIS_URL', 'redis://127.0.0.1:6379/1'),
    }
}

# 日誌
LOGGING = {
    'version': 1,
    'disable_existing_loggers': False,
    'formatters': {
        'verbose': {'format': '%(asctime)s %(levelname)s %(name)s %(message)s'},
    },
    'handlers': {
        'file': {
            'level': 'INFO',
            'class': 'logging.handlers.RotatingFileHandler',
            'filename': '/var/log/django/app.log',
            'maxBytes': 1024*1024*10,
            'backupCount': 5,
            'formatter': 'verbose',
        },
    },
    'root': {'handlers': ['file'], 'level': 'INFO'},
}

環境切換機制

方式一:環境變數指定 (推薦)


# wsgi.py / asgi.py / manage.py
import os
os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'myproject.settings.production')

# 或啟動時指定
DJANGO_SETTINGS_MODULE=myproject.settings.development python manage.py runserver

方式二:settings/__init__.py 自動偵測


# myproject/settings/__init__.py
import os

ENV = os.environ.get('DJANGO_ENV', 'development').lower()

if ENV == 'production':
    from .production import *
elif ENV == 'testing':
    from .testing import *
else:
    from .development import *

# 可選:載入本地覆蓋 (不納入版控)
try:
    from .local import *
except ImportError:
    pass

方式三:python-decouple / django-environ (十二因子應用)


# .env (不納入版控)
DEBUG=True
SECRET_KEY=your-secret-key
DATABASE_URL=postgres://user:pass@localhost:5432/dbname
REDIS_URL=redis://localhost:6379/1

# settings/base.py
from decouple import config, Csv
# 或
import environ
env = environ.Env()
environ.Env.read_env()

DEBUG = config('DEBUG', default=False, cast=bool)
SECRET_KEY = config('SECRET_KEY')
DATABASES = {'default': config('DATABASE_URL', cast=db_url)}

敏感資訊管理原則

  1. 絕不將密鑰、密碼、Token 寫入版控
  2. 使用環境變數或密鑰管理服務 (AWS Secrets Manager, HashiCorp Vault, Kubernetes Secrets)
  3. local.py.sample 提供範本,開發者複製為 local.py 填入本地值
  4. CI/CD 管線注入生產環境變數

遷移檢查清單

  • ✅ 將現有 settings.py 拆分為 base.py + 環境專用檔
  • ✅ 移除 local_settings.py 導入邏輯
  • ✅ 更新 wsgi.py/manage.py 設定模組路徑
  • ✅ 驗證所有環境正常啟動
  • ✅ 確認 .gitignore 包含 settings/local.py, .env
copyright © 萬盛學電腦網 all rights reserved