在使用Django框架進(jìn)行項(xiàng)目開(kāi)發(fā)時(shí),我們會(huì)用到許多環(huán)境變量当编,為了方便環(huán)境變量的使用,我們選擇使用Django-environ庫(kù)來(lái)統(tǒng)一管理這些環(huán)境變量。下面簡(jiǎn)單介紹一下Django-environ的使用礁扮。
Django-environ的基本使用
安裝
pip install django-environ==0.4.5
環(huán)境變量配置
創(chuàng)建.env
文件,里面存放需要配置的環(huán)境變量
REDIS_HOST='127.0.0.1'
REDIS_PORT='6379'
REDIS_PASSWORD=''
REDIS_DB='1'
REDIS_MODE='single'
.env
配置注意事項(xiàng):
- 配置項(xiàng)中間不能有前后空格瞬沦,例如:
REDIS_HOST='127.0.0.1' - 配置文件中不支持中文
環(huán)境變量的使用
在settings.py
文件中配置
# 引入environ
import environ
# 項(xiàng)目路徑
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))
# 獲取環(huán)境變量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='')
如果項(xiàng)目中的其他文件需要使用環(huán)境變量
# 引入settings
from django.conf import settings
# 直接調(diào)用即可
settings.REDIS_HOST
至此Django-environ的使用方法已經(jīng)講完太伊。
區(qū)分不同環(huán)境
在實(shí)際的項(xiàng)目開(kāi)發(fā)中,我們需要區(qū)分不同環(huán)境逛钻,如開(kāi)發(fā)環(huán)境develop僚焦、生產(chǎn)環(huán)境prod、測(cè)試環(huán)境test
使用Django-environ配置環(huán)境變量時(shí)曙痘,我們需要?jiǎng)?chuàng)建不同環(huán)境的env文件: .env.prod
芳悲、.env.develop
、.env.test
屡江。
在使用時(shí)芭概,只需要一個(gè)額外的的環(huán)境變量來(lái)讀取不同環(huán)境的env文件即可。
假設(shè)我們這個(gè)環(huán)境變量叫APP_ENV:
代碼使用
# 讀取APP_ENV
env = environ.Env()
APP_ENV = env.str('APP_ENV', 'prod')
print(APP_ENV)
# 讀取相對(duì)應(yīng)的env文件
env_file = '.env.%s' % APP_ENV'
env = environ.Env()
env.read_env(env_file=os.path.join(PROJECT_ROOT, env_file))
這個(gè)環(huán)境變量APP_ENV沒(méi)法寫(xiě)在env文件中惩嘉,必須手動(dòng)指定罢洲。
指定方法
- 執(zhí)行命令時(shí)指定
之前
python manage.py runserver 0.0.0.0:8000
現(xiàn)在
APP_ENV=develop python manage.py runserver 0.0.0.0:8000
- 也可以使用supervisord來(lái)配置,然后通過(guò)os來(lái)獲取
ENVIRONMENT = os.environ.get('APP_ENV', 'develop')