系列文章目录
前言
本文主要是对Django项目中settings文件的进一步介绍,其实就是说一说该文件里的现有配置是干啥的。
一、settings.py
settings.py
是Django项目的全局配置文件。项目创建初始时该文件内就已包含了部分配置信息,主要有密钥信息、应用注册、中间件注册、模板、数据库配置等等。
二、文件内容
这边就直接放整个文件内容了,具体的用途也有写在一旁。
from pathlib import Path
# 项目路径,就是项目根目录的路径,后面目录查找路径、静态文件查找路径,就可以基于BASE_DIR加上相对路径来确定
# Build paths inside the project like this: BASE_DIR / 'subdir'.
BASE_DIR = Path(__file__).resolve().parent.parent
# 密钥,随机值,项目创建时自动生成,用于重要数据(用户密码、CSRF机制和会话Session等)的加密处理,提高项目的安全性
# SECURITY WARNING: keep the secret key used in production secret!
SECRET_KEY = '4027kdo!9t6ajm^1u!9o%c&!0gco5=rn^mwshv=j-+-^uoghqv'
# 调试模式,开发调试阶段时应设置为True,会自动检测代码是否发生更改,根据检测结果执行是否刷新重启Server服务
# 若项目部署上线,应将其改为False,否则会泄露项目的相关信息
DEBUG = True
# 域名访问权限,设置可访问的域名,默认为空列表
# 当DEBUG为True,且ALLOWED_HOSTS为空列表时,项目只允许以localhost或127.0.0.1在浏览器上访问
# 当DEBUG为False时,ALLOWED_HOSTS为必填项,否则程序无法启动,若想允许所有域名访问,可设置['*']
ALLOWED_HOSTS = []
# Application definition
# App列表,新建应用时,需在该列表中添加应用名,以注册应用,如以下index应用
# contenttypes 记录项目中所有model元数据(Django的ORM框架)
INSTALLED_APPS = [
'django.contrib.admin',
'django.contrib.auth',
'django.contrib.contenttypes',
'django.contrib.sessions',
'django.contrib.messages',
'django.contrib.staticfiles',
'index',
]
# 中间件,一般不需要改动。列表中各个中间件是有先后顺序的,Request请求发往服务器会依次经过这些中间件
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',
]
# 项目路由,Django启动后会读取该值,获取到项目的urls.py文件,来生成整个项目的路由列表
ROOT_URLCONF = 'djProject.urls'
# 模板配置,后续将后端数据传递到前端模板时,需要配置DIRS,在列表中加上模板的目录即可
TEMPLATES = [
{
'BACKEND': 'django.template.backends.django.DjangoTemplates',
'DIRS': [],
'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',
],
},
},
]
# WSGI_APPLICATION WSGI应用接口,一般保持不动
WSGI_APPLICATION = 'djProject.wsgi.application'
# 数据库配置,默认是sqlite,以下内容已修改为MySQL数据库的配置
DATABASES = {
#'default': {
# 'ENGINE': 'django.db.backends.sqlite3',
# 'NAME': BASE_DIR / 'db.sqlite3',
#}
'default': {
'ENGINE': 'django.db.backends.mysql',
'NAME': 'dj_db',
'USER': 'root',
'PASSWORD': '123456',
'HOST': '127.0.0.1',
'PORT': '3306',
}
}
# Password validation
# 认证密码验证,一般不需要修改
AUTH_PASSWORD_VALIDATORS = [
{
'NAME': 'django.contrib.auth.password_validation.UserAttributeSimilarityValidator',
},
{
'NAME': 'django.contrib.auth.password_validation.MinimumLengthValidator',
},
{
'NAME': 'django.contrib.auth.password_validation.CommonPasswordValidator',
},
{
'NAME': 'django.contrib.auth.password_validation.NumericPasswordValidator',
},
]
# Internationalization
# 可配置为zh-hans,中文,其他项一般保持不动
LANGUAGE_CODE = 'en-us'
TIME_ZONE = 'UTC'
USE_I18N = True
USE_L10N = True
USE_TZ = True
# Static files (CSS, JavaScript, Images)
# 设置静态资源的路由地址(通过浏览器访问时)
# 默认(调试模式下)只能识别项目应用中的static文件夹里的静态资源,静态资源路由配置将在后面博文中继续介绍
STATIC_URL = '/static/'
# Default primary key field type
# https://docs.djangoproject.com/en/3.2/ref/settings/#default-auto-field
# 模型中主键默认类型为BigAutoField,一般保持不动
DEFAULT_AUTO_FIELD = 'django.db.models.BigAutoField'
总结
在项目初建时,一般先要对settings中的几个配置信息做改动,其中包括了注册应用、模板目录、数据库、语言等。在配置完基本的项目配置后,再继续进行后续的项目开发与测试。