13 上線

上一章中,你為你的項目創建了RESTful API。在本章中,你會學習以下知識點:

  • 配置一個生產環境
  • 創建一個自定義的中間件
  • 實現自定義的管理命令

13.1 在生產環境上線

是時候把你的Django項目部署到生產環境了。我們將按以下步驟上線我們的項目:

  1. 為生產環境配置項目設置。
  2. 使用PostgreSQL數據庫。
  3. 使用uWSGINgnix設置一個web服務器。
  4. 為靜態資源提供服務。
  5. 用SSL保護我們的網站。

13.1.1 為多個環境管理設置

在實際項目中,你可能需要處理多個環境。你最少會有一個本地環境和一個生產環境,但是很可能還有別的環境。有些項目設置是所有環境通用的,有些可能需要被每個環境覆蓋。讓我們為多個環境配置項目設置,同時保持項目的良好組織。

educa項目目錄中創建settings/目錄。把項目的settings.py文件移動到settings/目錄中,並重命名為base.py,然後在新目錄中創建以下文件結構:

settings/
    __init__.py
    base.py
    local.py
    pro.py

這些文件分別是:

  • base.py:包括通用和默認設置的基礎設置文件
  • local.py:你本地環境的自定義設置
  • pro.py:生產環境的自定義設置

編輯settings/base.py文件,找到這一行代碼:

BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))

替換為下面這一行代碼:

BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(os.path.join(__file__, os.pardir))))

我們已經把設置文件移動到了低一級的目錄中,所以我們需要BASE_DIR正確的指向父目錄。我們使用os.pardir指向父目錄。

編輯settings/local.py文件,並添加以下代碼:

from .base import *

DEBUG = True

DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.sqlite3',
        'NAME': os.path.join(BASE_DIR, 'db.sqlite3'),
    }
}

這是我們本地環境的設置文件。我們導入base.py文件中定義的所有設置,只為這個生產環境定義特定設置。我們從base.py文件中拷貝了DEBUGDATABASES設置,因為每個環境會設置這些選項。你可以從base.py文件中移除DEBUGDATABASES設置。

編輯settings/pro.py文件,並添加以下代碼:

from .base import *

DEBUG = False

ADMINS = {
    ('Antonio M', '[email protected]'),
}

ALLOWED_HOSTS = ['educaproject.com', 'www.educaproject.com']

DATABASES = {
    'default': {

    }
}

這些是生產環境的設置。它們分別是:

  • DEBUG:設置DEBUGFalse對任何生產環境都是強制的。不這麼做會導致追蹤信息和敏感的配置數據暴露給每一個人。
  • ADMINS:當DEBUGFalse,並且一個視圖拋出異常時,所有信息會通過郵件發送給ADMINS設置中列出的所有人。確保用你自己的信息替換上面的name/e-mail元組。
  • ALLOWED_HOST:因為DEBUGFalse,Django只允許這個列表中列出的主機為應用提供服務。這是一個安全措施。我們包括了educaproject.comwww.educaproject.com域名,我們的網站會使用這兩個域名。
  • DATABASES:我們保留這個設置為空。我們將在下面討論生產環境的數據庫設置。

處理多個環境時,創建一個基礎的設置文件,併為每個環境創建一個設置文件。環境設置文件應用從通用設置繼承,並覆寫環境特定設置。

我們已經把項目設置從默認的settings.py文件放到了不同位置。除非你指定使用的設置模塊,否則不能用manage.py工具執行任何命令。在終端執行管理命令時,你需要添加--settings標記,或者設置DJANGO_SETTINGS_MODULE環境變量。打開終端執行以下命令:

export DJANGO_SETTINGS_MODULE=educa.settings.pro

這會為當前終端會話是設置DJANGO_SETTINGS_MODULE環境變量。如果你不想為每個新終端都執行這個命令,可以在.bashrc.bash_profile文件中,把這個命令添加到你的終端配置。如果你不想設置這個變量,則必須使用--settings標記運行管理命令,比如:

python manage.py migrate --settings=educa.settings.pro

現在你已經成功的為多個環境組織好了設置。

