前缀
在最近的fastapi学习过程中,需要使用定时任务,这里就用到了APScheduler,它的使用在之前也写到了,这篇就将它结合到自己的fastapi项目中进行使用
一、创建Crontab定时任务的app
1. 创建文件
2. 定义model
# apps/Crontab/models.py
from tortoise import models, fields
class CronJob(models.Model):
id = fields.IntField(pk=True)
name = fields.CharField(max_length=50, description='任务名称')
project = fields.ForeignKeyField('models.Project', related_name='cronjob', description='所属项目')
env = fields.ForeignKeyField('models.Env', related_name='cronjob', description='所属环境')
create_time = fields.DatetimeField(verbose_name='创建时间', help_text='创建时间', auto_now_add=True)
task = fields.ForeignKeyField('models.TestTask', related_name='cronjob', description='关联任务')
state = fields.BooleanField(default=True, description="是否启用")
run_type = fields.CharField(max_length=10, choices=['Interval', 'date', 'crontab'], description="任务类型")
interval = fields.IntField(default=60, description="执行间隔时间")
date = fields.DatetimeField(default='2030-01-01 00:00:00', description="指定执行的事件")
crontab = fields.JSONField(default={
'second': '30', 'minute': '*', 'hour': '*', 'day': '*', 'month': '*', 'day_of_week': '*'},
description="周期性任务规则")
class Meta:
table = "crontab"
table_description = "定时任务表"
3. 定义api
首先先准备好Apscheduler相关的东西
# apps/Crontab/api.py
import datetime
import time
import pytz
from common.settings import REDIS_CONFIG
from fastapi import APIRouter, HTTPException
from .schemas import CornJobFrom, UpdagteCornJobFrom
from apps.Crontab.models import CronJob
from apps.TestTask.models import TestTask
from apps.projects.models import Env, Project
from tortoise import transactions
from apscheduler.schedulers.asyncio import AsyncIOScheduler
from apscheduler.triggers.interval import IntervalTrigger
from apscheduler.triggers.date import DateTrigger
from apscheduler.triggers.cron import CronTrigger
from apscheduler.jobstores.redis import RedisJobStore
from ..TestTask.api import run_task
from ..TestTask.schemas import RunTaskForm
router = APIRouter(prefix='/api/crontab')
local_timezone = pytz.timezone('Asia/Shanghai')