mldong 快速开发框架定时任务模块设计与实现mldong 快速开发框架是一款基于 Spring Boot 的高效开发

mldong 快速开发框架是一款基于 Spring Boot 的高效开发工具，其中的定时任务模块是其核心功能之一。本文将详细介绍该模块的设计理念、架构组成以及关键代码实现，并结合前端页面截图展示其实际应用效果。

一、模块概述

定时任务模块旨在提供一个灵活、可扩展的调度机制，支持动态配置任务执行周期、状态管理及任务立即执行等功能。通过集成 Redis 锁机制，确保了分布式环境下的任务调度一致性，避免重复执行问题。

主要功能：

定时任务注册与启动
任务状态管理（运行/停止）
任务调度表达式动态修改
任务立即执行
任务信息缓存与持久化

二、架构设计

整个模块采用接口驱动 + 注解增强 + AOP 切面 + 缓存管理的方式构建，主要包括以下几个核心组件：

1. TimerTaskRunner 接口

所有定时任务类必须实现此接口，定义如下：

public interface TimerTaskRunner {
    void action();
    String getCron();
    boolean isXxlJob();
    String getName();
}

示例：RefreshConstantsTaskRunner 实现了该接口，用于刷新常量缓存。

2. `@TimerLock` 注解与切面

通过 @TimerLock 注解对任务方法加锁，防止并发执行：

@Aspect
@Component
@Order(120)
@Slf4j
public class TimerLockAop {
    @Around("@annotation(timerLock)")
    public void doAction(ProceedingJoinPoint proceedingJoinPoint, TimerLock timerLock) throws Throwable {
        boolean enable = RedisUtil.lock("TimerLock:" + timerLock.name(), StrUtil.uuid(), timerLock.autoReleaseTime(), timerLock.timeUnit());
        if (enable) {
            proceedingJoinPoint.proceed();
        }
    }

    @AfterThrowing("@annotation(timerLock)")
    @After("@annotation(timerLock)")
    public void doActionAfter(TimerLock timerLock) {
        RedisUtil.releaseLock("TimerLock:" + timerLock.name());
    }
}

3. `TimerCache` 缓存管理

继承自 AbstractRedisCacheOperator<TimerModel>，负责任务模型在 Redis 中的缓存操作。

public class TimerCache extends AbstractRedisCacheOperator<TimerModel> {
    public TimerCache(RedisTemplate<String, TimerModel> redisTemplate) {
        super(redisTemplate);
    }

    @Override
    public String getCommonKeyPrefix() {
        return "timers:";
    }
}

4. `TimerModel` 模型

封装任务元数据，包括任务名称、执行类、cron 表达式、状态等。

@Data
public class TimerModel implements Serializable {
    private String id;
    private String timerName;
    private String actionClass;
    private String cron;
    private String redisCron;
    private Integer state;
    private String remark;

    public TimerModel build(TimerTaskRunner timerTaskRunner) {
        this.setTimerName(timerTaskRunner.getClass().getSimpleName());
        this.setActionClass(timerTaskRunner.getClass().getName());
        this.setCron(timerTaskRunner.getCron());
        this.setRedisCron(timerTaskRunner.getCron());
        this.setState(TimerStateEnum.RUNNING.getCode());
        this.setRemark(timerTaskRunner.getName());
        return this;
    }
}

5. `TimerTaskRunListener` 启动监听器

项目启动时加载所有 TimerTaskRunner 实现类，并初始化定时任务。

public class TimerTaskRunListener implements ApplicationListener<ApplicationStartedEvent>, Ordered {
    @Override
    public void onApplicationEvent(ApplicationStartedEvent event) {
        TimerCache timerCache = SpringUtil.getBean(TimerCache.class);
        Map<String, TimerTaskRunner> timerTaskRunnerMap = SpringUtil.getBeansOfType(TimerTaskRunner.class);

        timerTaskRunnerMap.forEach((name, timerTaskRunner) -> {
            if (!timerTaskRunner.isXxlJob() && StrUtil.isNotEmpty(timerTaskRunner.getCron())) {
                TimerModel timerModel = timerCache.get(timerTaskRunner.getClass().getSimpleName());
                if (timerModel == null) {
                    timerModel = new TimerModel().build(timerTaskRunner);
                } else {
                    timerModel.setCron(timerTaskRunner.getCron());
                }
                timerCache.put(timerTaskRunner.getClass().getSimpleName(), timerModel);

                if (ObjectUtil.equals(timerModel.getState(), TimerStateEnum.RUNNING.getCode())) {
                    Task task = timerTaskRunner::action;
                    CronUtil.schedule(timerModel.getId(), timerModel.getRedisCron(), task);
                }
            }
        });

        CronUtil.setMatchSecond(true);
        CronUtil.start();
    }

    @Override
    public int getOrder() {
        return LOWEST_PRECEDENCE;
    }
}

三、控制层设计

TimerController 提供 RESTful API 接口，用于任务的启停、修改、查询等操作。

@RestController
@Api(tags = "定时任务管理")
@RequiredArgsConstructor
public class TimerController {
    private final TimerService timerService;

    @PostMapping("/sys/timer/stop")
    @ApiOperation(value = "停止定时任务")
    @SaCheckPermission("sys:timer:stop")
    public CommonResult<?> stop(@RequestBody Dict param) {
        timerService.stop(param.get("id", param.getStr("name")));
        return CommonResult.ok();
    }

    @PostMapping("/sys/timer/start")
    @ApiOperation(value = "开始定时任务")
    @SaCheckPermission("sys:timer:start")
    public CommonResult<?> start(@RequestBody Dict param) {
        timerService.start(param.get("id", param.getStr("name")));
        return CommonResult.ok();
    }

    // 其他接口略...
}

四、服务层实现

TimerServiceImpl 是 TimerService 接口的具体实现类，负责调用底层 Hutool Cron 工具和 Redis 缓存。

@Service
@RequiredArgsConstructor
public class TimerServiceImpl implements TimerService {
    private final Map<String, TimerTaskRunner> timerTaskRunnerMap;
    private final TimerCache timerCache;

    @Override
    public void stop(String name) {
        TimerTaskRunner timerTaskRunner = getTimerTaskRunner(name);
        if (timerTaskRunner == null) return;
        String timerId = timerTaskRunner.getClass().getSimpleName();
        CronUtil.remove(timerId);
        TimerModel timerModel = timerCache.get(timerId);
        if (timerModel != null) {
            timerModel.setState(TimerStateEnum.STOP.getCode());
            timerCache.put(timerModel.getId(), timerModel);
        }
    }

    @Override
    public void start(String name) {
        Task task = CronUtil.getScheduler().getTask(name);
        TimerTaskRunner timerTaskRunner = getTimerTaskRunner(name);
        if (task == null && timerTaskRunner != null) {
            TimerModel timerModel = timerCache.get(timerTaskRunner.getClass().getSimpleName());
            if (timerModel == null) {
                timerModel = new TimerModel().build(timerTaskRunner);
            } else {
                timerModel.setState(TimerStateEnum.RUNNING.getCode());
                timerCache.put(timerModel.getId(), timerModel);
            }
            task = timerTaskRunner::action;
            CronUtil.schedule(timerModel.getId(), timerModel.getRedisCron(), task);
        }
    }

    // 其他方法略...
}