从 Scrapy 到 Django，必须掌握(2)：settings 详解

最新推荐文章于 2025-05-26 22:59:33 发布

原创最新推荐文章于 2025-05-26 22:59:33 发布 · 948 阅读

10 ·

CC 4.0 BY-SA版权

文章标签：

#数据库 #jvm #oracle #django #服务器

scrapy到django 专栏收录该内容

11 篇文章

订阅专栏

一、Django 中settings模块的概述

Django 的 settings 是框架的核心配置模块，用于管理一个项目的全局配置。Django 项目的运行、功能扩展、安全管理依赖于一系列参数配置，这些配置项就是 settings 中的内容。

当你创建一个 Django 项目时，系统会自动生成一个默认的 settings.py 文件。该文件包含了一些通用的应用配置，比如数据库连接、安装的应用、静态文件管理、模板设置等。settings.py 是整个项目的“大脑”，决定着你的项目如何运行。

二、settings模块的重要功能和作用

Django 的 settings 模块的意义在于实现全局的统一配置，并具备以下功能：

负责项目配置与控制：
所有的功能、应用行为、外部依赖项都通过 settings 文件进行控制。例如，调试模式 (DEBUG)、时区设置、语言设置、外部服务引入都是通过这个文件完成。
管理项目的依赖：
包括数据库连接配置、缓存引擎配置、邮件服务器配置等。
调试与生产环境配置分离：
在开发时使用调试设置（打开 DEBUG、用 SQLite 数据库），而在生产环境使用更高效、安全的设置（关闭 DEBUG、用更强大的数据库）。
项目组件间的协同配置：
比如模板引擎、静态文件、媒体文件等设置都写入了 settings.py 方便覆盖和调整。
提供灵活的多环境配置支持：
可根据开发环境、测试环境和生产环境的切换，使用不同的配置文件。

三、Djangosettings.py常见设置项详解

接下来，我们从实际应用的角度来详细解析 settings 文件中常见的设置参数，并结合案例逐一说明。

1.基本项目设置

这些是控制项目运行的基本参数。

DEBUG：
- 作用：控制项目是否处于开发模式。开发模式下会显示详细的错误信息；生产环境应设为 False。
- 示例：
```
DEBUG = True  # 开发阶段
DEBUG = False  # 生产环境
```
- 注意：在生产环境下，DEBUG 必须为 False，以避免敏感信息暴露。
ALLOWED_HOSTS：
- 作用：定义允许访问此 Django 项目的网站域名或 IP 地址，防止 HTTP Host Header 攻击。
- 示例：
```
ALLOWED_HOSTS = ['localhost', '127.0.0.1', '.example.com']
```
- 注意：ALLOWED_HOSTS 需要在生产环境中适配你的实际域名，使用 '*' 不推荐，除非测试环境。

2.应用程序定义

Django 项目需要用到的应用和库配置在这里。

INSTALLED_APPS：

作用：列出了当前项目中安装的所有应用程序（包括内置和自定义应用）。

示例：

INSTALLED_APPS = [
    'django.contrib.admin',  # 管理后台
    'django.contrib.auth',  # 用户认证
    'django.contrib.contenttypes',  # 内容类型系统
    'django.contrib.sessions',  # 会话管理
    'django.contrib.messages',  # 消息提示框
    'django.contrib.staticfiles',  # 静态文件管理
    'myapp',  # 自定义应用
]

扩展：自定义应用需要用 python manage.py startapp app_name 创建，再添加到此处。

3.中间件定义

MIDDLEWARE：

作用：中间件是 Django 项目中的钩子，用于请求和响应过程中增加额外的功能（如安全检查、会话处理）。

示例：

MIDDLEWARE = [
    'django.middleware.security.SecurityMiddleware',
    'django.contrib.sessions.middleware.SessionMiddleware',
    'django.middleware.common.CommonMiddleware',
    'django.middleware.csrf.CsrfViewMiddleware',
    'django.contrib.auth.middleware.AuthenticationMiddleware',
    'django.contrib.messages.middleware.MessageMiddleware',
    'django.middleware.clickjacking.XFrameOptionsMiddleware',
]

扩展：比如，你可以新增一个自定义中间件来记录所有请求。

4. 数据库配置

数据库是任何 Web 应用的核心，Django 使用 DATABASES 字典来配置数据库相关参数。

DATABASES：

作用：定义项目中使用的数据库。支持 PostgreSQL、MySQL、SQLite、Oracle 等。

