Django-crontab詳解

一、簡介

django-crontab是一個在Django項目中使用的基於系統定時任務的任務調度應用，可以使用Python的Crontab來實現實現周期性的高級任務調度，一般適用於需要定期執行特定任務的情況下。

該應用旨在使開發人員能夠將必須運行的定期任務與應用集成，並確保這些任務始終運行。

二、快速上手

使用該應用需要先安裝django-crontab，安裝方式如下：

pip install django-crontab

安裝完成後，在Django項目的settings.py文件內添加如下行：

INSTALLED_APPS = [
    ...
    'django_crontab',
]

                                                          # 其他設置
CRONJOBS = [
    ('*/1 * * * *', 'myproject.myapp.cron.my_scheduled_job'),
    ('0 0 * * *', 'myproject.myapp.cron.my_scheduled_job'),
]

以上代碼表示了一個基本的定期任務，表示每分鐘執行一次定時任務，另外一個是每天的00:00執行一次定時任務，函數my_scheduled_job是你要執行的函數。*

三、使用實例

1. 周期性任務

使用django-crontab可以很方便地使用Python的Crontab來實現各種周期性的任務調度。

我們可以設置如下的定期任務，每天中午12:30 PM執行一個定時任務：

CRONJOBS = [
    ('30 12 * * *', 'myproject.myapp.cron.my_scheduled_job')
]

以上代碼表示的是cron表達式的格式，30表示30分鐘，12表示12小時（中午12點），星號表示允許在任何日子和月份內執行任務。

同時也可以設置一個月度計劃的任務，例如，每月的10號執行一次：

CRONJOBS = [
    ('0 0 10 * *', 'myproject.myapp.cron.my_scheduled_job')
]

2. 執行管理命令

django-crontab不僅可以讓你的項目執行特定的函數，還可以讓你在管理命令上使用。

在settings.py的CRONJOBS中添加下面代碼：

CRONJOBS = [
    ...
    ('*/1 * * * *', 'myproject.myapp.cron.my_scheduled_job'),
    ('0 0 * * *', 'myproject.myapp.cron.my_scheduled_job'),
    ('0 0 * * *', 'python manage.py clearsessions'),
    ('0 0 * * *', 'python manage.py clearcache'),
    ('0 0 * * *', 'python manage.py update_index'),
]

在示例中，可以看到一些基本的管理命令，如清除緩存等，在CRONTAB中也可以在末尾添加這些任務。

3. 發送定時郵件

如果你需要發送定時郵件，使用django-crontab也可以實現它。

需要進行以下幾步操作：

第一步，在settings.py中配置郵件相關設置如下：

CRONTAB_DJANGO_SETTINGS_MODULE = ‘my_project.settings’
CRONTAB_EMAIL = “foo@bar.com"
CRONTAB_USE_HTTPS = True

第二步，設置定期任務如下：

'0 0 * * *', 'python manage.py send_email --subject “my_subject” --text “my_text”'

注意，在定期任務中調用了send_email函數，因此需要在Python代碼中創建這個函數，如下所示：

def send_email(subject, text):
    from django.core.mail import send_mail
    send_mail(subject, text, 'from@example.com', ['to@example.com'], fail_silently=False) 

四、注意事項

1. 安裝完 django_crontab 應用之後，需要重新運行一遍 python manage.py runserver ，才能夠看到新添加的 crontab 任務。

2. 運行定時任務時，默認為 debug=False 。

3. 不支持用逗號分割多個條件

4. django-crontab內置了一個很強大的日誌工具，可以幫助你追蹤問題。

五、總結

本文簡單介紹了Django中的定時任務調度器django-crontab的基礎知識，包括使用方法，注意事項和實例。希望可以幫助到Django開發者，提高代碼的效率和性能。