利用django-crontab設定定時任務

　　Django中想要設定定時任務的方法有不少，如celery、apscheduler、crontab等等，本文用crontab來實現。

　　想用apscheduler實現請看本人另外一篇博客：使用APScheduler啓動Django服務時自動運行腳本（可設置定時運行）

Crontab簡介

　　crond 是linux下用來週期性的執行某種任務或等待處理某些事件的一個守護進程，與windows下的計劃任務相似，當安裝完成操做系統後，默認會安裝此服務 工具，而且會自動啓動crond進程，crond進程每分鐘會按期檢查是否有要執行的任務，若是有要執行的任務，則自動執行該任務。

　　Linux下的任務調度分爲兩類，系統任務調度和用戶任務調度。

• 系統任務調度：系統週期性所要執行的工做，好比寫緩存數據到硬盤、日誌清理等。在/etc目錄下有一個crontab文件，這個就是系統任務調度的配置文件。

cat /etc/crontab

SHELL=/bin/bash

PATH=/sbin:/bin:/usr/sbin:/usr/bin

MAILTO=HOME=/

# run-parts

51 * * * * root run-parts /etc/cron.hourly

24 7 * * * root run-parts /etc/cron.daily

22 4 * * 0 root run-parts /etc/cron.weekly

42 4 1 * * root run-parts /etc/cron.monthly
"""
前四行是用來配置crond任務運行的環境變量，第一行SHELL變量指定了系統要使用哪一個shell，這裏是bash，第二行PATH變量指定了系統執行 命令的路徑，第三行MAILTO變量指定了crond的任務執行信息將經過電子郵件發送給root用戶，若是MAILTO變量的值爲空，則表示不發送任務 執行信息給用戶，第四行的HOME變量指定了在執行命令或者腳本時使用的主目錄。第六至九行用的是crond語法，詳細含義在下文中會進行解釋
"""

/etc/crontab文件內容

• 用戶任務調度：用戶按期要執行的工做，好比用戶數據備份、定時郵件提醒等。用戶可使用 crontab 工具來定製本身的計劃任務。全部用戶定義的crontab 文件都被保存在 /var/spool/cron目錄中。其文件名與用戶名一致。

"""
文件：/etc/cron.deny
說明：該文件中所列用戶不容許使用crontab命令

文件：/etc/cron.allow
說明：該文件中所列用戶容許使用crontab命令

文件：/var/spool/cron/
說明：全部用戶crontab文件存放的目錄,以用戶名命名

"""

使用者權限文件

 

Django-crontab的配置及使用

　　首先咱們須要先安裝好Django-crontab的第三方庫

pip install django-crontab

 

　　而後咱們須要將django-crontab加入到settings.py的INSTALLED_APPS中。以下代碼：

INSTALLED_APPS = (
'django_crontab',
...
)

 

　　接下來咱們須要自行配置一個Django的命令，若是你還不會自定製Django的命令的話請看這篇編寫自定義django-admin命令

　　在編寫完自定製命令後，咱們須要進行時間的配置，使Django知道你是想在何時運行這段程序。在settings.py中寫入配置（這裏咱們假設自定製命令名稱爲xxx）

CRONJOBS = [
    ('47 11 * * *', 'django.core.management.call_command', ['xxx'],{},'>> /var/run.log'),
]
#上述配置意思爲天天11點47分運行xxx這個命令,{}爲函數須要傳入的參數，>>後面爲打印日誌的文件路徑。

 

這裏須要科普一下關於crontab的語法知識

　　Crontab語法用五個段來定義時間，具體含義：

*     *   *   *    *  command to be executed
-     -    -    -    -
|     |     |     |     |
|     |     |     |     +----- day of week (0 - 6) (Sunday=0)
|     |     |     +------- month (1 - 12)
|     |     +--------- day of month (1 - 31)
|     +----------- hour (0 - 23)
+------------- min (0 - 59)

#全部的值都必須在相應的範圍以內，不然視爲無效。在填值區域內能夠是*也能夠是以」，」分隔的一組值。值能夠是一個數據也能夠是用鏈接符連起來的兩個數(表示範圍)。
#星號（*）：表明全部可能的值，例如month字段若是是星號，則表示在知足其它字段的制約條件後每個月都執行該命令操做。
#逗號（,）：能夠用逗號隔開的值指定一個列表範圍，例如，「1,2,5,7,8,9」
#中槓（-）：能夠用整數之間的中槓表示一個整數範圍，例如「2-6」表示「2,3,4,5,6」
#正斜線（/）：能夠用正斜線指定時間的間隔頻率，例如「0-23/2」表示每兩小時執行一次。同時正斜線能夠和星號一塊兒使用，例如*/10，若是用在minute字段，表示每十分鐘執行一次。
注：日期的格式能夠是星期，也能夠是一個月中的天。假如兩個都有值，則在這兩個時間都會執行。

#實例1：每1分鐘執行一次command
* * * * * command

#實例2：每小時的第3和第15分鐘執行
3,15 * * * * command

#實例3：在上午8點到11點的第3和第15分鐘執行
3,15 8-11 * * * command

#實例4：每隔兩天的上午8點到11點的第3和第15分鐘執行
3,15 8-11 */2 * * command

#實例5：每一個星期一的上午8點到11點的第3和第15分鐘執行
3,15 8-11 * * 1 command

#實例6：每晚的21:30重啓smb 
30 21 * * * /etc/init.d/smb restart

