Django settings配置详解

1. 基础

DJANGO_SETTING_MODULE环境变量：让settings模块被包含到python可以找到的目录下，开发情况下不需要，我们通常会在当前文件夹运行，python可以搜索到。如果需要运行在其他服务器上，就必须指定DJANGO_SETTINGS_MODULE变量。

2. 默认设定

一个django的settings文件不需要我们手动去设置所有项目，因为系统已经默认设置好了。我们只需要修改我们使用的设

定就好了。默认的设置在django/conf/global_settings.py文件中。django在编译时，先载入global_settings.py中的配置，然后加载指定的settings文件，重写改变的设定。

好了，步入正文。

前面的随笔中我们经常会改setting配置也经常将一些配置混淆今天主要是将一些常见的配置做一个汇总。

setting配置汇总

DEBUG

Debug 是一个布尔值，控制DEBUG模式的开启或关闭，当设置为True时，Django会将所有的日子和错误信息都打印在窗口中。在生成环境中则必须设置为False,否者会导致信息泄露

ALLOWED_HOSTS

在本地开发，可以忽略。在生产环境中，DEBUG设置为False，必须将主机名/IP地址填入该列表中，以便让Django为该主机/IP提供服务

 INSTALLED_APPS （app路径）

INSTALLED_APPS = [  

'django.contrib.admin',           // 管理后台应用  

'django.contrib.auth',            // 用户身份认证 

 'django.contrib.contenttypes',    // 追踪ORM模型与应用的对应关系  

'django.contrib.sessions',        // session应用  

'django.contrib.messages',        // 消息应用  

'django.contrib.staticfiles',     // 管理站点静态文件  

'app1.apps.App1Config',   # 默认已有 如果没有只要添加app名称即可 例如： 'app1'  

# 新建的应用都要在这里添加 ]

MIDDLEWARE(中间件列表)

所谓中间件就是从用户请求到用户请求结束期间所做的操作，即用户的请求会次从上到下依次执行MIDDLEWARE中的配置，然后服务器响应用户的时候会再次从下至上依次执行，和Java的Filter很相像：

自己写的中间件，例如在项目中的md文件夹下md.py文件中的M1与M2两个中间件

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',
 'md.md.M1',
 'md.md.M2',
]

注意自己写的中间件，配置要写在系统中的后面

ROOT_URLCONF

指定项目的根URL patterns配置文件

ROOT_URLCONF = '项目名字.urls'

DATABASES(数据库配置)

DATABASES是一个字典，包含不同名称的数据库及其具体配置，必须始终有一个名称为default的数据库，默认使用SQLite数据库

如果使用django的默认sqlite3数据库则不需要改

DATABASES = {
 'default': {
 'ENGINE': 'django.db.backends.sqlite3',
 'NAME': os.path.join(BASE_DIR, 'db.sqlite3'),
 }
}

如果使用mysql数据库需要将上述数据库注掉修改如下

DATABASES = {
 'default': {  
 'ENGINE': 'django.db.backends.mysql',
 'NAME': 'blog', #你的数据库名称 数据库需要自己提前建好
 'USER': 'root', #你的数据库用户名
 'PASSWORD': '', #你的数据库密码
 'HOST': '', #你的数据库主机，留空默认为localhost
 'PORT': '3306', #你的数据库端口
 }
}

由于mysql默认引擎为MySQLdb，而mysqldb在python3支持不是很好，一般使用pymysql代替。在__init__.py文件中添加下面代码，__init__.py和setting.py 同一目录，

import pymysql
pymysql.install_as_MySQLdb()

在上面的代码中，ENGINE（yin）要说明一下，官方提供了针对不同数据库的的不同操作引擎，以下是经常用的几个：

sqlite数据库：'django.db.backends.sqlite3', 

postgreSQL数据库：'django.db.backends.postgresql_psycopg2',

mysql数据库：'django.db.backends.mysql'

oracle数据库：'django.db.backends.oracle'

LANGUAGE_CODE

站点默认的语言代码

LANGUAGE_CODE = 'zh-Hans' # 中文