示例（默认 SQLite 数据库）：

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

示例（MySQL 数据库）：

DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.mysql',
        'NAME': 'mydatabase',
        'USER': 'mydatabaseuser',
        'PASSWORD': 'mypassword',
        'HOST': 'localhost',  # 默认本地
        'PORT': '3306',  # 默认端口
    }
}

扩展：可以引入 dj-database-url 的第三方库以支持多环境动态数据库配置。

5. 模板与静态文件设置

模板与静态文件用于呈现页面内容（HTML、CSS、JS 等）。

TEMPLATES：

作用：配置模板引擎相关参数。

示例：

TEMPLATES = [
    {
        'BACKEND': 'django.template.backends.django.DjangoTemplates',
        'DIRS': [BASE_DIR / 'templates'],  # 自定义模板路径
        'APP_DIRS': True,
        'OPTIONS': {
            'context_processors': [
                'django.template.context_processors.debug',
                'django.template.context_processors.request',
                'django.contrib.auth.context_processors.auth',
                'django.contrib.messages.context_processors.messages',
            ],
        },
    },
]

STATIC_URL 和 STATICFILES_DIRS：
- 作用：配置静态文件路径。
- 示例：
```
STATIC_URL = '/static/'
STATICFILES_DIRS = [BASE_DIR / 'static']
```
MEDIA_URL 和 MEDIA_ROOT：
- 作用：配置媒体文件路径，如用户上传的图片、视频等。
- 示例：
```
MEDIA_URL = '/media/'
MEDIA_ROOT = BASE_DIR / 'media'
```

6. 国际化与本地化

Django 提供了强大的国际化和本地化支持。

LANGUAGE_CODE：

作用：设置默认语言。

示例：

LANGUAGE_CODE = 'zh-hans'  # 简体中文
LANGUAGE_CODE = 'en-us'  # 美式英语

TIME_ZONE：
- 作用：定义时区。
- 示例：
```
TIME_ZONE = 'Asia/Shanghai'
```

USE_I18N、USE_L10N 和 USE_TZ：

作用：控制是否启用国际化、本地化和时区支持。

示例：

USE_I18N = True  # 启用国际化支持
USE_L10N = True  # 启用本地化支持
USE_TZ = True    # 启用时区支持

7. 安全相关的设置

SECRET_KEY：
- 作用：Django 内部加密功能所用的密钥。
- 注意：生产环境中必须安全存储。
CSRF_TRUSTED_ORIGINS：
- 作用：允许从哪些域名发送跨站请求。
- 示例：
```
CSRF_TRUSTED_ORIGINS = ['https://example.com']
```

8. 邮件配置

Django 本身支持邮件发送，可通过如下配置实现。

配置示例：

EMAIL_BACKEND = 'django.core.mail.backends.smtp.EmailBackend'
EMAIL_HOST = 'smtp.gmail.com'
EMAIL_PORT = 587
EMAIL_USE_TLS = True
EMAIL_HOST_USER = 'your_email@gmail.com'
EMAIL_HOST_PASSWORD = 'your_password'

9.Logging 配置

Django 提供了强大的日志功能，它允许开发者捕获和记录不同级别的事件日志。这可以帮助调试和监控应用的行为。

一个典型的 LOGGING 配置示例如下：

LOGGING = {
    'version': 1,  # 日志配置的版本（固定为1）
    'disable_existing_loggers': False,  # 禁止禁用默认日志处理器
    'handlers': {
        'file': {
            'level': 'DEBUG',  # 只记录 DEBUG 及以上的日志
            'class': 'logging.FileHandler',  # 日志保存到文件中
            'filename': 'debug.log',  # 日志文件路径
        },
    },
    'loggers': {
        'django': {
            'handlers': ['file'],
            'level': 'DEBUG',  # 设置日志级别
            'propagate': True,  # 是否向父日志记录器传播
        },
    },
}

这段配置会将所有 DEBUG 及以上级别的日志保存到名为 debug.log 的文件中。例如，当某些错误发生时，你可以直接查看日志文件，以便分析问题。

10.缓存 (Caching) 设置

Django 支持多种缓存后端，用于优化查询或减少对数据库的频繁访问。缓存可以存放在内存、文件系统、数据库甚至外部服务（如 Redis 或 Memcached）中。

以下是一个 Redis 缓存的示例配置：

