如何在Django中实现简单干净的配置？

写在前面

在开发 Django 项目时，随着项目规模的增长，settings.py文件很容易变得繁杂。这么一个庞大而繁杂的配置文件可能会带来困惑、错误和难以维护的问题。本文将探讨一种清晰有序的 Django 配置管理方法。

单个配置文件的问题

随着 Django 项目规模的不断增长，settings.py文件会积累大量的配置项。这种单体化的方法使得定位特定配置、理解其目的和保持代码整洁变得困难。随着项目的发展，如何组织化的解决方案变得尤为重要。

解决方案：模块化配置

我们可以采用模块化的设置来实现配置的清晰可管理。通过将设置分解为较小、专用的文件，可以提高可读性、促进协作并简化调试过程。接下来，我们将探讨如何实施这种模块化结构。

创建一个用于配置的 Python 包

首先，在项目的主文件夹中创建一个名为settings的 Python 包，而不是一个 settings.py 文件。在这个包中，包含以下文件：

__init__.py文件

这个文件作为settings包的入口点。它的作用是导入其他配置文件：

# settings/__init__.py
from .base import *
from .theme import *
from .logging import *
from .rest_framework import *
from .swagger import *
base.py

其中，base.py文件包含了默认settings.py中的原始设置：

# settings/base.py
# 原始的Django设置
DEBUG = True
# … 其他基本设置

theme.py文件

在这个文件中组织与主题相关的设置：

# settings/theme.py
# 与主题相关的设置
THEME_COLOR = 'blue'
# … 其他主题设置

logging.py文件

为了清晰起见，将日志设置单独维护：

# settings/logging.py
# 日志配置
LOGGING = {
 'version': 1,
 # … 其他日志设置
}

rest_framework.py文件

将 Django Rest Framework 的设置分组：

# settings/rest_framework.py
# Django Rest Framework设置
REST_FRAMEWORK = {
 # … 其他DRF设置
}

swagger.py文件

将与 Swagger 相关的设置组织起来：

# settings/swagger.py
# Swagger配置
SWAGGER_SETTINGS = {
 # … 其他Swagger设置
}

在 Django 应用程序中，默认情况下，配置项存储在settings.py文件中。然而，为了更模块化和有组织的方法，我们用一个settings包替换settings.py文件。通过这样做，并在settings/__init__.py文件中导入所有配置，您可以在整个项目中使用模块化的设置。这种方法增强了代码组织能力，使得更容易以更结构化的方式管理和维护各种配置选项。