利用Django-environ如何区分不同环境
介绍
django是一个web框架——一套用于帮助开发交互式网站的工具。django能够响应网页请求,还能让我们更轻松地读写数据库、管理用户等。本文主要介绍了关于利用django-environ区分不同环境的相关内容,下面话不多说了,来一起看看详细的介绍吧
就是一个读取环境变量的东西
就2个类: env/ path.
基本用法
env.example文件
allowed_hosts=www.example1.com,www.example2.com database_url='mysql://user:password@127.0.0.1:3306/dbname' debug=true django_log_level='info'
ipython交互示例
>> import environ >> env = environ.env() >> env.str('shell') # 读取环境变量shell '/bin/zsh' >> env.str('path') '这里显示的是环境变量path的内容' >> env.read_env('env.example') # 从文件读进来 >> env.str('django_log_level') 'info' >> env.bool('debug', false) # 可以设置默认值,如果获取不到,就取默认值 true >> env.list('allowed_hosts') ['www.example1.com', 'www.example2.com'] >> env.db_url('database_url') {'engine': 'django.db.backends.mysql', 'host': '127.0.0.1', 'name': 'dbname', 'password': '#password', 'port': 3306, 'user': 'user'} >> root_dir = environ.path('/home/mattkang/mysite/') # 还可以在settings.py中root_dir = environ.path(__file__) - 2 。而不用os.path.dirname(os.path.dirname(os.path.abspath(__file__)))这么麻烦的拼接。 >> root_dir('static') # 而不用os.path.join(root_dir, 'static') '/home/mattkang/mysite/static' >> apps_dir = root_dir.path('project')
在我们项目中的使用
只用一个settings.py,而不是多个比如settings/dev.py、settings/prod.py、settings/qa.py。
只需要一个额外的的环境变量来读取不同环境的env文件以区分不同环境。这个环境变量就没法写在env文件了,必须手动指定。假设我们这个环境变量叫project_env。
那么我们在命令行执行任何命令的时候,在前面加上project_env=xxx来指定环境变量。
比如,之前是
python manage.py shell --settings=mysite.settings.dev
现在是
project_env=dev python manage.py shell
之前是
python manage.py runserver --settings=mysite.settings.dev
现在是
project_env=dev python manage.py runserver
当然,也可以export来指定这个环境变量,也可以修改shell配置文件来指定这个环境变量,甚至supervisord和uwsgi的配置文件也可以指定环境变量。
我们的settings.py里面是这样根据project_env来读取不同env文件的。
env = environ.env() env.read_env('envs/env.%s' % env.str('project_env', 'prod')) # 在envs文件夹下有env.dev/ env.prod/ env.qa/ env.local文件 debug = env.bool('debug', false) secret_key = env.str('secret_key') logging = { 'version': 1, 'disable_existing_loggers': false, 'handlers': { 'console': { 'class': 'logging.streamhandler', }, }, 'loggers': { 'django': { 'handlers': ['console'], 'level': env.str('django_log_level', 'info'), }, }, } ......
好处:
1. 安全性。可以将敏感信息放环境变量,而不是代码里。分离开来。
2. 可读性。查看大部分配置的时候只需要看env文件就行了
3. 可维护性。减少代码,简洁清晰。可以只有一份settings.py,一目了然。
4. 灵活性。改配置只需要改环境变量就行了,而不需要改一行代码。
举个例子,如果不用环境变量,是多个settings文件的方式,那么虽然不同环境的logging配置项只有level不一样,却还是得把整个logging配置项的代码都写一遍
logging = { 'version': 1, 'disable_existing_loggers': false, 'handlers': { 'console': { 'class': 'logging.streamhandler', }, }, 'loggers': { 'django': { 'handlers': ['console'], 'level': 'xxx', # 虽然只有这里不一样,但是还是得所有环境的settings文件都写一遍这整个logging配置项. }, }, }
而使用环境变量的话,可以很精细的在不一样的地方动态根据环境变量设置。只需要在这一行'level': env.str(‘django_log_level', ‘info')。
更多的可以查看
总结
以上就是这篇文章的全部内容了,希望本文的内容对大家的学习或者工作具有一定的参考学习价值,如果有疑问大家可以留言交流,谢谢大家对的支持。