django-environ的使用及区分不同环境
在使用Django框架进行项目开发时,我们会用到许多环境变量,为了方便环境变量的使用,我们选择使用Django-environ库来统一管理这些环境变量。下面简单介绍一下Django-environ的使用。
Django-environ的基本使用
安装
pip install django-environ==0.4.5
环境变量配置
创建.env
文件,里面存放需要配置的环境变量
REDIS_HOST='127.0.0.1'
REDIS_PORT='6379'
REDIS_PASSWORD=''
REDIS_DB='1'
REDIS_MODE='single'
.env
配置注意事项:
- 配置项中间不能有前后空格,例如:
REDIS_HOST='127.0.0.1' - 配置文件中不支持中文
环境变量的使用
在settings.py
文件中配置
# 引入environ
import environ
# 项目路径
PROJECT_PATH = os.path.dirname(os.path.abspath(__file__))
PROJECT_ROOT, PROJECT_MODULE_NAME = os.path.split(PROJECT_PATH)
# 读取reading .env file
env_file = '.env'
env = environ.Env()
env.read_env(env_file=os.path.join(PROJECT_ROOT, env_file))
# 获取环境变量REDIS_HOST
REDIS_HOST = env('REDIS_HOST', default='127.0.0.1')
REDIS_PORT = env('REDIS_PORT', default='6379')
REDIS_PASSWORD = env('REDIS_PASSWORD', default='')
如果项目中的其他文件需要使用环境变量
# 引入settings
from django.conf import settings
# 直接调用即可
settings.REDIS_HOST
至此Django-environ的使用方法已经讲完。
区分不同环境
在实际的项目开发中,我们需要区分不同环境,如开发环境develop、生产环境prod、测试环境test
使用Django-environ配置环境变量时,我们需要创建不同环境的env文件: .env.prod
、.env.develop
、.env.test
。
在使用时,只需要一个额外的的环境变量来读取不同环境的env文件即可。
假设我们这个环境变量叫APP_ENV:
代码使用
# 读取APP_ENV
env = environ.Env()
APP_ENV = env.str('APP_ENV', 'prod')
print(APP_ENV)
# 读取相对应的env文件
env_file = '.env.%s' % APP_ENV'
env = environ.Env()
env.read_env(env_file=os.path.join(PROJECT_ROOT, env_file))
这个环境变量APP_ENV没法写在env文件中,必须手动指定。
指定方法
- 执行命令时指定
之前
python manage.py runserver 0.0.0.0:8000
现在
APP_ENV=develop python manage.py runserver 0.0.0.0:8000
- 也可以使用supervisord来配置,然后通过os来获取
ENVIRONMENT = os.environ.get('APP_ENV', 'develop')