Django配置優化方法

1、使用多個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端口使用模擬生產環境的配置，這樣子帶來的好處是咱們在開發的時候能夠同時兼顧多個環境下的狀態。

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

親愛的朋友，當你辛辛苦苦寫好了一個項目，並準備把它開源到github的時候，你必定不但願將你的數據庫鏈接方式也一同上傳上來。 但是配置文件又必須得上傳，這個時候咱們就須要用到Django-environ來管理咱們的私密信息。

安裝方式

使用pip安裝

pip install django-environ
複製代碼

官方文檔

1. django-environ.readthedocs.io/en/latest/#…
2. github.com/joke2k/djan…

使用方法

django-environ的使用十分簡單

1. 在項目下新建一個.env文件，內容就是數據庫鏈接等須要保密的字段，例如：

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文件裏，這樣才能保護到你的隱私

開源項目能夠添加一個.env.example

2. 在你的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:%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'}
   複製代碼

總結

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

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

在命令行能夠指定所使用的.env文件：

PROJECT_ENV=dev python manage.py 
複製代碼