介紹
Django是一個Web框架——一套用于幫助開發交互式網站的工具。Django能夠響應網頁請求,還能讓我們更輕松地讀寫數據庫、管理用戶等。本文主要介紹了關于利用Django-environ區分不同環境的相關內容,下面話不多說了,來一起看看詳細的介紹吧
就是一個讀取環境變量的東西
就2個類: Env/ Path.
基本用法
env.example文件
1
2
3
4
|
ALLOWED_HOSTS = www.example1.com,www.example2.com DEBUG = True DJANGO_LOG_LEVEL = 'INFO' |
ipython交互示例
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
|
>> 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來指定環境變量。
比如,之前是
1
|
python manage.py shell - - settings = mysite.settings.dev |
現在是
1
|
PROJECT_ENV = dev python manage.py shell |
之前是
1
|
python manage.py runserver - - settings = mysite.settings.dev |
現在是
1
|
PROJECT_ENV = dev python manage.py runserver |
當然,也可以export來指定這個環境變量,也可以修改shell配置文件來指定這個環境變量,甚至supervisord和uwsgi的配置文件也可以指定環境變量。
我們的settings.py里面是這樣根據PROJECT_ENV來讀取不同env文件的。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
|
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配置項的代碼都寫一遍
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
|
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')。
更多的可以查看官方文檔
總結
以上就是這篇文章的全部內容了,希望本文的內容對大家的學習或者工作具有一定的參考學習價值,如果有疑問大家可以留言交流,謝謝大家對服務器之家的支持。
原文鏈接:https://blog.csdn.net/handsomekang/article/details/78682575