USE_TZ时区设置和字符集设置

USE_TZ 代表是否启用时区支持，Django可以支持根据时区自动切换时间显示。如果通过startproject命令创建站点，该项默认被设置为True

TIME_ZONE = 'UTC' # 格林威治时间
TIME_ZONE = 'Asia/Shanghai'  # 北京时间

# 设置保存到数据库时间类型是否为UTC时间，如果不需要请设置为false,默认为true：
USE_TZ = True
# 设置字符集：
DEFAULT_CHARSET = "utf-8"

 设置打印日志到屏幕

LOGGING = {
    'version': 1,
    'disable_existing_loggers': False,
    'handlers': {
        'console':{
            'level':'DEBUG',
            'class':'logging.StreamHandler',
        },
    },
    'loggers': {
        'django.db.backends': {
            'handlers': ['console'],
            'propagate': True,
            'level':'DEBUG',
        },
    }
}

 

当你的操作与数据库相关时 会将我们的写的语句翻译成sql语句在屏幕上打印。

静态文件目录

# 所有静态文件放置目录，在配置nginx的时候，nginx的静态资源要指向这里。
STATIC_ROOT = os.path.join(BASE_DIR, 'static').replace('\\', '/')

# 别名，这个别名指的是在html引用的名称
STATIC_URL = '/static/' 

# 静态文件地址拼接，后面'static'文件为自己建立的存放静态文件（JS，IMG，CSS）的文件名
STATICFILES_DIRS=[
 os.path.join(BASE_DIR,"static"), #具体路径
]

在html使用如下：

{% block styles %}
<link rel="stylesheet" href="{% static '/plugins/bootstrapValidator/bootstrapValidator.min.css' %}">
{% endblock %}

如果数据库中的UserInfo(用户表)继承django内置AbstractUser

1）model需导入

from django.contrib.auth.models import AbstractUser

2）配置文件

AUTH_USER_MODEL = "应用名.UserInfo"

 session存储的相关配置（下面的配置会保存在数据库的django_session中）

1）数据库配置（默认）

Django默认支持Session，并且默认是将Session数据存储在数据库中，即：django_session 表中。
配置 settings.py
SESSION_ENGINE = 'django.contrib.sessions.backends.db' # 引擎（默认）
SESSION_COOKIE_NAME ＝ "sessionid"   # Session的cookie保存在浏览器上时的key，即：sessionid＝随机字符串（默认）
SESSION_COOKIE_PATH ＝ "/"    # Session的cookie保存的路径（默认）
SESSION_COOKIE_DOMAIN = None    # Session的cookie保存的域名（默认）
SESSION_COOKIE_SECURE = False    # 是否Https传输cookie（默认）
SESSION_COOKIE_HTTPONLY = True    # 是否Session的cookie只支持http传输（默认）
SESSION_COOKIE_AGE = 1209600    # Session的cookie失效日期（2周）（默认）
SESSION_EXPIRE_AT_BROWSER_CLOSE = False   # 是否关闭浏览器使得Session过期（默认）
SESSION_SAVE_EVERY_REQUEST = False   # 是否每次请求都保存Session，默认修改之后才保存（默认）

2）缓存配置

配置 settings.py
SESSION_ENGINE = 'django.contrib.sessions.backends.cache' # 引擎
SESSION_CACHE_ALIAS = 'default'    # 使用的缓存别名（默认内存缓存，也可以是memcache），此处别名依赖缓存的设置
SESSION_COOKIE_NAME ＝ "sessionid"   # Session的cookie保存在浏览器上时的key，即：sessionid＝随机字符串
SESSION_COOKIE_PATH ＝ "/"    # Session的cookie保存的路径
SESSION_COOKIE_DOMAIN = None    # Session的cookie保存的域名
SESSION_COOKIE_SECURE = False    # 是否Https传输cookie
SESSION_COOKIE_HTTPONLY = True    # 是否Session的cookie只支持http传输
SESSION_COOKIE_AGE = 1209600    # Session的cookie失效日期（2周）
SESSION_EXPIRE_AT_BROWSER_CLOSE = False   # 是否关闭浏览器使得Session过期
SESSION_SAVE_EVERY_REQUEST = False   # 是否每次请求都保存Session，默认修改之后才保存