#實例7：每個月一、十、22日的4 : 45重啓smb 
45 4 1,10,22 * * /etc/init.d/smb restart

#實例8：每週6、週日的1 : 10重啓smb
10 1 * * 6,0 /etc/init.d/smb restart

#實例9：天天18 : 00至23 : 00之間每隔30分鐘重啓smb 
0,30 18-23 * * * /etc/init.d/smb restart

#實例10：每星期六的晚上11 : 00 pm重啓smb 
0 23 * * 6 /etc/init.d/smb restart

#實例11：每一小時重啓smb 
* */1 * * * /etc/init.d/smb restart

#實例12：晚上11點到早上7點之間，每隔一小時重啓smb 
* 23-7/1 * * * /etc/init.d/smb restart

#實例13：每個月的4號與每週一到週三的11點重啓smb 
0 11 4 * mon-wed /etc/init.d/smb restart

#實例14：一月一號的4點重啓smb 
0 4 1 jan * /etc/init.d/smb restart

#實例15：每小時執行/etc/cron.hourly目錄內的腳本
01   *   *   *   *     root run-parts /etc/cron.hourly

#注：run-parts這個參數了，若是去掉這個參數的話，後面就能夠寫要運行的某個腳本名，而不是目錄名了

更多實例戳這裏

 

　　完成上述配置後，咱們只須要運行一條命令，Django就知道在該特定的時間須要作什麼特定的事了。（想要讓Django作定時任務，前提條件使在該時刻Django項目處於運行狀態）

python manage.py crontab add #告訴Django你配置了一個定時任務
#每次修改該任務中任何一段代碼的時候，再執行一遍這條命令

python manage.py crontab remove #移除全部的任務

 

　　經過crontab -l 能夠看到生成的定時任務

 

使用注意事項

環境變量問題
　　有時咱們建立了一個crontab，可是這個任務卻沒法自動執行，而手動執行這個任務卻沒有問題，這種狀況通常是因爲在crontab文件中沒有配置環境變量引發的。

　　在 crontab文件中定義多個調度任務時，須要特別注意的一個問題就是環境變量的設置，由於咱們手動執行某個任務時，是在當前shell環境下進行的，程 序固然能找到環境變量，而系統自動執行任務調度時，是不會加載任何環境變量的，所以，就須要在crontab文件中指定任務運行所需的全部環境變量，這 樣，系統執行任務調度時就沒有問題了。

　　不要假定cron知道所須要的特殊環境，它其實並不知道。因此你要保證在shelll腳本中提供全部必要的路徑和環境變量，除了一些自動設置的全局變量。因此注意以下3點：

　　　　1）腳本中涉及文件路徑時寫全局路徑；

　　　　2）腳本執行要用到java或其餘環境變量時，經過source命令引入環境變量，如：

　　　　　　cat start_cbp.sh

　　　　　　#!/bin/sh

　　　　　　source /etc/profile

　　　　　　export RUN_CONF=/home/d139/conf/platform/cbp/cbp_jboss.conf

　　　　　　/usr/local/jboss-4.0.5/bin/run.sh -c mev &

　　　　3）當手動執行腳本OK，可是crontab死活不執行時。這時必須大膽懷疑是環境變量惹的禍，並能夠嘗試在crontab中直接引入環境變量解決問題。如：

　　　　　　0 * * * * . /etc/profile;/bin/sh /var/www/java/audit_no_count/bin/restart_audit.sh

　　注意清理系統用戶的郵件日誌
　　每條任務調度執行完畢，系統都會將任務輸出信息經過電子郵件的形式發送給當前系統用戶，這樣日積月累，日誌信息會很是大，可能會影響系統的正常運行，所以，將每條任務進行重定向處理很是重要。

　　例如，能夠在crontab文件中設置以下形式，忽略日誌輸出：

　　　　0 */3 * * * /usr/local/apache2/apachectl restart >/dev/null 2>&1

　　　　「/dev/null 2>&1」表示先將標準輸出重定向到/dev/null，而後將標準錯誤重定向到標準輸出，因爲標準輸出已經重定向到了/dev/null，所以標準錯誤也會重定向到/dev/null，這樣日誌輸出問題就解決了。

系統級任務調度與用戶級任務調度
　　系統級任務調度主要完成系統的一些維護操做，用戶級任務調度主要完成用戶自定義的一些任務，能夠將用戶級任務調度放到系統級任務調度來完成（不建議這麼 作），可是反過來卻不行，root用戶的任務調度操做能夠經過「crontab –uroot –e」來設置，也能夠將調度任務直接寫入/etc /crontab文件，須要注意的是，若是要定義一個定時重啓系統的任務，就必須將任務放到/etc/crontab文件，即便在root用戶下建立一個 定時重啓系統的任務也是無效的。

其餘注意事項
　　新建立的cron job，不會立刻執行，至少要過2分鐘才執行。若是重啓cron則立刻執行。

　　當crontab忽然失效時，能夠嘗試/etc/init.d/crond restart解決問題。或者查看日誌看某個job有沒有執行/報錯tail -f /var/log/cron。

　　千萬別亂運行crontab -r。它從Crontab目錄（/var/spool/cron）中刪除用戶的Crontab文件。刪除了該用戶的全部crontab都沒了。

　　在crontab中%是有特殊含義的，表示換行的意思。若是要用的話必須進行轉義\%，如常常用的date ‘+%Y%m%d’在crontab裏是不會執行的，應該換成date ‘+\%Y\%m\%d’。