Django Apscheduler詳解

一、什麼是Django Apscheduler

Django Apscheduler是Django與Apscheduler進行結合的一個開源庫，Apscheduler是Python中的一個定時任務調度器，可以讓我們可以方便地進行定時任務的管理。

二、Django Apscheduler的安裝及配置

1、安裝

pip install django-apscheduler

2、在django的settings.py文件中配置相關信息

INSTALLED_APPS =[
    'django_apscheduler',
    # ...
]

SCHEDULER_AUTOSTART = True

SCHEDULER_RUN_NOW = True

SCHEDULER_TIMEZONE = "Asia/Shanghai"

其中，SCHEDULER_AUTOSTART表示Django啟動時，任務調度器是否隨之啟動；SCHEDULER_RUN_NOW表示Django啟動時，任務調度器是否跑一遍；SCHEDULER_TIMEZONE是任務調度器所使用的時區。

三、Django Apscheduler的使用方法

1、創建任務

在Django Apscheduler中，我們可以使用裝飾器或繼承django_apscheduler.models的BaseJob類來創建我們的任務。

裝飾器創建方法：

from django_apscheduler.jobstores import DjangoJobStore, register_job

@register_job(DjangoJobStore(), 'interval', seconds=30)
def task_job():
    print('Django apscheduler task')

繼承BaseJob類創建方法：

from django_apscheduler.models import DjangoJob
from django_apscheduler.jobstores import DjangoJobStore

class TaskJob(DjangoJob):
    owner = models.ForeignKey(settings.AUTH_USER_MODEL)

    @classmethod
    def get_owner(klass, id):
        try:
            return klass.objects.get(id).owner
        except klass.DoesNotExist:
            return None

    def run(self):
        print('Django apscheduler task')

job = TaskJob()
job.interval_seconds = 30
job.save()

2、任務調度器的各種配置

除了上述的SCHEDULER_AUTOSTART、SCHEDULER_RUN_NOW和SCHEDULER_TIMEZONE，Django Apscheduler還有各種配置可以設定，下面是部分配置：

SCHEDULER_JOBSTORES = {
    'default': DjangoJobStore(),
}

SCHEDULER_EXECUTORS = {
    'default': {'type': 'threadpool', 'max_workers': 20},
}

SCHEDULER_JOB_DEFAULTS = {
    'coalesce': True,
    'misfire_grace_time': 10 * 60,
    'max_instances': 3,
}

SCHEDULER_API_ENABLED = True

3、任務的執行

我們創建任務後，需要在Django啟動後，我們的任務才會開始執行。

啟動方式1：

from django_apscheduler.jobstores import register_events

register_events(SCHEDULER)

啟動方式2：

from apscheduler.schedulers.background import BackgroundScheduler
from django_apscheduler.jobstores import DjangoJobStore
from django_apscheduler.jobstores import register_events

scheduler = BackgroundScheduler(timezone=get_current_timezone())
scheduler.add_jobstore(DjangoJobStore())
register_events(scheduler)
scheduler.start()

啟動方式3：

python manage.py runapscheduler

四、任務的刪除與修改

我們可以通過任務的id來刪除或修改任務。

刪除任務：

from django_apscheduler.models import DjangoJobExecution

DjangoJob.objects.filter(id=id).delete()
DjangoJobExecution.objects.filter(job_id=id).delete()

修改任務：

job = DjangoJob.objects.get(id=id)
job.next_run_time = django_timezone.now()
job.save()

五、小結

在本文中，我們詳細介紹了Django Apscheduler的安裝、配置、創建任務、任務調度器的配置以及任務的執行和刪除等相關信息。希望讀者可以通過本文對Django Apscheduler有一個深入的了解，並在實際開發中靈活運用。