perf: 优化定时任务模块service层及异常处理

ruoyi-fastapi-backend/config/get_scheduler.py

@@ -1,4 +1,5 @@
 import json
+import re
 from apscheduler.events import EVENT_ALL
 from apscheduler.executors.pool import ThreadPoolExecutor, ProcessPoolExecutor
 from apscheduler.schedulers.background import BackgroundScheduler
@@ -9,10 +10,12 @@ from apscheduler.triggers.cron import CronTrigger
 from datetime import datetime, timedelta
 from sqlalchemy.engine import create_engine
 from sqlalchemy.orm import sessionmaker
+from typing import Union
 from config.database import AsyncSessionLocal, quote_plus
 from config.env import DataBaseConfig, RedisConfig
+from exceptions.exception import ServiceException
 from module_admin.dao.job_dao import JobDao
-from module_admin.entity.vo.job_vo import JobLogModel
+from module_admin.entity.vo.job_vo import JobLogModel, JobModel
 from module_admin.service.job_log_service import JobLogService
 from utils.log_util import logger
 import module_task  # noqa: F401
@@ -21,7 +24,7 @@ import module_task  # noqa: F401
 # 重写Cron定时
 class MyCronTrigger(CronTrigger):
     @classmethod
-    def from_crontab(cls, expr, timezone=None):
+    def from_crontab(cls, expr: str, timezone=None):
         values = expr.split()
         if len(values) != 6 and len(values) != 7:
             raise ValueError('Wrong number of fields; got {}, expected 6 or 7'.format(len(values)))
@@ -62,7 +65,7 @@ class MyCronTrigger(CronTrigger):
         )
 
     @classmethod
-    def __find_recent_workday(cls, day):
+    def __find_recent_workday(cls, day: int):
         now = datetime.now()
         date = datetime(now.year, now.month, day)
         if date.weekday() < 5:
@@ -144,7 +147,7 @@ class SchedulerUtil:
         logger.info('关闭定时任务成功')
 
     @classmethod
-    def get_scheduler_job(cls, job_id):
+    def get_scheduler_job(cls, job_id: Union[str, int]):
         """
         根据任务id获取任务对象
 
@@ -156,7 +159,7 @@ class SchedulerUtil:
         return query_job
 
     @classmethod
-    def add_scheduler_job(cls, job_info):
+    def add_scheduler_job(cls, job_info: JobModel):
         """
         根据输入的任务对象信息添加任务
 
@@ -178,7 +181,7 @@ class SchedulerUtil:
         )
 
     @classmethod
-    def execute_scheduler_job_once(cls, job_info):
+    def execute_scheduler_job_once(cls, job_info: JobModel):
         """
         根据输入的任务对象执行一次任务
 
@@ -201,7 +204,7 @@ class SchedulerUtil:
         )
 
     @classmethod
-    def remove_scheduler_job(cls, job_id):
+    def remove_scheduler_job(cls, job_id: Union[str, int]):
         """
         根据任务id移除任务
 