13.1.2 安裝PostgreSQL

在本書中,我們一直使用SQLite數據庫。它的設置簡單快捷,但對於生產環境,你需要一個更強大的數據庫,比如PostgreSQL,MySQL或者Oracle。我們將在生產環境使用PostgreSQL。因為PostgreSQL提供的特性和性能,所以它是Django的推薦數據庫。Django還自帶django.contrib.postgres包,允許你利用PostgreSQL的特定特性。你可以在這裏閱讀更多關於這個模塊的信息。

如果你正在使用Linux,使用以下命令安裝PostgreSQL的依賴:

sudo apt-get install libpq-dev python-dev

然後使用以下命令安裝PostgreSQL:

sudo apt-get install postgresql postgresql-contrib

如果你正在使用Mac OS X或者Windows,你可以在這裏下載PostgreSQL。

讓我們創建一個PostgreSQL用戶。打開終端,並執行以下命令:

su postgres
createuser -dP educa

會提示你輸入密碼和給予這個用戶的權限。輸入密碼和權限,然後使用以下命令創建一個新的數據庫:

createdb -E utf8 -U educa educa

然後編輯settings/pro.py文件,並修改DATABASES設置:

DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.postgresql_psycopg2',
        'NAME': 'educa',
        'USER': 'educa',
        'PASSWORD': '****',
    }
}

用你創建的數據庫名和用戶憑證替換上面的數據。現在新數據庫是空的。執行以下命令應用所有數據庫遷移:

python manage.py migrate

最後使用以下命令創建一個超級用戶:

python manage.py createsuperuser

13.1.3 檢查你的項目

Django包括check命令,可以在任何時候檢查你的項目。這個命令檢查Django項目中安裝的應用,並輸出所有錯誤或警告。如果你包括了--deploy選項,則只會觸發生成環境相關的額外檢查。打開終端,運行以下命令執行一次檢查:

python manage.py check --deploy

你會看到沒有錯誤,但是有幾個警告的輸出。這意味着檢查成功了,但你應該查看警告,看看是否可以做一些工作,讓你的項目在生產環境上是安全的。我們不會深入其中,你需要記住,在生產環境中使用之前,你應該檢查項目所有相關的問題。

13.2 通過WSGI為Django提供服務

Django的主要部署平台是WSGI。WSGI是Web Server Gateway Interface的縮寫,它是在網絡上為Python應用提供服務的標準。

當你使用startproject命令創建一個新項目時,Django會在項目目錄中創建一個wsgi.py文件。這個文件包含一個WSGI應用的可調用對象,它是你應用的訪問點。使用Django開發服務器運行你的項目,以及在生產環境中用你選擇的服務器部署應用都會使用WSGI。

你可以在這裏進一步學習WSGI。

13.2.1 安裝uWSGI

在這本書中,你一直使用Django開發服務器在本地環境運行項目。但是你需要一個實際的Web服務器在生產環境部署你的應用。

uWSGI是一個非常快速的Python應用服務器。它使用WSGI規範與你的Python應用通信。uWSGI把Web請求轉換為Django項目可用處理的格式。

使用以下命令安裝uWSGI

pip install uwsgi

如果你正在使用Mac OS X,你可以使用brew install uwsgi命令安裝uWSGI。如果你想在Windows上安裝uWSGI,則需要Cygwin。但是推薦你在基於Unix的環境中使用uWSGI

13.2.2 配置uWSGI

你可以從命令行中啟動uWSGI。打開終端,在educa項目目錄中執行以下命令:

uwsgi --module=educa.wsgi:application \
--env=DJANGO_SETTINGS_MODULE=educa.settings.pro \
--http=127.0.0.1:80 \
--uid=1000 \
--virtualenv=/home/zenx/env/educa/

如果你沒有權限,則需要在命令前加上sudo

通過這個命令,我們用以下選項在本地運行uWSGI

  • 我們使用educa.wsgi:application作為WSGI的可調用對象。
  • 我們為生產環境加載設置。
  • 我們使用我們的虛擬環境。用你的實際虛擬環境目錄替換virtualenv選項的路徑。如果你沒有使用虛擬環境,則跳過這個選項。

