1、前言

在做 django 開(kāi)發(fā)需求時(shí)，多多少少都會(huì)遇到需要定時(shí)任務(wù)的功能，比如定時(shí)執(zhí)行任務(wù)，檢查訂單之類的?？赡苁且欢螘r(shí)間，比如每隔 10分鐘執(zhí)行一次，也可能是定點(diǎn)時(shí)間，比如 14:00 執(zhí)行，也可能是長(zhǎng)時(shí)間，比如每周幾，每個(gè)月的哪一天等。查看了一下相關(guān)資料， django 定時(shí)任務(wù) django-crontab 庫(kù)比較多教程和資料，雖然 star 數(shù)才五百，但是 API 接口比較簡(jiǎn)單，接入也很方便，功能也很全面，當(dāng)然，也存在一此無(wú)法解決的問(wèn)題，使用時(shí)需要注意的。

2、使用教程

1.安裝:

pip install django-crontab

2.添加配置到 settings.py INSTALLED_APPS 中

INSTALLED_APPS = (
    'django_crontab',
    ...
)

3.編寫(xiě)定時(shí)函數(shù):

定時(shí)任務(wù)可以分成兩種，一種是執(zhí)行自定義的mange.py的命令，另一種是執(zhí)行自定義函數(shù)。

在django的app中新建一個(gè)myapp/cron.py文件，把需要定時(shí)執(zhí)行的代碼放進(jìn)去

示例：

def my_scheduled_job():
  pass

4.在 settings.py 中增加CRONJOBS配置

CRONJOBS = [
    ('*/5 * * * *', 'myapp.cron.my_scheduled_job')
]

也可以定義一些關(guān)鍵字參數(shù)，有2種格式：

格式1：

• 要求：cron計(jì)時(shí)通常格式（有關(guān)更多示例，請(qǐng)參閱 Wikipedia 和 crontab.guru）
• 要求：python模塊路徑下待執(zhí)行定時(shí)任務(wù)
• 可選：特定于定時(shí)任務(wù)的后綴（例如，將 out/err 重定向到文件，默認(rèn)值為''）

示例：

CRONJOBS = [
    ('*/1 * * * *', 'appname.test_crontab.test','>>/home/python/test_crontab.log')

]

注意： >> 表示追加寫(xiě)入，> 表示覆蓋寫(xiě)入。

格式2：

• 要求：cron計(jì)時(shí)通常格式
• 要求：python模塊路徑下待執(zhí)行定時(shí)任務(wù)
• 可選：方法的位置參數(shù)列表（默認(rèn)值：[]）
• 可選：方法的關(guān)鍵字參數(shù)的dict（默認(rèn)值：{}）
• 可選：特定于定時(shí)任務(wù)的后綴（例如，將 out/err 重定向到文件，默認(rèn)值為''）

示例：

CRONJOBS = [
    ('*/5 * * * *', 'myapp.cron.other_scheduled_job', ['arg1', 'arg2'], {'verbose': 0}),
    ('0   4 * * *', 'django.core.management.call_command', ['clearsessions']),
    
]

對(duì)于熟悉 Linux 中定時(shí)任務(wù)crontab 的同學(xué)可能對(duì)上面第一個(gè)參數(shù)的語(yǔ)法很親切。上面表示每隔1分鐘執(zhí)行一次代碼。

Linux 中的定時(shí)任務(wù)crontab的語(yǔ)法如下:

*  *  *  *  * command
分鐘(0-59) 小時(shí)(0-23) 每個(gè)月的哪一天(1-31) 月份(1-12) 周幾(0-6) shell腳本或者命令

有幾個(gè)特殊的符號(hào)：

* 代表所有的取值范圍的數(shù)字
/ 代表每的意思，*/5就是每5個(gè)單位
- 代表從某個(gè)數(shù)字到某個(gè)數(shù)字
, 分開(kāi)幾個(gè)離散的數(shù)字

示例:

每?jī)蓚€(gè)小時(shí)    0 */2 * * *
晚上11點(diǎn)到早上8點(diǎn)之間每?jī)蓚€(gè)小時(shí)，早上8點(diǎn)    0 23-7,8 * * *
每個(gè)月的4號(hào)和每個(gè)禮拜的禮拜一到禮拜三的早上11點(diǎn)    0 11 4 * 1-3
1月1日早上4點(diǎn)    0 4 1 1 * 

