Django中settings的加载原理

在Django中，我们免不了打交道的就是Django的配置文件settings.py，不管是数据库、中间件、自己定义的app等信息，都是在settings中配置的，所以了解settings加载的原理对于我们开发和扩展Django的设置是非常有帮助的。

settings获取顺序

settings中的配置究竟是怎么在Django运行时加载的呢？我们先来了解一下它的加载路径。

在Django中，会有很多默认缺省的配置，如果不在settings.py中重写的话，就会采用默认的配置，它的保存路径位于：django.conf.global_settings，配置非常的多，从中随便截取几个：

DEBUG = False

DEBUG_PROPAGATE_EXCEPTIONS = False

ADMINS = []

INTERNAL_IPS = []

ALLOWED_HOSTS = []

TIME_ZONE = "America/Chicago"

USE_TZ = False

当我们本地通过python manage.py runserver启动服务时，Django会调用manage.py，其中关键的一句：os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'settings文件的路径')。

上面这句代码，会让Django服务到对应路径的settings文件中去加载所有的变量。同时我们也可以看出，Django会获取环境变量 DJANGO_SETTINGS_MODULE 的值，如果我们需要自定义 settings 文件，并且想使用自己的文件，也可以在通过修改这个环境变量的值指向我们自己的配置文件。

自定义settings使用示例

开发过程中，环境分离是很常见的情况，一般都会分开发环境和生产环境。也有些分开发环境、测试环境、生产环境等。

当环境更多的时候，每次变环境都要改一堆配置，比较好的应对方法就是写多个配置文件，通过环境变量来决定使用哪个配置文件。

根据settings文件加载配置的顺序，我们通过下面的例子讲述一下如何自定义settings文件。

新增一个开发环境的配置文件，命名为settings_dev.py，在其中增加数据库相关的配置，并引入原来settings文件中的所有配置。

# settings_dev.py
from .settings import *

DATABASES.update(
    {
        'default': {
            'ENGINE': 'django.db.backends.mysql',
            'NAME': APP_CODE,  # 数据库名
            'USER': 'root',  # 数据库用户
            'PASSWORD': '',  # 数据库密码
            'HOST': '',  # 数据库主机
            'PORT': '3306',  # 数据库端口
        },
    }
)

然后我们再设置一下环境变量DJANGO_SETTINGS_MODULE，将其设置为setting_dev对应的文件路径。

接下来我们通过python manage.py runserver命令启动项目时，就会使用 settings_dev 中的数据库配置信息而不是原来的 settings 中的数据库配置信息。

加载细节

使用方法

当我们要使用 Django 中的 settings 配置时，我们不要通过直接从 settings 文件引入的方式添加，应当通过 Django 本身提供的方式from django.conf import settings，这样得到的是一个经过 Django 处理的懒加载类，获取的才是经过处理后的配置变量值。

源码阅读

通过阅读 settings 加载类的源码可以发现，settings的加载采用了懒加载代理类LazySettings，只有在获取具体 settings 属性值时才会加载，该类位于：django.conf.__init__.py中，我们截取了其中主要的一些方法：

class LazySettings(LazyObject):

    def _setup(self, name=None):
        # 用于加载环境变量DJANGO_SETTINGS_MODULE指定的 settings 文件中的值

    def __repr__(self):
        # 省略...

    def __getattr__(self, name):
        # 省略...

    def __setattr__(self, name, value):
        # 省略...

    def configure(self, default_settings=global_settings, **options):
        # 省略...

# 这个就是django服务使用的settings配置类        
settings = LazySettings()

从上面的代码结构中，我们可以分为以下几步：

1. LazySettings继承自LazyObject，LazyObject本身就是一个延迟加载模块，主要用来实现类的延迟加载，通过继承LazyObject，将LazySettings变成了一个延迟加载类。
2. 重写了父类LazyObject的_setup方法，在其中指定环境变量DJANGO_SETTINGS_MODULE指定的 settings 文件。
3. LazySettings实现__getattr__方法，当调用或查看settings实例属性或方法时，就会去执行_setup方法实际获取上面指定的 settings 文件中的值。

在 LazySettings 中还有个很关键的部分，我们先仔细看一下 _setup方法中的代码：

settings_module = os.environ.get(ENVIRONMENT_VARIABLE)
if not settings_module:
    desc = ("setting %s" % name) if name else "settings"
    raise ImproperlyConfigured(
        "Requested %s, but settings are not configured. "
        "You must either define the environment variable %s "
        "or call settings.configure() before accessing settings."
        % (desc, ENVIRONMENT_VARIABLE)
    )

self._wrapped = Settings(settings_module)

主要是最后一句，self._wrapped = Settings(settings_module)，self._wrapped 代表的是具体要被延迟代理的原始类，在这里就是 Settings 类，我们截取其中__init__比较关键的部分：

def __init__(self, settings_module):
    # update this dict from global settings (but only for ALL_CAPS settings)
    for setting in dir(global_settings):
        if setting.isupper():
            setattr(self, setting, getattr(global_settings, setting))

    # store the settings module in case someone later cares
    self.SETTINGS_MODULE = settings_module

    mod = importlib.import_module(self.SETTINGS_MODULE)
    
    # 省略...
    
    for setting in dir(mod):
    if setting.isupper():
        setting_value = getattr(mod, setting)

        if setting in tuple_settings and not isinstance(
            setting_value, (list, tuple)
        ):
            raise ImproperlyConfigured(
                "The %s setting must be a list or a tuple." % setting
            )
        setattr(self, setting, setting_value)
        self._explicit_settings.add(setting)
        
    # 省略...

上面的代码主要做了下面几件事：

1. 从 Django 默认的conf.global_settings模块中，加载缺省的配置项，并且只加载变量全大写的，并将其作为属性赋给 Settings 类的实例本身。
2. 从环境变量DJANGO_SETTINGS_MODULE指定的 settings 文件中加载所有的配置变量，并且只加载变量为全大写的，并将其作为属性赋给 Settings 类的实例本身。

通过上面的解读，我们可以知道，当我们通过from django.conf import settings时，我们会获取DJANGO_SETTINGS_MODULE指定的 settings 文件中所有大写的变量保存，如果是非全大写的， Settings 类并不会保存！

总结

本次我们主要通过 settings 类加载的机制，了解了一下 Django 中 settings 是如何加载的，以及我们要如何自己进行 settings 文件的编写和配置，能够阅读和理解源码，对于理解框架运行原理非常重要的。