​一、使用多個setting檔案

開發Django專案是最常見，也是最麻煩的一個問題就是如何區分開發配置與線上配置。有一些解決方案是利用配置檔案是py檔案這個特性，在配置裡面寫一些 if-else 來達到區分線上配置與開發配置的目的。但是當專案較為複雜的時候，這樣寫的可讀性十分差，而且可能產生一些條件判定的BUG。

​ 所以更加推薦的方法是使用多個配置檔案。

​ 例如新建一個Django專案的時候，預設結構如下：

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

新建一個 settings 的資料夾

裡面新建 base.py,dev.py,production.py 這三個檔案，並刪掉 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 裡面是開發環境下的配置，例如 DEBUG=True 、開發環境資料庫等

​ production.py 裡是生產環境下的配置，例如線上庫的連線等

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

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

​ 一般在python裡面不建議通過 * 來匯入，因為可能會引發變數名衝突等異常。但在這裡是個例外，因為 base.py

指定配置檔案

1. 命令列模式指定配置檔案

當使用多配置檔案並執行 python manage.py runserver 命令的時候，需要注意的是 Django 此時會報錯。

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 引擎找不到配置檔案。

因此在這裡需要手動指定配置檔案，只需要在執行命令後加上 --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指定配置檔案

如果你是使用的專業版的Pycharm，你一定是習慣直接使用Pycharm來啟動服務的方式。這裡我們也可以通過修改Pycharm的執行配置資訊來達到指定 settings 配置的目的：

1. 修改配置檔案裡 Environment variables 配置。新增或修改 DJANGO_SETTINGS_MODULE 引數為 ProjectName.settings.dev
2. 新增 production 環境下的配置檔案，然後重複第1步

使用多個配置環境帶來的另一個好處就是，我們還可以根據不同的埠號來使用不同的環境。例如我可以在 8000 埠使用開發環境的配置，在 8001 埠使用模擬生產環境的配置，這樣子帶來的好處是我們在開發的時候可以同時兼顧多個環境下的狀態。

二、使用本地檔案管理敏感配置資訊

親愛的朋友，當你辛辛苦苦寫好了一個專案，並準備把它開源到github的時候，你一定不希望將你的資料庫連線方式也一同上傳上來。 可是配置檔案又必須得上傳，這個時候我們就需要用到 Django-environ 來管理我們的私密資訊。

安裝方式

使用pip安裝

pip install django-environ

官方文件

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

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

使用方法

django-environ 的使用十分簡單

在專案下新建一個 .env 檔案，內容就是資料庫連線等需要保密的欄位，例如：

DEBUG=on
SECRET_KEY=your-secret-key
DATABASE_URL=psql://urser:[email protected]: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 檔案裡，這樣才能保護到你的隱私

開源專案可以新增一個 .env.example

在你的setting檔案裡使用它

# base.py
import environ

ROOT_DIR = environ.Path(__file__)-3 # 獲取.env檔案的路徑
#> environ.Path(__file__)獲取到的是base.py的 絕對路徑 
#> '/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() 函式是對 os.Path() 的一個補充，支援了 - 操作

django-environ 支援 bool 、 str 、 list 、 dict 、 int 等多種資料型別

db_url 會被轉換成 django 配置所需要的格式

# .env
DEV_MYSQL=mysql://user:%[email protected]: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'}

總結

本文介紹使用了多個配置檔案區分開發、生產環境，使用 django-environ 管理敏感配置資訊的方法。

根據個人習慣，也同樣可以使用多個 .env 配置+ 一個 setting.py 配置來實現區分開發、生產環境的目的。

在命令列可以指定所使用的 .env 檔案：

PROJECT_ENV=dev python manage.py 

以上就是本文的全部內容，希望對大家的學習有所幫助，也希望大家多多支援我們。