如果你沒有在項目目錄下運行命令,則需要用你的項目目錄包括--chdir=/path/to/educa/選項。

在瀏覽器中打開http://127.0.0.1:80/。你會看到沒有加載CSS或者圖片的HTML。這是有道理的,因為我們還沒有配置uWSGI為靜態文件提供服務。

uWSGI允許你在.ini文件中定義自定義配置。它比在命令行中傳遞選項更方便。在主educa/目錄下創建以下文件結構:

config/
    uwsgi.ini

編輯uwsgi.ini文件,添加以下代碼:

[uwsgi]
# variables
projectname = educa
base = /home/zenx/educa

# configuration
master = true
virtualenv = /home/zenx/env/%(projectname)
pythonpath = %(base)
chdir = %(base)
env = DJANGO_SETTINGS_MODULE=%(projectname).settings.pro
module = educa.wsgi:application
socket = /tmp/%(projectname).sock

我們定義了以下變量:

  • projectname:你的Django項目名稱,這裡是educa
  • baseeduca項目的絕對路徑。用你的絕對路徑替換它。

還有一些會在uWSGI選項中使用的自定義變量。你可以定義任意變量,只要它跟uWSGI選項名不同就行。我們設置了以下選項:

  • master:啟用主進程。
  • virtualenv:你的虛擬環境路徑。用響應的路徑替換它。
  • pythonpath:添加到Python路徑的路徑。
  • chdir:項目目錄的路徑,加載應用之前,uWSGI改變到這個目錄。
  • env:環境變量。我們包括了DJANGO_SETTINGS_MODULE變量,指向生產環境的設置。
  • module:使用的WSGI模塊。我們把它設置為application可調用對象,它包含在項目的wsgi模塊中。
  • socket:綁定到服務器的UNIX/TCP套接字。

socket選項用於與第三方路由(比如Nginx)通信,而http選項用於uWGSI接收傳入的HTTP請求,並自己進行路由。因為我們將配置Nginx作為Web服務器,並通過套接字與uWSGI通信,所以我們將使用套接字運行uWSGI

你可以在這裏找到所有可用的uWSGI選項列表。

現在你可以使用自定義配置運行uWSGI

uwsgi --ini config/uwsgi.ini

因為uWSGI通過套接字運行,所以你現在不能在瀏覽器中訪問uWSGI實例。讓我們完成生產環境。

13.2.3 安裝Nginx

當你為一個網站提供服務時,你必須為動態內容提供服務,同時還需要為靜態文件,比如CSS,JavaScript文件和圖片提供服務。雖然uWSGI可以為靜態文件提供服務,但它會在HTTP請求上增加不必要的開銷。因此,推薦在uWSGI之前設置一個Web服務器(比如Nginx),為靜態文件提供服務。

Nginx是一個專註於高併發,高性能和低內存使用的Web服務器。Nginx還可以充當反向代理,接收HTTP請求,並把它們路由到不同的後台。通常情況下,你會在前端使用一個Web服務器(比如Nginx),高效快速的為靜態文件提供服務,並且把動態請求轉發到uWSGI的工作線程。通過使用Nginx,你還可以應用規則,並從它的反向代理功能中獲益。

使用以下命令安裝Nginx:

sudo apt-get install nginx

如果你正在使用Mac OS X,你可以使用brew install nginx命令安裝Nginx。你可以在這裏找到Windows的二進製版本。

13.2.4 生產環境

下圖展示了我們最終的生產環境:


當客戶端瀏覽器發起一個HTTP請求時,會發生以下事情:

  1. Nginx接收HTTP請求。
  2. 如果請求的是靜態文件,則Nginx直接為靜態文件提供服務。如果請求的是動態頁面,則Nginx通過套接字把請求轉發給uWSGI
  3. uWSGI把請求傳遞給Django處理。返回的HTTP響應傳遞迴Nginx,然後再返回到客戶端瀏覽器。

13.2.5 配置Nginx

config/目錄中創建nginx.conf文件,並添加以下代碼:

# the upstream component nginx needs to connect to
upstream educa {
    server unix:///tmp/educa.sock;
}

server {
    listen 80;
    server_name www.educaproject.com educaproject.com;

    location / {
        include /etc/nginx/uwsgi_params;
        uwsgi_pass educa;
    }
}

這是Nginx的基礎配置。我們設置了一個名為educa的上游(upstream),指向uWSGI創建的套接字。我們使用server指令,並添加以下配置:

  1. 我們告訴Nginx監聽80端口。
  2. 我們設置服務名為www.educaproject.comeducaproject.com。Nginx會為來自這兩個域名的請求服務。
  3. 最後,我們指定/路徑下的所有請求都路由到educa套接字(uWSGI)。我們還包括了Nginx自帶的默認uWSGI配置參數。

你可以在這裏閱讀Nginx文檔。主要的Nginx配置文件位於/etc/nginx/nginx.conf。它包括了/etc/nginx/sites-enabled/下找到的所有配置文件。要讓Nginx加載你的自定義配置文件,需要如下創建一個符號鏈接:

sudo ln -s /home/zenx/educa/config/nginx.conf /etc/nginx/sites-enabled/educa.conf

用你項目的絕對路徑替換/home/zenx/educa/。然後打開終端啟動uWSGI

uwsgi --ini config/uwsgi.ini

打開第二個終端,用以下命令啟動Nginx:

service nginx start

因為我們正在使用簡單的主機名,所以需要把它重定向到本機。編輯你的/etc/hosts文件,添加下面兩行:

127.0.0.1 educaproject.com
127.0.0.1 www.educaproject.com

這樣,我們把兩個主機名路由到我們的本地服務器。在生產環境中你不需要這麼用,因為你會在域名的DNS配置中把主機名指向你的服務器。

在瀏覽器中打開http://educaproject.com。你可以看到你的網站,仍然沒有加載任何靜態資源。我們的生產環境馬上就好了。

13.2.6 為靜態資源和多媒體資源提供服務

為了最好的性能,我們將直接使用Nginx為靜態資源提供服務。

編輯settings/base.py文件,並添加以下代碼:

STATIC_URL = '/static/'
STATIC_ROOT = os.path.join(BASE_DIR, 'static/')

我們需要用Django導出靜態資源。collectstatic命令從所有應用中拷貝靜態文件,並把它們存儲到STATIC_ROOT目錄中。打開終端執行以下命令:

python manage.py collectstatic

你會看到以下輸出:

You have requested to collect static files at the destination location as specified in your settings:

    /educa/static

This will overwrite existing files!
Are you sure you want to do this?

輸入yes讓Django拷貝這些文件。你會看到以下輸出:

78 static files copied to /educa/static

現在編輯config/nginx.conf文件,並在server指令中添加以下代碼:

location /static/ {
    alias /home/zenx/educa/static/;
}
location /media/ {
    alias /home/zenx/educa/media/;
}

記得把/home/zenx/educa/路徑替換為你項目目錄的絕對路徑。這些指令告訴Nginx,直接在/static//media/路徑下為靜態資源提供服務。

使用以下命令重新加載Nginx的配置:

server nginx reload

在瀏覽器中打開http://educaproject.com/。現在你可以看到靜態文件了。我們成功的配置了Nginx來提供靜態文件。

13.3 使用SSL保護鏈接

SSL協議(Secure Sockets Layer)通過安全連接成為了為網站提供服務的標準。強烈鼓勵你在HTTPS下為網站提供服務。我們將在Nginx中配置一個SSL證書,安全的為我們網站提供服務。

13.3.1 創建SSL證書

educa項目目錄中創建ssl目錄。然後使用以下命令生成一個SSL證書:

sudo openssl req -x509 -nodes -days 365 -newkey rsa:2048 -keyout ssl/educa.key -out ssl/educa.crt

我們生成一個私有key和一個有效期是1年的2048個字節的證書。你將被要求輸入以下信息:

Country Name (2 letter code) [AU]:
State or Province Name (full name) [Some-State]:
Locality Name (eg, city) []: Madrid
Organization Name (eg, company) [Internet Widgits Pty Ltd]: Zenx IT
Organizational Unit Name (eg, section) []:
Common Name (e.g. server FQDN or YOUR name) []: educaproject.com
Email Address []: [email protected]

你可以用自己的信息填寫要求的數據。最重要的字段是Common Name。你必須制定證書的域名。我們將使用educaproject.com

這會在ssl/目錄中生成educa.key的私有key和實際證書educa.crt文件。

13.3.2 配置Nginx使用SSL

編輯nginx.conf文件,並修改server指令,讓它包括以下SSL指令:

server {
    listen 80;
    listen 443 ssl;
    ssl_certificate /home/zenx/educa/ssl/educa.crt;
    ssl_certificate_key /home/zenx/educa/ssl/educa.key;
    server_name www.educaproject.com educaproject.com;
    # ...

現在我們的服務器在80端口監聽HTTP,在443端口監聽HTTPS。我們用ssl_certificate制定SSL證書,用ssl_certificate_key制定證書key。

使用以下命令重啟Nginx:

sudo service nginx restart

Nginx將會加載新的配置。在瀏覽器中打開http://educaproject.com。你會看到一個類似這樣的靜態消息:


不同的瀏覽器,這個消息可能會不同。它警告你,你的網站沒有使用受信任的證書;瀏覽器不能驗證網站的身份。這是因為我們簽署了自己的證書,而不是從受信任的認證機構獲得證書。當你擁有真正的域名時,你可以申請受信任的CA為其頒發SSL證書,以便瀏覽器可以驗證其身份。

如果你想為真正域名獲得受信任的證書,你可以參數Linux Foundation創建的Let's Encrypt項目。這是一個協作項目,目的是免費的簡化獲取和更新受信任的SSL證書。你可以在這裏閱讀更多信息。

點擊Add Exception按鈕,讓瀏覽器知道你信任這個證書。你會看到瀏覽器在URL旁显示一個鎖的圖標,如下圖所示:


如果你點擊鎖圖標,則會显示SSL證書的詳情。

13.3.3 為SSL配置我們的項目

Django包括一些SSL的特定設置。編輯settings/pro.py設置文件,添加以下代碼:

SECURE_SSL_REDIRECT = True
CSRF_COOKIE_SECURE = True

這些設置分別是:

  • SECURE_SSL_REDIRECT:HTTP請求是否必須重定義到HTTPS請求
  • CSRF_COOKIE_SECURE:這必須為跨站點請求保護設置為建立一個安全的cookie

非常棒!你已經配置了一個生產環境,它會為你的項目提供高性能的服務。

13.4 創建自定義的中間件

你已經了解了MIDDLEWARE設置,其中包括項目的中間件。一个中間件是一個類,其中包括一些在全局執行的特定方法。你可以把它看成一個低級別的插件系統,允許你實現在請求或響應過程中執行的鈎子。每个中間件負責會在所有請求或響應中執行的一些特定操作。

避免在中間件中添加開銷昂貴的處理,因為它們為在每個請求中執行。

當收到一個HTTP請求時,中間件會以MIDDLEWARE設置中的出現順序執行。當一個HTTP響應由Django生成時,中間件的方法會逆序執行。

下圖展示了請求和響應階段時,中間件方法的執行順序。它還展示了可能被調用的中間件方法:


在請求階段,會執行中間件的以下方法:

  1. process_request(request):在Django決定執行哪個視圖之前,在每個請求上調用。request是一個HttpRequest實例。
  2. process_view(request, view_func, view_args, view_kwargs):在Django調用視圖之前調用。它可以訪問視圖函數及其收到的參數

在響應階段,會執行中間件的以下方法:

  1. process_exception(request, exception):只有視圖函數拋出Exception異常時才會調用。
  2. process_template_response(request, response):視圖執行完成后調用,只有當response對象有render()方法時才調用(比如它是TemplateResponse或者等價對象)
  3. process_response(request, response):響應返回到瀏覽器之前,在所有響應上調用。

因為中間件可以依賴之前已經執行的其它中間件方法在請求中設置的數據,所以MIDDLEWARE設置中的順序很重要。請注意,即使因為前一个中間件返回了HTTP響應,導致process_request()process_view()被跳過,中間件的process_response()方法也會被調用。這意味着process_response()不能依賴於請求階段設置的數據。如果一個異常被某个中間件處理,並返回了一個響應,則之前的中間件類不會被調用。

當添加新的中間件到MIDDLEWARE設置中時,確保把它放在了正確的位置。在請求階段,中間件方法按設置中的出現順序執行,響應階段則是逆序執行。

你可以在這裏查看更多關於中間件的信息。

我們將創建一個自定義的中間件,允許通過自定義子域名訪問課程。每個課程詳情視圖的URL(比如http://educaproject.com/courses/django/)也可以通過子域名(用課程的slug字段構建)訪問,比如http://django.educaproject.com/

13.4.1 創建子域名中間件

中間件可以位於項目的任何地方。但是,推薦的方式是在應用目錄中創建一個middleware.py文件。

courses應用目錄中創建middleware.py文件,並添加以下代碼:

from django.core.urlresolvers import reverse
from django.shortcuts import get_object_or_404, redirect
from .models import Course

class SubdomainCourseMiddleware:
    def process_request(self, request):
        host_parts = request.get_host().split('.')
        if len(host_parts) > 2 and host_parts[0] != 'www':
            # get course for the given subdomain
            course = get_object_or_404(Course, slug=host_parts[0])
            course_url = reverse('course_detail', args=[course.slug])
            # redirect current request to the course_detail view
            url = '{}://{}{}'.format(
                request.scheme,
                '.'.join(host_parts[1:]),
                course_url
            )
            return redirect(url)

我們創建了一個實現了process_request()的中間件。當收到HTTP請求時,我們執行以下任務:

  1. 我們獲得請求中使用的主機名,並把它拆分為多個部分。比如,如果用戶訪問的是mycourse.educaproject.com,則會生成['mycourse', 'educaproject', 'com']列表。
  2. 通過檢查拆分后是否生成兩個以上的元素,我們核實包括子域名的主機名。如果主機名包括子域名,並且它不是www,則嘗試使用子域名提供的slug獲得課程。
  3. 如果沒有找到課程,我們拋出Http 404異常。否則,我們使用主域名重定向到課程詳情的URL。

編輯項目的settings/base.py文件,在MIDDLEWARE設置底部添加courses.middleware.SubdomainCourseMiddleware

MIDDLEWARE = [
    # ...
    'courses.middleware.SubdomainCourseMiddleware',
]

現在我們的中間件會在每個請求上執行。

13.4.2 使用Nginx為多個子域名服務

我們需要Nginx為帶任意可能子域名的我們的網站提供服務。編輯config/nginx.conf文件,找到這一行代碼:

server_name www.educaproject.com educaproject.com;

替換為下面這一行代碼:

server_name *.educaproject.com educaproject.com;

通過使用星號,這條規則會應用與educaproject.com的所有子域名。為了在本地測試我們的中間件,我們需要在/etc/hosts中添加想要測試的子域名。要用別名為djangoCourse對象測試中間件,需要在/etc/hosts文件添加這一行:

127.0.0.1 django.educaproject.com

然後在瀏覽器中打開https://django.educaproject.com/。中間件會通過子域名找到課程,並重定向到https://educaproject.com/course/django/

13.5 實現自定義管理命令

Django允許你的應用為manage.py工具註冊自定義管理命令。例如,我們在第九章使用makemessagescompilemessages管理命令來創建和編譯轉換文件。

一個管理命令由一個Python模塊組成,其中Python模塊包括一個從django.core.management.BaseCommand繼承的Command類。你可以創建簡單命令,或者讓它們接收位置和可選參數作為輸入。

Django在INSTALLED_APPS設置中激活的每個應用的management/commands/目錄中查找管理命令。發現的每個模塊註冊為以其命名的管理命令。

你可以在這裏進一步學習自定義管理命令。

我們將註冊一個自定義管理命令,提供學生至少報名一個課程。該命令會給註冊時間長於指定時間,但尚未報名任何課程的用戶發送一封提醒郵件。

students應用目錄中創建以下文件結構:

management/
    __init__.py
    commands/
        __init__.py
        enroll_reminder.py

編輯enroll_reminder.py文件,並添加以下代碼:

import datetime
from django.conf import settings
from django.core.management.base import BaseCommand
from django.core.mail import send_mass_mail
from django.contrib.auth.models import User
from django.db.models import Count

class Command(BaseCommand):
    help = 'Send an e-mail reminder to users registered more \
            than N days that are not enrolled into any courses yet'

    def add_arguments(self, parser):
        parser.add_argument('--days', dest='days', typy=int)

    def handle(self, *args, **kwargs):
        emails = []
        subject = 'Enroll in a course'
        date_joined = datetime.date.today() - datetime.timedelta(days=options['days'])
        users = User.objects.annotate(
            course_count=Count('courses_enrolled')
        ).filter(
            course_count=0, date_joined__lte=date_joined
        )
        for user in users:
            message = 'Dear {},\n\nWe noticed that you didn\'t enroll in any courses yet.'.format(user.first_name)
            emails.append((
                subject,
                message,
                settings.DEFAULT_FROM_EMAIL,
                [user.email]
            ))
        send_mass_mail(emails)
        self.stdout.write('Sent {} reminders' % len(emails))

這是我們的enroll_reminder命令。這段代碼完成以下任務:

  • Command類從BaseCommand繼承。
  • 我們包括了一個help屬性。該屬性為命令提供了一個簡單描述,如果你執行python manage.py help enroll_reminder命令,則會打印這個描述。
  • 我們使用add_arguments()方法添加--days命名參數。該參數用於指定用戶註冊了,但沒有報名參加任何課程,從而需要接收提醒郵件的最小天數。
  • handle()方法包括實際命令。我們從命令行解析中獲得days屬性。我們檢索註冊天數超過指定天數,當仍沒有參加任何課程的用戶。我們用一個用戶報名參加的總課程數量註解(annotate)QuerySet實現此目的。我們為每個用戶生成一封提醒郵件,並把它添加到emails列表中。最後,我們用send_mass_mail()函數發送郵件,這個函數打開單個SMTP連接發送所有郵件,而不是每發送一封郵件打開一個連接。

你已經創建了第一個管理命令。打開終端執行你的命令:

python manage.py enroll_reminder --days=20

如果你沒有正在運行的本地SMTP服務器,你可以參考第二章,我們為第一個Django項目配置了SMTP設置。另外,你可以添加以下行到settings/local.py文件,讓Django在開發期間輸出郵件到標準輸出:

EMAIL_BACKEND = 'django.core.mail.backends.console.EmailBackend'

讓我們調度管理命令,讓服務器沒有早上8點運行它。如果你正在使用基於Unix的系統,比如Linux或者Mac OS X,打開終端執行crontab -e來編輯計劃任務。在其中添加下面這一行:

0 8 * * * python /path/to/educa/manage.py enroll_reminder --days=20 --settings=educa.settings.pro

如果你不熟悉Cron,你可以在這裏學習它。

如果你正在使用Windows,你可以使用Task scheduler調度任務。你可以在這裏進一步學習它。

定期執行操作的另一個方法是用Celery創建和調度任務。記住,我們在第七章使用Celery執行了異步任務。除了使用Cron創建和調用管理命令,你還可以使用Celery beat scheduler創建異步任務並執行它們。你可以在這裏進一步學習使用Celery調度定時任務。

對要使用Cron或者Windows調度任務控制面板調度的獨立腳本使用管理命令。

Django還包括一個用Python調用管理命令的工具。你可以在代碼中如下執行管理命令:

from django.core import management
management.call_command('enroll_reminder', days=20)

恭喜你!現在你已經為你的應用創建了自定義管理命令,並在需要時調度它們。

13.6 總結

在這一章中,你使用uWSGINginx配置了一個生產環境。你還實現了一個自定義中間件,並學習了如何創建自定義管理命令。