3）默认配置

配置 settings.py
SESSION_ENGINE = 'django.contrib.sessions.backends.file' # 引擎
SESSION_FILE_PATH = None     # 缓存文件路径，如果为None，则使用tempfile模块获取一个临时地址tempfile.gettempdir() 
SESSION_COOKIE_NAME ＝ "sessionid"    # Session的cookie保存在浏览器上时的key，即：sessionid＝随机字符串
SESSION_COOKIE_PATH ＝ "/"     # Session的cookie保存的路径
SESSION_COOKIE_DOMAIN = None    # Session的cookie保存的域名
SESSION_COOKIE_SECURE = False    # 是否Https传输cookie
SESSION_COOKIE_HTTPONLY = True    # 是否Session的cookie只支持http传输
SESSION_COOKIE_AGE = 1209600    # Session的cookie失效日期（2周）
SESSION_EXPIRE_AT_BROWSER_CLOSE = False   # 是否关闭浏览器使得Session过期
SESSION_SAVE_EVERY_REQUEST = False    # 是否每次请求都保存Session，默认修改之后才保存

注意：

1）也可以自定义配置 但是自定义的配置都要写到配置文件最后 代码中使用时可以导入配置

from django.conf import settings
settings.配置名

2）上面所有配置都是针对特定问题需要修改的 系统默认配置不做说明

3）上面配置只是前面django系列随笔所遇到的常用配置 后续所遇配置都会逐步在此随笔中持续添加跟新

8. 语言

LANGUAGE_CODE = 'en-us'   # 默认
LANGUAGE_CODE = 'zh-hans' # 改为中文，主要针对admin页面和form报错提示

配置jinjia模版

TEMPLATE_DIRS = (
        os.path.join(BASE_DIR,'templates'),
    )

设置国际化

相同内容被不同时区地区的用户访问时，是否以不同格式内容展示(例如时间，日期，数字)：USE_L10N = True

USE_I18N = True

12. 部署配置

# 调试模式是否开启：
DEBUG = True

# 访问web服务的的Ip配置：
ALLOWED_HOSTS = ['*']

# 部署的时候请修改DEBUG和ALLOWED_HOSTS的值，一般将其修改为FALSE和指定ip，例如['127.0.0.1']

13. 在setting.py中定义全局变量，该变量的变量名需要全部大写，否则引用失败

ISTEXT = False

下面看段django settings最佳配置实例代码，具体代码如下所示：

# encoding=utf-8
import os
import socket

SITE_ID = 1
# 项目的根目录
# 简化后面的操作
PROJECT_ROOT = os.path.dirname(os.path.dirname(__file__))
# 加载应用
# 把应用添加到INSTALLED_APPS中
from apps.kuser.mysetting import myapp as kuser_app
from apps.blog.mysetting import myapp as blog_app

MY_APPS = blog_app + kuser_app
# 加载静态文件
from apps.blog.mysetting import my_staticfiles as blog_staticfiles
from apps.kuser.mysetting import my_staticfiles as kuser_staticfiles

MY_STATIC_DIRS = blog_staticfiles + kuser_staticfiles
# 加载模板文件
from apps.blog.mysetting import my_templates as blog_templates
from apps.kuser.mysetting import my_templates as kuser_templates

MY_TEMPLATE_DIRS = blog_templates + kuser_templates
# 密钥配置
# 适用于开发环境和部署环境
# 可以从系统环境中，配置文件中，和硬编码的配置中得到密钥
try:
    SECRET_KEY = os.environ['SECRET_KEY']
except:
    try:
        with open(os.path.join(PROJECT_ROOT, 'db/secret_key').replace('\\', '/')) as f:
            SECRET_KEY = f.read().strip()
    except:
        SECRET_KEY = '*lk^6@0l0(iulgar$j)faff&^(^u+qk3j73d18@&+ur^xuTxY'


