免责声明

本站所有资源、内容均为转载整合,仅供学习与研究使用

本站涉及的收费项目,仅为资源整理、收集及维护成本,并非软件或内容本身的费用

请在学习研究后自觉删除相关内容,请勿用于商业用途或非法传播,因未及时删除或违规使用所产生的一切法律责任与后果,由使用者自行承担。

如需用于其他用途,请购买正版授权,支持原作者

若本站内容侵犯了您的合法权益,请通过邮箱 admin@zx-shop.com.cn 联系站长,我们将在第一时间核实并处理删除,感谢您的理解与配合!

django的settings.py文件配置详解

你想了解 Django 中 settings.py 文件的相关知识,这个文件是 Django 项目的核心配置文件,所有重要的项目设置都集中在这里。

下面我会为你系统地讲解 settings.py 的核心内容、常用配置项,以及最佳实践,帮助你理解和正确配置它。


一、settings.py 核心结构与常用配置

1. 基础配置(必改项)

这些是创建项目后首先需要根据实际情况修改的配置:

# 项目根目录(Django 3.1+ 自动生成,无需手动改)
BASE_DIR = Path(__file__).resolve().parent.parent
​
# 安全密钥:生产环境必须保密,建议通过环境变量读取
# 生成方式:可以用 Django 内置工具生成,或在线随机字符串生成器
SECRET_KEY = 'django-insecure-xxxxxxxxx'  # 开发环境示例,生产环境要替换
​
# 调试模式:开发时设为 True,生产环境必须设为 False
DEBUG = True
​
# 允许访问的域名:DEBUG=False 时必须配置,否则无法访问
# 示例:允许 localhost、127.0.0.1 和你的域名
ALLOWED_HOSTS = ['localhost', '127.0.0.1', 'yourdomain.com']

2. 应用配置

INSTALLED_APPS 声明项目中启用的 Django 应用,包括内置应用和自定义应用:

INSTALLED_APPS = [
   # Django 内置应用(基础功能)
   'django.contrib.admin',          # 后台管理系统
   'django.contrib.auth',           # 用户认证系统
   'django.contrib.contenttypes',   # 内容类型框架
   'django.contrib.sessions',       # 会话管理
   'django.contrib.messages',       # 消息提示
   'django.contrib.staticfiles',    # 静态文件管理
​
   # 第三方应用(需先 pip 安装)
   # 示例:'rest_framework', 'django-cors-headers'
​
   # 自定义应用(自己创建的 app)
   # 示例:'myapp', 'blog', 'user'
]

3. 中间件配置

MIDDLEWARE 是请求/响应处理的中间件链,按顺序执行:

MIDDLEWARE = [
   'django.middleware.security.SecurityMiddleware',
   'django.contrib.sessions.middleware.SessionMiddleware',
   'django.middleware.common.CommonMiddleware',
   'django.middleware.csrf.CsrfViewMiddleware',  # CSRF 防护,表单必须加 {% csrf_token %}
   'django.contrib.auth.middleware.AuthenticationMiddleware',
   'django.contrib.messages.middleware.MessageMiddleware',
   'django.middleware.clickjacking.XFrameOptionsMiddleware',
]

4. 数据库配置

Django 默认使用 SQLite,生产环境常用 MySQL/PostgreSQL:

# 1. 默认 SQLite 配置(无需额外安装)
DATABASES = {
   'default': {
       'ENGINE': 'django.db.backends.sqlite3',
       'NAME': BASE_DIR / 'db.sqlite3',  # 数据库文件路径
  }
}
​
# 2. MySQL 配置(需先安装 mysqlclient 或 pymysql)
# DATABASES = {
#     'default': {
#         'ENGINE': 'django.db.backends.mysql',
#         'NAME': 'your_db_name',       # 数据库名
#         'USER': 'your_db_user',       # 数据库用户名
#         'PASSWORD': 'your_db_pwd',   # 数据库密码
#         'HOST': 'localhost',         # 数据库主机
#         'PORT': '3306',               # 数据库端口
#         'OPTIONS': {
#             'charset': 'utf8mb4',     # 支持 emoji 等特殊字符
#         },
#     }
# }

