​一、使用多個(gè)setting文件

 開發(fā)Django項(xiàng)目是最常見，也是最麻煩的一個(gè)問題就是如何區(qū)分開發(fā)配置與線上配置。有一些解決方案是利用配置文件是py文件這個(gè)特性，在配置里面寫一些 if-else 來達(dá)到區(qū)分線上配置與開發(fā)配置的目的。但是當(dāng)項(xiàng)目較為復(fù)雜的時(shí)候，這樣寫的可讀性十分差，而且可能產(chǎn)生一些條件判定的BUG。

​ 所以更加推薦的方法是使用多個(gè)配置文件。

​ 例如新建一個(gè)Django項(xiàng)目的時(shí)候，默認(rèn)結(jié)構(gòu)如下：

myDemoSite
├── manage.py
└── myDemoSite
 ├── __init__.py
 ├── settings.py
 ├── urls.py
 └── wsgi.py

新建一個(gè) settings 的文件夾

里面新建 base.py , dev.py , production.py 這三個(gè)文件，并刪掉 settings.py 文件。

myDemoSite
├── manage.py
└── myDemoSite
 ├── __init__.py
 ├── settings						<- add
 │   ├── __init__.py			<- add
 │   ├── base.py					<- add
 │   ├── dev.py					<- add
 │   └── production.py		<- add
 ├── urls.py
 └── wsgi.py

​ base.py 里面是公用的配置，例如 SECRET_KEY 、 INSTALLED_APPS 等

​ dev.py 里面是開發(fā)環(huán)境下的配置，例如 DEBUG=True 、開發(fā)環(huán)境數(shù)據(jù)庫等

​ production.py 里是生產(chǎn)環(huán)境下的配置，例如線上庫的連接等

分別在 dev.py 、 production.py 里引入 base.py

# dev.py 和 production.py
from myDemoSite.settings.base import *

​ 一般在python里面不建議通過 * 來導(dǎo)入，因?yàn)榭赡軙?huì)引發(fā)變量名沖突等異常。但在這里是個(gè)例外，因?yàn)?base.py 里面是我們的公共配置變量，通過變量名的方法導(dǎo)入的話，代碼也會(huì)很難看，而且麻煩。

指定配置文件

1. 命令行模式指定配置文件

當(dāng)使用多配置文件并運(yùn)行 python manage.py runserver 命令的時(shí)候，需要注意的是 Django 此時(shí)會(huì)報(bào)錯(cuò)。

Traceback (most recent call last):
 File "manage.py", line 21, in <module>
 main()
 File "manage.py", line 17, in main
 execute_from_command_line(sys.argv)
……

 File "/python3.7/site-packages/django/conf/__init__.py", line 176, in __init__
 raise ImproperlyConfigured("The SECRET_KEY setting must not be empty.")
django.core.exceptions.ImproperlyConfigured: The SECRET_KEY setting must not be empty.

原因在于我們將 settings.py 文件給刪掉了， Django 引擎找不到配置文件。

因此在這里需要手動(dòng)指定配置文件，只需要在運(yùn)行命令后加上 --setting 即可: python manage.py runserver --settings=myDemoSite.settings.dev

$> python manage.py runserver --settings=myDemoSite.settings.dev
Watching for file changes with StatReloader
Performing system checks...

System check identified no issues (0 silenced).

You have 17 unapplied migration(s). Your project may not work properly until you apply the migrations for app(s): admin, auth, contenttypes, sessions.
Run 'python manage.py migrate' to apply them.

Django version 2.2.7, using settings 'myDemoSite.settings.dev'
Starting development server at http://127.0.0.1:8000/
Quit the server with CONTROL-C.

2. Pycharm指定配置文件

如果你是使用的專業(yè)版的Pycharm，你一定是習(xí)慣直接使用Pycharm來啟動(dòng)服務(wù)的方式。這里我們也可以通過修改Pycharm的運(yùn)行配置信息來達(dá)到指定 settings 配置的目的：

1. 修改配置文件里 Environment variables 配置。添加或修改 DJANGO_SETTINGS_MODULE 參數(shù)為 ProjectName.settings.dev
2. 添加 production 環(huán)境下的配置文件，然后重復(fù)第1步

