Django入门 ----配置文件

1. 项目配置文件

• 一个Django项目完整的全局默认设置在django/conf/global_settings.py文件中。Django在编译时，会先载入global_settings.py中的全局默认配置值，然后加载用户指定的settings.py，重写部分全局默认设置
• settings.py已经包含了部分基本的默认设定，只需要修改和添加需要使用的设定即可

2. 配置项

1. BASE_DIR

BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))

• 默认值是Django项目文件夹所在目录得绝对路径，一般不要修改

2. DEBUG

• 默认值是True。在本地开发测试环境下设置DEBUG=True可以显示bug信息
• 生产环境时，请切记设置DEBUG=False
• 当设置DEBUG=False, 一定要设置ALLOWED_HOSTS选项, 否则会抛出异常

3. ALLOWED_HOSTS

• 默认值为空[]。设置ALLOWED_HOSTS是为了限定用户请求中的host值，以防止黑客构造包来进行头部攻击
• 当关闭DEBUG时，HOST一般为服务器公网IP或者注册域名
• 例：ALLOWED_HOSTS=[‘46.124.78.xx’, ‘www.bat.com’，’127.0.0.1’]

4. SECRET_KEY

• SECRET_KEY是Django根据自己算法生成的一大串随机数，本质是个加密盐，用于防止CSRF（Cross-site request forgery）跨站请求伪造攻击
• 不建议直接在settings.py里输入字符串用于生成随机数
• 建议以下方式读取SECRET_KEY

# 方法2: 从环境变量中读取SECRET_KEY
import os
SECRET_KEY = os.environ['SECRET_KEY']

# 方法2：从服务器上Django项目文件价外的某个文件读取
with open('/etc/secret_key.txt') as f:
    SECRET_KEY = f.read().strip()

5. INSTALLED_APPS

INSTALLED_APPS = [
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',
    'myapp',  # 自定义的APP
]

• 增删一个项目(Project)所包含的应用(APP)
• 只有在这里面的APP, Django才会生成相应的数据表

6. AUTH_USER_MODEL

• 默认为auth.user。也可以为自定义用户模型, 如users.user

7. STATIC_ROOT和STATIC_URL

STATIC_URL = '/static/'
STATIC_ROOT = os.path.join(BASE_DIR, 'static')

• 设置 STATIC_URL 后可以通过使用{% static ‘assets/imges/xxx.jpg’ %}方式直接访问 /static/ 文件夹里的静态文件
• 设置了STATIC_ROOT, 当你运行python manage.py collectstatic命令的时候，Django会将各app下所有名为static的文件夹及其子目录复制收集到STATIC_ROOT
• 把静态文件集中一起的目的是为了更方便地通过Apache或Nginx部署

8. STATICFILES_DIRS

STATICFILES_DIRS = [
"/home/user/pictures",
"/opt/webfiles/myfiles",
]

• 默认值为空
• 设置该选项后，python manage.py collectstatic命令会把static文件夹及静态文件目录STATICFILES_DIRS里的静态文件都复制到一份到STATIC_ROOT
  -填写 路径必需是绝对路径

9. MEDIA_ROOT和MEDIA_URL

MEDIA_URL = '/media/'
MEDIA_ROOT = os.path.join(BASE_DIR, 'media')

• media文件夹一般用于放置用户上传的文件
• 对于此文件夹权限，建议使用sudo chmod 755 media命令设置成755，而不要使用777（可读、可写、可执行)

10. 国际化(语言与时间)

USE_TZ = True # 默认值True。
TIME_ZONE = 'Asia/Shanghai' # 设置时区
USE_I18N = True # 默认为True，是否启用自动翻译系统
USE_L10N = True # 默认False，以本地化格式显示数字和时间

11. 邮箱服务配置

EMAIL_HOST = 'smtp.qq.com' # 发送者邮箱服务器
EMAIL_PORT = 25 # 端口
EMAIL_HOST_USER = ''        # 发送者用户名（邮箱地址）
EMAIL_HOST_PASSWORD = ''    # 发送者密码
EMAIL_USE_SSL = True
DEFAULT_FROM_EMAIL = 'xxx@qq.com'

12. 模板设置

TEMPLATES = [
    {
        'BACKEND': 'django.template.backends.django.DjangoTemplates',
        'DIRS': [os.path.join(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',
            ],
        },
    },
]

13. 中间件设置

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',
    'myapp.middleware.CustomMiddleware1', # 新增自定义中间件。
]

• 中间件的添加顺序很重要

14. 数据库设置

• 不建议（直接配置信息）

DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.mysql',   # 数据库引擎
        'NAME': 'mydb',         # 数据库名，Django不会帮你创建，需要自己进入数据库创建。
        'USER': 'myuser',       # 设置的数据库用户名
        'PASSWORD': 'mypass',   # 设置的密码
        'HOST': 'localhost',    # 本地主机或数据库服务器的ip
        'PORT': '3306',         # 数据库使用的端口
    }
}

• 建议（使用OPTIONS和配置文件my.cnf进行设置）

# settings.py
DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.mysql',
        'OPTIONS': {
            'read_default_file': '/path/to/my.cnf',
        },
    }
}

# my.cnf
[client]
database = mydb
user = myuser
password = mypass
default-character-set = utf8

15. 缓存设置

CACHES = {
    'default': {
        'BACKEND': 'django_redis.cache.RedisCache',
        'LOCATION': 'redis://your_host_ip:6379', # redis所在服务器或容器ip地址
        "OPTIONS": {
            "CLIENT_CLASS": "django_redis.client.DefaultClient",
             "PASSWORD": "your_pwd", # 你设置的密码
        },
    },
}

• 根据缓存介质的不同，你需要设置不同的缓存后台Backend
• 先安装redis和django_redis, 然后再修改settings.py中的缓存配置

16. Session相关设置

SESSION_ENGINE = 'django.contrib.sessions.backends.db'  # 引擎（默认）
SESSION_COOKIE_NAME = "sessionid"  # Session的cookie保存在浏览器上时的key，
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 = 60 * 30  # Session的cookie失效日期（30min）（默认）
SESSION_EXPIRE_AT_BROWSER_CLOSE = True  # 是否关闭浏览器使得Session过期（默认）
SESSION_SAVE_EVERY_REQUEST = True  # 是否每次请求都保存Session，默认修改之后才保存