django-apscheduler定时任务

django-apscheduler它基于 apscheduler 库，它是一个 Python 的定时任务调度库，可以轻松地执行定时任务。支持固定时间间隔，固定时间点（日期），crontab命令三中调度方式。

django-apscheduler安装

pip install django-apscheduler

django配置

setting.py配置文件的INSTALLED_APPSl里面进行注册

INSTALLED_APPS = (
    # ... ...
    "django_apscheduler",
)

数据迁移

python manage.py migrate

迁移完成后数据库会创建django_apscheduler_djangojob和django_apscheduler_djangojobexecution两张表

django_apscheduler_djangojob表，保存任务ID以及下次运行时间等

django_apscheduler_djangojobexecution表，保存每次的执行记录、执行的时长和执行结果等。

status: 执行状态
duration: 执行了多久
exception: 是否出现异常

使用定时器

在views.py中编写代码，当当django启动时会自动创建定时任务，或者也可以写在urls.py文件中。

from apscheduler.schedulers.background import BackgroundScheduler

def scheduler_test():
    print('定时任务触发')
# BlockingScheduler() 调度器在主线程中执行， 阻塞当前线程。
# scheduler = BlockingScheduler()

# BackgroundScheduler() 调度器在后台执行，不会阻塞当前进程，一般情况使用此方法。
scheduler = BackgroundScheduler()
try:
# 添加定时任务，第一个参数为需要定时执行的任务，'cron'定时任务类型，每天0点，30分执行一次，任务id为test。
	scheduler.add_job(scheduler_test, 'cron', hour=0, minute=30, id='test', replace_existing=True,timezone='Asia/Shanghai')
    # 启动定时任务
	scheduler.start()
except Exception as e:
    print(e)
    # 停止定时任务
    scheduler.shutdown()

注意：创建定时任务时，尽量指定任务id，不指定id时会随机生成。如果不指定ID在多线程中会发生同一个任务重复创建多次的问题。指定ID之后，当触发add_job时如果任务已存在则会报错，反之就会新创建一个定时任务。

---

cron定时器

参数	解释
year (int 或 str)	年
month (int 或 str)	月 (范围1-12)
day (int 或 str)	日 (范围1-31）
week (int 或 str)	周 (范围1-53)
day_of_week (int 或 str)	周内第几天或者星期几 (范围0-6 或者 mon,tue,wed,thu,fri,sat,sun)
hour (int 或 str)	时 (范围0-23)
minute (int 或 str)	分 (范围0-59)
second (int 或 str)	秒 (范围0-59)
start_date (datetime 或 str)	最早开始日期(包含)
end_date (datetime 或 str)	最晚结束时间(包含)
timezone (datetime.tzinfo 或str)	指定时区

from apscheduler.schedulers.background import BackgroundScheduler

def scheduler_test():
    print('定时任务触发')

# BackgroundScheduler() 调度器在后台执行，不会阻塞当前进程。
scheduler = BackgroundScheduler()
try:
    # 添加定时任务，第一个参数为需要定时执行的任务，'cron'定时任务类型，每天0点，30分执行一次，任务id为test。
	scheduler.add_job(scheduler_test, 'cron', hour=0, minute=30, id='test', replace_existing=True, timezone='Asia/Shanghai')
    
    # 每天9点-17点，每10分钟执行一次。
    # scheduler.add_job(create_article_index, 'cron', hour='9-17', minute='0/10', id='create_article_index',
    #                   replace_existing=True, timezone='Asia/Shanghai')
    
    # 启动定时任务
	scheduler.start()
except Exception as e:
    print(e)
    # 停止定时任务
    scheduler.shutdown()

interval定时器

参数	解释
weeks (int)	间隔几周
days (int)	间隔几天
hours (int)	间隔几小时
minutes (int)	间隔几分钟
seconds (int)	间隔多少秒
start_date (datetime 或 str)	开始日期
end_date (datetime 或 str)	结束日期
timezone (datetime.tzinfo 或str)	时区

from apscheduler.schedulers.background import BackgroundScheduler

def scheduler_test():
    print('定时任务触发')

# BackgroundScheduler() 调度器在后台执行，不会阻塞当前进程。
scheduler = BackgroundScheduler()
try:
# 添加定时任务，第一个参数为需要定时执行的任务，'interval'定时任务类型，每隔900秒执行一次，任务id为test。
	scheduler.add_job(scheduler_test, 'interval', seconds=900, id='test', replace_existing=True, timezone='Asia/Shanghai')
    # 启动定时任务
	scheduler.start()
except Exception as e:
    print(e)
    # 停止定时任务
    scheduler.shutdown()

date定时器

参数	解释
run_date (datetime 或 str)	作业的运行日期或时间
timezone (datetime.tzinfo 或 str)	指定时区

from apscheduler.schedulers.background import BackgroundScheduler

def scheduler_test():
    print('定时任务触发')

# BackgroundScheduler() 调度器在后台执行，不会阻塞当前进程。
scheduler = BackgroundScheduler()
try:
# 添加定时任务，第一个参数为需要定时执行的任务，'interval'定时任务类型，2023年7月31日执行一次，任务id为test。
	scheduler.add_job(scheduler_test, 'date', run_date=date(2023, 7, 31), id='test', replace_existing=True，timezone='Asia/Shanghai')
    # 启动定时任务
	scheduler.start()
except Exception as e:
    print(e)
    # 停止定时任务
    scheduler.shutdown()

其他操作

# 删除定时任务
scheduler.remove_job(job_id)
# 暂停定时任务
scheduler.pause_job(job_id)
# 开启定时任务
scheduler.resume_job(job_id)
# 修改定时任务
scheduler.modify_job(job_id)
# 获取所有定时任务
scheduler.get_jobs()