使用多個(gè)配置環(huán)境帶來的另一個(gè)好處就是，我們還可以根據(jù)不同的端口號(hào)來使用不同的環(huán)境。例如我可以在 8000 端口使用開發(fā)環(huán)境的配置，在 8001 端口使用模擬生產(chǎn)環(huán)境的配置，這樣子帶來的好處是我們?cè)陂_發(fā)的時(shí)候可以同時(shí)兼顧多個(gè)環(huán)境下的狀態(tài)。

二、使用本地文件管理敏感配置信息

親愛的朋友，當(dāng)你辛辛苦苦寫好了一個(gè)項(xiàng)目，并準(zhǔn)備把它開源到github的時(shí)候，你一定不希望將你的數(shù)據(jù)庫連接方式也一同上傳上來。 可是配置文件又必須得上傳，這個(gè)時(shí)候我們就需要用到 Django-environ 來管理我們的私密信息。

安裝方式

使用pip安裝

pip install django-environ

官方文檔

https://django-environ.readthedocs.io/en/latest/#django-environ

https://github.com/joke2k/django-environ

使用方法

django-environ 的使用十分簡單

在項(xiàng)目下新建一個(gè) .env 文件，內(nèi)容就是數(shù)據(jù)庫連接等需要保密的字段，例如：

DEBUG=on
SECRET_KEY=your-secret-key
DATABASE_URL=psql://urser:un-githubbedpassword@127.0.0.1:8458/database
SQLITE_URL=sqlite:///my-local-sqlite.db
CACHE_URL=memcache://127.0.0.1:11211,127.0.0.1:11212,127.0.0.1:11213
REDIS_URL=rediscache://127.0.0.1:6379/1?client_class=django_redis.client.DefaultClient&password=ungithubbed-secret 

注意：

.env 文件需要添加到你的 .gitignore 文件里，這樣才能保護(hù)到你的隱私

開源項(xiàng)目可以添加一個(gè) .env.example

在你的setting文件里使用它

# base.py
import environ

ROOT_DIR = environ.Path(__file__)-3 # 獲取.env文件的路徑
#> environ.Path(__file__)獲取到的是base.py的 絕對(duì)路徑 
#> '/demoProjects/myDemoSite/myDemoSite/settings/base.py'
#> environ.Path(__file__)-3 切換到前三層目錄
#> '/demoProjects/myDemoSite'

env = environ.Env()
env.read_env(ROOT_DIR.path('.env').root)

DEBUG = env.bool('DEBUG')
# DEBUG = True

# dev.py
from myDemoSite.settings.base import *

DEBUG = env.bool('DEBUG')
# DEBUG = True

environ.Path() 函數(shù)是對(duì) os.Path() 的一個(gè)補(bǔ)充，支持了 - 操作

django-environ 支持 bool 、 str 、 list 、 dict 、 int 等多種數(shù)據(jù)類型

db_url 會(huì)被轉(zhuǎn)換成 django 配置所需要的格式

# .env
DEV_MYSQL=mysql://user:%23password@127.0.0.1:3306/dbname
  
# dev.py
> env.db_url('DEV_MYSQL')
> <class 'dict'>: {'NAME': 'dbname', 'USER': 'user', 'PASSWORD': '#password', 'HOST': '127.0.0.1', 'PORT': 3306, 'ENGINE': 'django.db.backends.mysql'}

總結(jié)

本文介紹使用了多個(gè)配置文件區(qū)分開發(fā)、生產(chǎn)環(huán)境，使用 django-environ 管理敏感配置信息的方法。

根據(jù)個(gè)人習(xí)慣，也同樣可以使用多個(gè) .env 配置+ 一個(gè) setting.py 配置來實(shí)現(xiàn)區(qū)分開發(fā)、生產(chǎn)環(huán)境的目的。

在命令行可以指定所使用的 .env 文件：

PROJECT_ENV=dev python manage.py 

以上就是本文的全部內(nèi)容，希望對(duì)大家的學(xué)習(xí)有所幫助，也希望大家多多支持腳本之家。

最新評(píng)論