# 得到主机名
def hostname():
    sys = os.name
    if sys == 'nt':
        hostname = os.getenv('computername')
        return hostname
    elif sys == 'posix':
        host = os.popen('echo $HOSTNAME')
        
    try:
        hostname = host.read()
        return hostname
    finally:
        host.close()
 
    

# 调试和模板调试配置
# 主机名相同则为开发环境，不同则为部署环境
# ALLOWED_HOSTS只在调试环境中才能为空
if socket.gethostname().lower() == hostname().lower():
    DEBUG = TEMPLATE_DEBUG = True
    ALLOWED_HOSTS = []
else:
    ALLOWED_HOSTS = [
        'baidu.com',
        '0.0.0.0',
    ]
    DEBUG = TEMPLATE_DEBUG = False
# 数据库配置
MYDB = {
    'mysql': {
        'ENGINE': 'django.db.backends.mysql',
        'NAME': 'books',  # 你的数据库名称
        'USER': 'root',  # 你的数据库用户名
        'PASSWORD': '',  # 你的数据库密码
        'HOST': '',  # 你的数据库主机，留空默认为localhost
        'PORT': '3306',  # 你的数据库端口
    },
    'sqlite': {
        'ENGINE': 'django.db.backends.sqlite3',
        'NAME': os.path.join(PROJECT_ROOT, 'db/db.sqlite3').replace('\\', '/'),
    }
}
# 给静态文件url一个后缀，在templates里用到的。
# 映射到静态文件的url
# STATIC_URL的含义与MEDIA_URL类似
STATIC_URL = '/static/'
# 总的static目录
# 可以使用命令 manage.py collectstatic 自动收集static文件
# STATIC_ROOT = os.path.join(PROJECT_ROOT, 'static').replace('\\', '/')
# 放各个app的static目录及公共的static目录
# STATICFILES_DIRS：和TEMPLATE_DIRS的含义差不多，就是除了各个app的static目录以外还需要管理的静态文件设置，
# 比如项目的公共文件差不多。然后给静态文件变量赋值，告诉Django，静态文件在哪里
# 另外，Django提供了一个findstatic命令来查找指定的静态文件所在的目录，例如：D:\TestDjango>python manage.py findstatic Chrome.jpg
# 默认情况下（如果没有修改STATICFILES_FINDERS的话），Django首先会在STATICFILES_DIRS配置的文件夹中寻找静态文件，然后再从每个app的static子目录下查找，
# 并且返回找到的第一个文件。所以我们可以将全局的静态文件放在STATICFILES_DIRS配置的目录中，将app独有的静态文件放在app的static子目录中。
# 存放的时候按类别存放在static目录的子目录下，如图片都放在images文件夹中，所有的CSS都放在css文件夹中，所有的js文件都放在js文件夹中。
STATICFILES_DIRS = (
    ("downloads", os.path.join(PROJECT_ROOT, 'static/downloads').replace('\\', '/')),
    ("uploads", os.path.join(PROJECT_ROOT, 'static/uploads').replace('\\', '/')),
)
# 将app中的静态文件添加到静态文件配置列表中
STATICFILES_DIRS += MY_STATIC_DIRS
# 最后关键的部分是STATICFILES_DIRS以下配置
# 简要说一下，static文件夹在项目里，有css js images 三个文件夹（看项目结构），他们的路径分别是：
# os.path.join(STATIC_ROOT,'css')，os.path.join(STATIC_ROOT,'js')，os.path.join(STATIC_ROOT,'images')；
# 我们分别给他们起三个别名css，js，images（你可以随意给，不过为了易记，我们原名称指定别名了）
TEMPLATE_DIRS = (
    os.path.join(PROJECT_ROOT, 'templates').replace('\\', '/'),
)
# 配置应用的模板文件路径
TEMPLATE_DIRS += MY_TEMPLATE_DIRS
# 配置缓存
CACHES = {
    'default': {
        'BACKEND': 'django.core.cache.backends.memcached.MemcachedCache',
        'LOCATION': 'unix:/tmp/memcached.sock',
        'KEY_PREFIX': 'lcfcn',
        'TIMEOUT': None
    }
}
LOGIN_REDIRECT_URL = '/'
LOGIN_URL = '/auth/login/'
LOGOUT_URL = '/auth/logout/'
# 指用户上传的文件，比如在Model里面的FileFIeld，ImageField上传的文件。如果你定义
# MEDIA_ROOT=c:\temp\media，那么File=models.FileField(upload_to="abc/")，上传的文件就会被保存到c:\temp\media\abc。MEDIA_ROOT必须是本地路径的绝对路径。
MEDIA_ROOT = os.path.join(PROJECT_ROOT, 'static/uploads')
# MEDIA_URL是指从浏览器访问时的地址前缀。
MEDIA_URL = '/uploads/'
# 应用注册列表
INSTALLED_APPS = (
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',
    'django.contrib.sites',
    'django.contrib.sitemaps',
)
# 为了不和系统应用混合，自己开发的应用放在这里
# 将自己写的app添加到应用列表中去
INSTALLED_APPS += MY_APPS
# django 中间件
# django处理一个Request的过程是首先通过django 中间件，然后再通过默认的URL方式进行的。
# 所以说我们要做的就是在django 中间件这个地方把所有Request拦截住，
# 用我们自己的方式完成处理以后直接返回Response,那么我们可以简化原来的设计思路，
# 把中间件不能处理的 Request统统不管，丢给Django去处理。
MIDDLEWARE_CLASSES = (
    'django.middleware.cache.UpdateCacheMiddleware',
    'django.contrib.sessions.middleware.SessionMiddleware',
    'django.middleware.common.CommonMiddleware',
    'django.middleware.csrf.CsrfViewMiddleware',
    'django.contrib.auth.middleware.AuthenticationMiddleware',
    # 'django.contrib.auth.middleware.SessionAuthenticationMiddleware',
    'django.contrib.messages.middleware.MessageMiddleware',
    'django.middleware.clickjacking.XFrameOptionsMiddleware',
    'django.middleware.cache.FetchFromCacheMiddleware',
)
ROOT_URLCONF = 'lcforum.urls'
WSGI_APPLICATION = 'lcforum.wsgi.application'
# 数据库配置
DATABASES = {
    'default': MYDB.get('sqlite'),
}
# 语言
LANGUAGE_CODE = 'zh-cn'
# 时区
TIME_ZONE = 'Asia/Shanghai'
USE_TZ = True
# 在template中使用静态文件
# 采用这种方式需要有一些额外配置，打开settings.py，确认TEMPLATE_CONTEXT_PROCESSORS中包含有'django.core.context_processors.static'
# TEMPLATE_CONTEXT_PROCESSORS = (
# 'django.core.context_processors.debug',
# 'django.core.context_processors.i18n',
# 'django.core.context_processors.media',
# 'django.core.context_processors.static',
# 'django.contrib.auth.context_processors.auth',
# 'django.contrib.messages.context_processors.messages',
#
# 'django.core.context_processors.tz',
# 'django.contrib.messages.context_processors.messages',
# # 'blog.context_processors.custom_proc',自定义函数
# )
# from django.conf import settings
# gettext = lambda s: s
# getattr()
# 假设有个工程djangodemo，有两个app为demo1跟demo2
# django处理static的方法是把各个app各自的static合并到一处
# 比如:
# djangodemo/djangodemo/static 放置公共静态文件
# djangodemo/demo1/static 放置该app自己的静态文件
# djangodemo/demo2/static 放置该app自己的静态文件
# 可以这么设置：
# STATIC_ROOT = '/www/djangodemo/djangodemo/static '
# STATIC_URL = '/static/'
# STATICFILES_DIRS = (
# 'djangodemo/static',
# 'demo1/static/',
# 'demo2/static/',
# )
# 使用命令
# manage.py collectstatic
# 就会自动把所有静态文件全部复制到STATIC_ROOT中
# 如果开启了admin，这一步是很必要的，不然部署到生产环境的时候会找不到样式文件
# 不要把你项目的静态文件放到这个目录。这个目录只有在运行manage.py collectstatic时才会用到