CACHES = {
    'default': {
        'BACKEND': 'django.core.cache.backends.redis.RedisCache',
        'LOCATION': 'redis://127.0.0.1:6379/1',  # Redis 地址和端口
    }
}

如果你希望使用内存缓存，可以使用以下配置（适合开发环境测试）：

CACHES = {
    'default': {
        'BACKEND': 'django.core.cache.backends.locmem.LocMemCache',
        'LOCATION': 'unique-snowflake',  # 内存缓存的唯一标识
    }
}

缓存的具体应用可以是模板缓存、视图缓存或每个应用模块独立的缓存策略。

11.文件上传设置

Django 允许用户上传文件（如图片、文档）。这涉及以下两个重要的设置：

MEDIA_URL: 表示用户上传文件在浏览器中的访问路径。
MEDIA_ROOT: 表示用户上传的文件在服务器上的存储路径。

示例如下：

MEDIA_URL = '/media/'  # 文件访问路径
MEDIA_ROOT = BASE_DIR / 'media'  # 文件保存路径

其中，通常需要在项目的 urls.py 文件中添加路由配置以处理用户上传的文件：

from django.conf import settings
from django.conf.urls.static import static

urlpatterns = [
    # 你的其他 URL 路由
] + static(settings.MEDIA_URL, document_root=settings.MEDIA_ROOT)

12.自定义用户模型

如果需要扩展 Django 的用户系统，可以定义自定义的用户模型。你需要在 settings.py 中设置 AUTH_USER_MODEL 变量，指定自定义用户模型类的位置。例如：

AUTH_USER_MODEL = 'myapp.CustomUser'

这里的 myapp.CustomUser 指的是你在 myapp/models.py 中定义的自定义用户模型。

13.REST API 配置

如果你的项目使用 Django REST Framework（DRF），通常会在 settings.py 中添加 DRF 的配置：

REST_FRAMEWORK = {
    'DEFAULT_AUTHENTICATION_CLASSES': [
        'rest_framework.authentication.SessionAuthentication',
        'rest_framework.authentication.BasicAuthentication',
    ],
    'DEFAULT_PERMISSION_CLASSES': [
        'rest_framework.permissions.IsAuthenticated',
    ],
}

这个配置表示：默认情况下，REST API 需要认证用户，并且只有认证用户可以访问 API。

14.会话引擎 (Session Engine)

Django 的会话管理允许你存储和检索用户的会话信息。可以通过 SESSION_ENGINE 配置来决定会话数据的存储方式：

使用数据库存储（默认）：

SESSION_ENGINE = 'django.contrib.sessions.backends.db'

使用缓存存储：

SESSION_ENGINE = 'django.contrib.sessions.backends.cache'

缓存 + 数据库存储（推荐在缓存可能丢失时使用）：
```
SESSION_ENGINE = 'django.contrib.sessions.backends.cached_db'
```

文件存储：

SESSION_ENGINE = 'django.contrib.sessions.backends.file'
SESSION_FILE_PATH = '/tmp/django_sessions'  # 文件存储路径

15.消息框架 (Message Framework)

Django 自带了消息框架，用于在视图和模板间传递即时通知。消息存储的后端可以通过 MESSAGE_STORAGE 设置：

MESSAGE_STORAGE = 'django.contrib.messages.storage.session.SessionStorage'

默认情况下，消息存储在用户会话中，并在下一次页面渲染时显示。

16.第三方库的配置

对于 Django 项目中常用的第三方库（如 Celery、Django Allauth、DRF 等），你可能需要在 settings.py 中添加相应的配置。

例如，使用 Django-Celery 配置异步任务队列：

CELERY_BROKER_URL = 'redis://localhost:6379/0'  # 使用 Redis 作为消息代理
CELERY_RESULT_BACKEND = 'redis://localhost:6379/0'  # 保存任务的执行结果
CELERY_ACCEPT_CONTENT = ['json']
CELERY_TASK_SERIALIZER = 'json'

对于 Django-Allauth 的配置：

INSTALLED_APPS += [
    'allauth',
    'allauth.account',
    'allauth.socialaccount',
]

AUTHENTICATION_BACKENDS = [
    'django.contrib.auth.backends.ModelBackend',
    'allauth.account.auth_backends.AuthenticationBackend',
]

SITE_ID = 1
ACCOUNT_EMAIL_VERIFICATION = 'mandatory'
ACCOUNT_AUTHENTICATION_METHOD = 'email'
ACCOUNT_EMAIL_REQUIRED = True