@@ -210,6 +213,160 @@ class SchedulerUtil:
         """
         scheduler.remove_job(job_id=str(job_id))
 
+    @classmethod
+    def __valid_range(cls, search_str: str, start_range: int, end_range: int):
+        match = re.match(r'^(\d+)-(\d+)$', search_str)
+        if match:
+            start, end = int(match.group(1)), int(match.group(2))
+            return start_range <= start < end <= end_range
+        return False
+
+    @classmethod
+    def __valid_sum(
+        cls, search_str: str, start_range_a: int, start_range_b: int, end_range_a: int, end_range_b: int, sum_range: int
+    ):
+        match = re.match(r'^(\d+)/(\d+)$', search_str)
+        if match:
+            start, end = int(match.group(1)), int(match.group(2))
+            return (
+                start_range_a <= start <= start_range_b
+                and end_range_a <= end <= end_range_b
+                and start + end <= sum_range
+            )
+        return False
+
+    @classmethod
+    def __validate_second_or_minute(cls, second_or_minute: str):
+        """
+        校验秒或分钟值是否正确
+
+        :param second_or_minute: 秒或分钟值
+        :return: 校验结果
+        """
+        if (
+            second_or_minute == '*'
+            or ('-' in second_or_minute and cls.__valid_range(second_or_minute, 0, 59))
+            or ('/' in second_or_minute and cls.__valid_sum(second_or_minute, 0, 58, 1, 59))
+            or re.match(r'^(?:[0-5]?\d|59)(?:,[0-5]?\d|59)*$', second_or_minute)
+        ):
+            return True
+        return False
+
+    @classmethod
+    def __validate_hour(cls, hour: str):
+        """
+        校验小时值是否正确
+        :param hour: 小时值
+        :return: 校验结果
+        """
+        if (
+            hour == '*'
+            or ('-' in hour and cls.__valid_range(hour, 0, 23))
+            or ('/' in hour and cls.__valid_sum(hour, 0, 22, 1, 23, 23))
+            or re.match(r'^(?:0|[1-9]|1\d|2[0-3])(?:,(?:0|[1-9]|1\d|2[0-3]))*$', hour)
+        ):
+            return True
+        return False
+
+    @classmethod
+    def __validate_day(cls, day: str):
+        """
+        校验日值是否正确
+        :param day: 日值
+        :return: 校验结果
+        """
+        if (
+            day in ['*', '?', 'L']
+            or ('-' in day and cls.__valid_range(day, 1, 31))
+            or ('/' in day and cls.__valid_sum(day, 1, 30, 1, 30, 31))
+            or ('W' in day and re.match(r'^(?:[1-9]|1\d|2\d|3[01])W$', day))
+            or re.match(r'^(?:0|[1-9]|1\d|2[0-9]|3[0-1])(?:,(?:0|[1-9]|1\d|2[0-9]|3[0-1]))*$', day)
+        ):
+            return True
+        return False
+
+    @classmethod
+    def __validate_month(cls, month: str):
+        """
+        校验月值是否正确
+        :param month: 月值
+        :return: 校验结果
+        """
+        if (
+            month == '*'
+            or ('-' in month and cls.__valid_range(month, 1, 12))
+            or ('/' in month and cls.__valid_sum(month, 1, 11, 1, 11, 12))
+            or re.match(r'^(?:0|[1-9]|1[0-2])(?:,(?:0|[1-9]|1[0-2]))*$', month)
+        ):
+            return True
+        return False
+
+    @classmethod
+    def __validate_week(cls, week: str):
+        """
+        校验周值是否正确
+        :param week: 周值
+        :return: 校验结果
+        """
+        if (
+            week in ['*', '?']
+            or ('-' in week and cls.__valid_range(week, 1, 7))
+            or re.match(r'^[1-7]#[1-4]$', week)
+            or re.match(r'^[1-7]L$', week)
+            or re.match(r'^[1-7](?:(,[1-7]))*$', week)
+        ):
+            return True
+        return False
+
+    @classmethod
+    def __validate_year(cls, year: str):
+        """
+        校验年值是否正确
+        :param year: 年值
+        :return: 校验结果
+        """
+        current_year = int(datetime.now().year)
+        if (
+            year == '*'
+            or ('-' in year and cls.__valid_range(year, current_year, 2099))
+            or ('/' in year and cls.__valid_sum(year, current_year, 2098, 1, 2099 - current_year, 2099))
+            or re.match(r'^[1-7]#[1-4]$', year)
+            or re.match(r'^[1-7]L$', year)
+        ):
+            return True
+        return False
+
+    @classmethod
+    def validate_cron_expression(cls, cron_expression: str):
+        """
+        校验Cron表达式是否正确
+
+        :param cron_expression: Cron表达式
+        :return: 校验结果
+        """
+        values = cron_expression.split()
+        if len(values) != 6 and len(values) != 7:
+            return False
+        second_validation = cls.__validate_second_or_minute(values[0])
+        minute_validation = cls.__validate_second_or_minute(values[1])
+        hour_validation = cls.__validate_hour(values[2])
+        day_validation = cls.__validate_day(values[3])
+        month_validation = cls.__validate_month(values[4])
+        week_validation = cls.__validate_week(values[5])
+        validation = (
+            second_validation
+            and minute_validation
+            and hour_validation
+            and day_validation
+            and month_validation
+            and week_validation
+        )
+        if len(values) == 6:
+            return validation
+        if len(values) == 7:
+            year_validation = cls.__validate_year(values[6])
+            return validation and year_validation
+
     @classmethod
     def scheduler_event_listener(cls, event):
         # 获取事件类型和任务ID