5. 静态文件与媒体文件配置

  • 静态文件(CSS/JS/图片):项目通用的静态资源

  • 媒体文件:用户上传的文件

# 静态文件配置
STATIC_URL = 'static/'  # 访问静态文件的 URL 前缀
STATIC_ROOT = BASE_DIR / 'staticfiles'  # 生产环境收集静态文件的目录(执行 collectstatic 后生成)
# 开发环境静态文件目录(可选)
STATICFILES_DIRS = [BASE_DIR / 'static']
​
# 媒体文件配置(用户上传)
MEDIA_URL = 'media/'  # 访问媒体文件的 URL 前缀
MEDIA_ROOT = BASE_DIR / 'media'  # 媒体文件存储的本地路径

6. 模板配置

TEMPLATES = [
  {
       'BACKEND': 'django.template.backends.django.DjangoTemplates',
       'DIRS': [BASE_DIR / 'templates'],  # 自定义模板目录
       'APP_DIRS': True,  # 是否自动查找各 app 下的 templates 目录
       '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',
          ],
      },
  },
]

7. 其他常用配置

# 根 URL 配置文件路径
ROOT_URLCONF = 'your_project_name.urls'
​
# WSGI 应用配置
WSGI_APPLICATION = 'your_project_name.wsgi.application'
​
# 语言和时区
LANGUAGE_CODE = 'zh-hans'  # 中文简体
TIME_ZONE = 'Asia/Shanghai'  # 中国时区
USE_I18N = True  # 国际化
USE_TZ = True  # 使用时区(建议设为 True)
​
# 默认主键字段类型
DEFAULT_AUTO_FIELD = 'django.db.models.BigAutoField'
​
# 登录/注销跳转 URL(认证相关)
LOGIN_URL = '/login/'  # 未登录访问需要认证的页面时跳转的 URL
LOGIN_REDIRECT_URL = '/'  # 登录成功后跳转的 URL
LOGOUT_REDIRECT_URL = '/'  # 注销后跳转的 URL

二、生产环境最佳实践

  1. 敏感信息不硬编码: 不要把 SECRET_KEY、数据库密码等写死在 settings.py,建议通过环境变量读取:

    import os
    from dotenv import load_dotenv  # 需要安装 python-dotenv
    ​
    # 加载 .env 文件(项目根目录创建 .env 文件,添加敏感配置)
    load_dotenv()
    ​
    SECRET_KEY = os.getenv('SECRET_KEY')
    DEBUG = os.getenv('DEBUG', 'False') == 'True'
    DATABASES['default']['PASSWORD'] = os.getenv('DB_PASSWORD')

    .env 文件示例(需添加到 .gitignore,避免提交到代码库):

    SECRET_KEY=your_secure_secret_key
    DEBUG=False
    DB_PASSWORD=your_db_pwd
  2. 分环境配置: 大型项目建议拆分配置(如 settings/dev.pysettings/prod.py),通过 DJANGO_SETTINGS_MODULE 指定使用的配置:

    # 开发环境
    export DJANGO_SETTINGS_MODULE=your_project.settings.dev
    # 生产环境
    export DJANGO_SETTINGS_MODULE=your_project.settings.prod
  3. 关闭 DEBUG 模式: 生产环境必须将 DEBUG = False,否则会暴露敏感信息(如数据库配置、代码报错信息)。


总结

  1. settings.py 是 Django 项目的核心配置文件,包含项目的所有关键设置(数据库、静态文件、应用、安全等)。

  2. 开发/生产环境配置要区分:开发环境 DEBUG=True,生产环境 DEBUG=False 且敏感信息通过环境变量读取。

  3. 核心必配项:SECRET_KEYDEBUGALLOWED_HOSTSDATABASES,生产环境需重点关注安全和性能配置。

请登录后发表评论

    没有回复内容