Django Split Settings 使用教程

项目介绍

Django Split Settings 是一个用于组织 Django 项目设置的库，它允许你将 Django 项目的设置拆分为多个文件，以便根据不同的环境（如开发、测试、生产）进行管理。这个库特别适用于处理复杂项目，使得设置的管理和组织更加容易。

项目快速启动

安装

首先，你需要通过 pip 安装 Django Split Settings 库。打开你的终端或命令提示符，运行以下命令：

pip install django-split-settings

配置设置文件

创建单独的设置文件，例如 base.py（通用设置）、development.py（开发环境设置）和 production.py（生产环境设置）。

在 base.py 文件中添加所有环境通用的设置：

# base.py
DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.sqlite3',
        'NAME': 'db.sqlite3',
    }
}
INSTALLED_APPS = [
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',
]

在 development.py 文件中添加开发环境特定的设置：

# development.py
from .base import *

DEBUG = True
DATABASES['default'] = {
    'ENGINE': 'django.db.backends.sqlite3',
    'NAME': 'dev_db.sqlite3',
}

在 production.py 文件中添加生产环境特定的设置：

# production.py
from .base import *

DEBUG = False
DATABASES['default'] = {
    'ENGINE': 'django.db.backends.postgresql',
    'NAME': 'prod_db',
    'USER': 'prod_user',
    'PASSWORD': 'prod_password',
    'HOST': 'localhost',
    'PORT': '5432',
}

创建 split_settings.py 文件

在你的 Django 项目的根目录下创建一个 split_settings.py 文件，并配置环境变量：

# split_settings.py
import os
from split_settings.tools import optional, include

ENV = os.environ.get('DJANGO_ENV') or 'development'

include(
    'settings/base.py',
    f'settings/{ENV}.py',
    optional('settings/local.py')
)

更新 manage.py 和 wsgi.py

更新 manage.py 和 wsgi.py 文件，使其使用 split_settings.py 文件：

# manage.py
import os
import sys

if __name__ == "__main__":
    os.environ.setdefault("DJANGO_SETTINGS_MODULE", "split_settings")
    from django.core.management import execute_from_command_line
    execute_from_command_line(sys.argv)

# wsgi.py
import os
from django.core.wsgi import get_wsgi_application

os.environ.setdefault("DJANGO_SETTINGS_MODULE", "split_settings")
application = get_wsgi_application()

应用案例和最佳实践

应用案例

Django Split Settings 可以用于任何需要根据不同环境进行设置管理的 Django 项目。例如，一个电子商务网站可能需要在开发、测试和生产环境中使用不同的数据库和调试设置。

最佳实践

1. 使用环境变量：通过环境变量指定当前环境，避免硬编码。
2. 安全敏感信息：将敏感信息（如数据库密码、API 密钥）存储在环境变量中，而不是直接写在设置文件中。
3. 版本控制：确保敏感信息不包含在版本控制中，使用 .gitignore 或其他方法排除敏感文件。

典型生态项目

Django Split Settings 可以与其他 Django 生态项目结合使用，例如：

• Django REST Framework：用于构建 RESTful API。
• Whitenoise：用于静态文件服务。
• **Django Debug Toolbar