0 6 * * * commands >> /tmp/test.log # 每天早上6點(diǎn)執(zhí)行, 并將信息追加到test.log中
0 */2 * * * commands # 每隔2小時(shí)執(zhí)行一次

有興趣的小伙伴可以深入研究下 Linux 的crontab定時(shí)任務(wù)。如果不了解和不熟悉可以想看： cron語(yǔ)法格式學(xué)習(xí)

5.添加并啟動(dòng)定時(shí)任務(wù)

#添加并啟動(dòng)定時(shí)任務(wù)
python manage.py crontab add

其它命令：

#顯示當(dāng)前的定時(shí)任務(wù)
python manage.py crontab show

#刪除所有定時(shí)任務(wù)
python manage.py crontab remove

一些問(wèn)題

如果配置成這樣：

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

CRONJOBS = [
('0 7 * * 1-5', 'api.cron.email_to_late_docs', '>> {}'.format(BASE_DIR + '/logs/log_{:%d_%m_%Y}.log'.format(time.now()))),
('0 7 * * 1-5', 'api.cron.email_ten_days_before', '>> {}'.format(BASE_DIR + 'logs/log_{:%d_%m_%Y}.log'.format(time.now())))
]

上述代碼的目的是，希望對(duì)任務(wù)的輸出和錯(cuò)誤日志，進(jìn)行 log_ddmmYY 格式進(jìn)行文件每天分開(kāi)保存。

但是這個(gè)任務(wù)，在第二天時(shí)，就不會(huì)在執(zhí)行啦??！

因?yàn)椋?code>CRONJOBS 生成任務(wù)時(shí)，會(huì)生成對(duì)應(yīng)的哈希值（hashes），標(biāo)識(shí)每個(gè)任務(wù)。所以，當(dāng)文件名變更時(shí)，CRONJOBS 中的值每天都在變化，導(dǎo)致不同的定時(shí)任務(wù)哈希值（hashes）。

針對(duì)這種情況，解決方法是，日志文件名稱固定，然后創(chuàng)建一個(gè)任務(wù)，用來(lái)每天把日志文件重命名（move）成想要的格式名稱，這樣就可以啦！

總結(jié)

通過(guò)這個(gè)需求，可以看到很多知識(shí)點(diǎn)其實(shí)是串聯(lián)起來(lái)的，從python到django到Linux的crontab，所以，學(xué)習(xí)無(wú)止境，知識(shí)學(xué)習(xí)只會(huì)越來(lái)越多，如果你提前掌握了某些知識(shí)，那么學(xué)習(xí)新（舊）知識(shí)的成本就會(huì)降低很多，或者理解成本，比如你學(xué)習(xí)了 Linux， 了解過(guò) cron ，那么對(duì)于學(xué)習(xí)這個(gè) django 的定時(shí)任務(wù)會(huì)輕松很多！永遠(yuǎn)不要認(rèn)為有些知識(shí)你永遠(yuǎn)用不上，所以現(xiàn)在就不學(xué)，可能現(xiàn)在的永遠(yuǎn)距離已經(jīng)很短啦！加油~

參考

• kraiz/django-crontab: dead simple crontab powered job scheduling for django.
• django開(kāi)發(fā)-定時(shí)任務(wù)的使用 - wyzane - SegmentFault 思否
• django-crontab 定時(shí)執(zhí)行任務(wù)方法 - 程序園
• django-crontab實(shí)現(xiàn)Django定時(shí)任務(wù)
• django使用django-crontab實(shí)現(xiàn)定時(shí)任務(wù) - 簡(jiǎn)書(shū)
• 使用django-crontab實(shí)現(xiàn)定時(shí)任務(wù) - 騰訊云
• cron語(yǔ)法格式學(xué)習(xí) - 簡(jiǎn)書(shū)
• django-crontab is missing job hash after one day · Issue #76 · kraiz/django-crontab
• Cron Format - Wikipedia
• crontab.guru

• 如有疑問(wèn)，歡迎在評(píng)論區(qū)一起討論！
• 如有不正確的地方，歡迎指導(dǎo)！

注：本文首發(fā)于 iHTCboy's blog，如若轉(zhuǎn)載，請(qǐng)注來(lái)源