代码调整

pqs-system/system-boot/src/main/java/com/njcn/system/controller/TimersController.java

@@ -0,0 +1,168 @@
+package com.njcn.system.controller;
+
+import cn.hutool.core.collection.CollectionUtil;
+import cn.hutool.core.util.StrUtil;
+import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
+import com.njcn.common.pojo.annotation.OperateInfo;
+import com.njcn.common.pojo.constant.OperateType;
+import com.njcn.common.pojo.enums.common.LogEnum;
+import com.njcn.common.pojo.enums.response.CommonResponseEnum;
+import com.njcn.common.pojo.response.HttpResult;
+import com.njcn.common.utils.HttpResultUtil;
+import com.njcn.common.utils.LogUtil;
+import com.njcn.system.pojo.param.TimersParam;
+import com.njcn.system.pojo.vo.TimersVO;
+import com.njcn.system.service.ITimersService;
+import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiImplicitParam;
+import io.swagger.annotations.ApiOperation;
+import lombok.AllArgsConstructor;
+import lombok.extern.slf4j.Slf4j;
+import org.springframework.validation.annotation.Validated;
+import org.springframework.web.bind.annotation.*;
+
+import com.njcn.web.controller.BaseController;
+
+import java.util.List;
+
+/**
+ * <p>
+ * 定时任务 前端控制器
+ * </p>
+ *
+ * @author hongawen
+ * @since 2023-12-05
+ */
+@Slf4j
+@RestController
+@RequestMapping("/timer")
+@Api(tags = "定时任务管理中心")
+@AllArgsConstructor
+public class TimersController extends BaseController {
+
+
+    private final ITimersService timersService;
+
+    /**
+     * 分页查询定时任务
+     *
+     * @author hongawen
+     */
+    @PostMapping("/list")
+    @OperateInfo(info = LogEnum.SYSTEM_COMMON)
+    @ApiOperation("查询定时任务")
+    @ApiImplicitParam(name = "timersParam", value = "查询参数", required = true)
+    public HttpResult<Page<TimersVO>> list(@RequestBody TimersParam timersParam) {
+        String methodDescribe = getMethodDescribe("list");
+        Page<TimersVO> result = timersService.listTimer(timersParam);
+        return HttpResultUtil.assembleCommonResponseResult(CommonResponseEnum.SUCCESS, result, methodDescribe);
+    }
+
+    /**
+     * 添加定时任务
+     *
+     * @author hongawen
+     */
+    @PostMapping("/add")
+    @ApiOperation("新增定时任务")
+    @OperateInfo(info = LogEnum.SYSTEM_COMMON, operateType = OperateType.ADD)
+    @ApiImplicitParam(name = "timersParam", value = "定时任务信息", required = true)
+    public HttpResult<Object> add(@RequestBody TimersParam timersParam) {
+        String methodDescribe = getMethodDescribe("add");
+        boolean flag = timersService.addTimer(timersParam);
+        if (flag) {
+            return HttpResultUtil.assembleCommonResponseResult(CommonResponseEnum.SUCCESS, null, methodDescribe);
+        } else {
+            return HttpResultUtil.assembleCommonResponseResult(CommonResponseEnum.FAIL, null, methodDescribe);
+        }
+    }
+
+    /**
+     * 编辑定时任务
+     *
+     * @author hongawen
+     */
+    @OperateInfo(info = LogEnum.SYSTEM_COMMON, operateType = OperateType.UPDATE)
+    @PostMapping("/update")
+    @ApiOperation("修改定时任务")
+    @ApiImplicitParam(name = "timersParam", value = "定时任务信息", required = true)
+    public HttpResult<Object> update(@RequestBody @Validated TimersParam timersParam) {
+        String methodDescribe = getMethodDescribe("update");
+        boolean flag = timersService.editTimer(timersParam);
+        if (flag) {
+            return HttpResultUtil.assembleCommonResponseResult(CommonResponseEnum.SUCCESS, null, methodDescribe);
+        } else {
+            return HttpResultUtil.assembleCommonResponseResult(CommonResponseEnum.FAIL, null, methodDescribe);
+        }
+    }
+
+
+    /**
+     * 删除定时任务
+     *
+     * @author hongawen
+     */
+    @PostMapping("/delete")
+    @OperateInfo(info = LogEnum.SYSTEM_COMMON, operateType = OperateType.UPDATE)
+    @ApiOperation("删除定时任务")
+    @ApiImplicitParam(name = "ids", value = "id集合", required = true, dataTypeClass = List.class)
+    public HttpResult<Object> delete(@RequestBody List<String> ids) {
+        String methodDescribe = getMethodDescribe("delete");
+        LogUtil.njcnDebug(log, "{}，任务ID数据为：{}", methodDescribe, String.join(StrUtil.COMMA, ids));
+        boolean result = timersService.deleteTimers(ids);
+        if (result) {
+            return HttpResultUtil.assembleCommonResponseResult(CommonResponseEnum.SUCCESS, null, methodDescribe);
+        } else {
+            return HttpResultUtil.assembleCommonResponseResult(CommonResponseEnum.FAIL, null, methodDescribe);
+        }
+    }
+
+
+    /**
+     * 获取系统的所有任务列表
+     *
+     * @author hongawen
+     */
+    @OperateInfo(info = LogEnum.SYSTEM_COMMON)
+    @GetMapping("/getActionClasses")
+    @ApiOperation("获取所有任务列表")
+    public HttpResult<List<String>> getActionClasses() {
+        String methodDescribe = getMethodDescribe("getActionClasses");
+        List<String> actionClasses = timersService.getActionClasses();
+        if (CollectionUtil.isNotEmpty(actionClasses)) {
+            return HttpResultUtil.assembleCommonResponseResult(CommonResponseEnum.SUCCESS, actionClasses, methodDescribe);
+        } else {
+            return HttpResultUtil.assembleCommonResponseResult(CommonResponseEnum.FAIL, null, methodDescribe);
+        }
+    }
+
+    /**
+     * 启动定时任务
+     *
+     * @author hongawen
+     */
+    @OperateInfo(info = LogEnum.SYSTEM_COMMON, operateType = OperateType.UPDATE)
+    @GetMapping("/start")
+    @ApiOperation("启动定时任务")
+    public HttpResult<Object> start(String id) {
+        String methodDescribe = getMethodDescribe("start");
+        timersService.start(id);
+        return HttpResultUtil.assembleCommonResponseResult(CommonResponseEnum.SUCCESS, null, methodDescribe);
+    }
+
+    /**
+     * 停止定时任务
+     *
+     * @author hongawen
+     */
+    @OperateInfo(info = LogEnum.SYSTEM_COMMON, operateType = OperateType.UPDATE)
+    @GetMapping("/stop")
+    @ApiOperation("关闭定时任务")
+    public HttpResult<Object> stop(String id) {
+        String methodDescribe = getMethodDescribe("stop");
+        timersService.stop(id);
+        return HttpResultUtil.assembleCommonResponseResult(CommonResponseEnum.SUCCESS, null, methodDescribe);
+    }
+
+}
+

pqs-system/system-boot/src/main/java/com/njcn/system/mapper/TimersMapper.java

@@ -0,0 +1,22 @@
+package com.njcn.system.mapper;
+
+import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
+import com.baomidou.mybatisplus.core.mapper.BaseMapper;
+import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
+import com.njcn.system.pojo.po.Timers;
+import com.njcn.system.pojo.vo.DictDataVO;
+import com.njcn.system.pojo.vo.TimersVO;
+import org.apache.ibatis.annotations.Param;
+
+/**
+ * <p>
+ * 定时任务 Mapper 接口
+ * </p>
+ *
+ * @author hongawen
+ * @since 2023-12-05
+ */
+public interface TimersMapper extends BaseMapper<Timers> {
+
+    Page<TimersVO> page(@Param("page") Page<TimersVO> page, @Param("ew") QueryWrapper<TimersVO> queryWrapper);
+}

pqs-system/system-boot/src/main/java/com/njcn/system/mapper/mapping/TimersMapper.xml

@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
+<mapper namespace="com.njcn.system.mapper.TimersMapper">
+
+    <!--获取字典分页列表-->
+    <select id="page" resultType="TimersVO">
+        SELECT sys_timers.*
+        FROM sys_timers sys_timers
+        WHERE ${ew.sqlSegment}
+    </select>
+
+</mapper>

pqs-system/system-boot/src/main/java/com/njcn/system/service/ITimersService.java

@@ -0,0 +1,34 @@
+package com.njcn.system.service;
+
+import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
+import com.baomidou.mybatisplus.extension.service.IService;
+import com.njcn.system.pojo.param.TimersParam;
+import com.njcn.system.pojo.po.Timers;
+import com.njcn.system.pojo.vo.TimersVO;
+
+import java.util.List;
+
+/**
+ * <p>
+ * 定时任务 服务类
+ * </p>
+ *
+ * @author hongawen
+ * @since 2023-12-05
+ */
+public interface ITimersService extends IService<Timers> {
+
+    Page<TimersVO> listTimer(TimersParam queryParam);
+
+    boolean addTimer(TimersParam timersParam);
+
+    boolean editTimer(TimersParam timersParam);
+
+    boolean deleteTimers(List<String> ids);
+
+    List<String> getActionClasses();
+
+    void start(String id);
+
+    void stop(String id);
+}

pqs-system/system-boot/src/main/java/com/njcn/system/service/impl/TimersServiceImpl.java

@@ -0,0 +1,142 @@
+package com.njcn.system.service.impl;
+
+import cn.hutool.core.bean.BeanUtil;
+import cn.hutool.core.collection.CollectionUtil;
+import cn.hutool.core.util.ObjectUtil;
+import cn.hutool.core.util.StrUtil;
+import cn.hutool.extra.spring.SpringUtil;
+import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
+import com.baomidou.mybatisplus.core.conditions.update.LambdaUpdateWrapper;
+import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
+import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;
+import com.njcn.common.pojo.enums.common.DataStateEnum;
+import com.njcn.common.pojo.exception.BusinessException;
+import com.njcn.db.constant.DbConstant;
+import com.njcn.system.enums.SystemResponseEnum;
+import com.njcn.system.mapper.TimersMapper;
+import com.njcn.system.pojo.enums.TimerJobStatusEnum;
+import com.njcn.system.pojo.param.TimersParam;
+import com.njcn.system.pojo.po.DictData;
+import com.njcn.system.pojo.po.Timers;
+import com.njcn.system.pojo.vo.DictDataVO;
+import com.njcn.system.pojo.vo.TimersVO;
+import com.njcn.system.service.ITimersService;
+import com.njcn.system.timer.TimerExeService;
+import com.njcn.system.timer.TimerTaskRunner;
+import com.njcn.web.factory.PageFactory;
+import lombok.RequiredArgsConstructor;
+import org.springframework.stereotype.Service;
+import org.springframework.transaction.annotation.Transactional;
+
+import java.util.Collection;
+import java.util.List;
+import java.util.Map;
+import java.util.stream.Collectors;
+
+/**
+ * <p>
+ * 定时任务 服务实现类
+ * </p>
+ *
+ * @author hongawen
+ * @since 2023-12-05
+ */
+@Service
+@RequiredArgsConstructor
+public class TimersServiceImpl extends ServiceImpl<TimersMapper, Timers> implements ITimersService {
+
+    private final TimerExeService timerExeService;
+
+    @Override
+    public Page<TimersVO> listTimer(TimersParam queryParam) {
+        QueryWrapper<TimersVO> queryWrapper = new QueryWrapper<>();
+        if (ObjectUtil.isNotNull(queryParam)) {
+            //查询参数不为空，进行条件填充
+            if (StrUtil.isNotBlank(queryParam.getSearchValue())) {
+                //定时任务，待提供名称、编码模糊查询 todo...
+
+            }
+        }
+        queryWrapper.orderBy(true, true, "sys_timers.create_time");
+        queryWrapper.ne("sys_timers.state", DataStateEnum.DELETED.getCode());
+        //初始化分页数据
+        return this.baseMapper.page(new Page<>(PageFactory.getPageNum(queryParam), PageFactory.getPageSize(queryParam)), queryWrapper);
+    }
+
+    @Override
+    public boolean addTimer(TimersParam timersParam) {
+        Timers timers = new Timers();
+        BeanUtil.copyProperties(timersParam, timers);
+        //默认为正常状态
+        timers.setState(DataStateEnum.ENABLE.getCode());
+        return this.save(timers);
+    }
+
+    @Override
+    public boolean editTimer(TimersParam timersParam) {
+        Timers timers = new Timers();
+        BeanUtil.copyProperties(timersParam, timers);
+        return this.updateById(timers);
+    }
+
+    @Override
+    public boolean deleteTimers(List<String> ids) {
+        return this.lambdaUpdate()
+                .set(Timers::getState, DataStateEnum.DELETED.getCode())
+                .in(Timers::getId, ids)
+                .update();
+    }
+
+    @Override
+    public List<String> getActionClasses() {
+        Map<String, TimerTaskRunner> timerTaskRunnerMap = SpringUtil.getBeansOfType(TimerTaskRunner.class);
+        if (ObjectUtil.isNotEmpty(timerTaskRunnerMap)) {
+            Collection<TimerTaskRunner> values = timerTaskRunnerMap.values();
+            return values.stream().map(i -> i.getClass().getName()).collect(Collectors.toList());
+        } else {
+            return CollectionUtil.newArrayList();
+        }
+    }
+
+    @Transactional(rollbackFor = Exception.class)
+    @Override
+    public void start(String id) {
+        // 更新库中的状态
+        LambdaUpdateWrapper<Timers> wrapper = new LambdaUpdateWrapper<>();
+        wrapper.set(Timers::getJobStatus, TimerJobStatusEnum.RUNNING.getCode())
+                .eq(Timers::getId,id);
+        this.update(wrapper);
+
+        // 添加定时任务调度
+        Timers sysTimers = this.queryTimers(id);
+        timerExeService.startTimer(sysTimers.getId(), sysTimers.getCron(), sysTimers.getActionClass());
+    }
+
+    @Transactional(rollbackFor = Exception.class)
+    @Override
+    public void stop(String id) {
+        // 更新库中的状态
+        LambdaUpdateWrapper<Timers> wrapper = new LambdaUpdateWrapper<>();
+        wrapper.set(Timers::getJobStatus, TimerJobStatusEnum.STOP.getCode())
+                .eq(Timers::getId, id);
+        this.update(wrapper);
+        // 关闭定时任务调度
+        Timers sysTimers = this.queryTimers(id);
+        timerExeService.stopTimer(sysTimers.getId());
+    }
+
+    /**
+     * 获取定时任务
+     *
+     * @author hongawen
+     * @date 2020/6/30 18:26
+     */
+    private Timers queryTimers(String id) {
+        Timers timers = this.getById(id);
+        if (ObjectUtil.isEmpty(timers)) {
+            throw new BusinessException(SystemResponseEnum.NOT_EXISTED);
+        }
+        return timers;
+    }
+
+}

pqs-system/system-boot/src/main/java/com/njcn/system/timer/TimerExeService.java

@@ -0,0 +1,35 @@
+
+package com.njcn.system.timer;
+
+import com.njcn.system.pojo.param.TimersParam;
+
+/**
+ * 本接口用来，屏蔽定时任务的多样性
+ * 目前用hutool
+ * @author hongawen
+ */
+public interface TimerExeService {
+
+    /**
+     * 启动一个定时器
+     * <p>
+     * 定时任务表达式书写规范：0/2 * * * * *
+     * <p>
+     * 六位数，分别是：秒 分 小时 日 月 年
+     *
+     * @param taskId    任务id
+     * @param cron      cron表达式
+     * @param className 类的全名，必须是TimerTaskRunner的子类
+     * @author hongawen
+     */
+    void startTimer(String taskId, String cron, String className);
+
+    /**
+     * 停止一个定时器
+     *
+     * @param taskId 定时任务Id
+     * @author hongawen
+     */
+    void stopTimer(String taskId);
+
+}

pqs-system/system-boot/src/main/java/com/njcn/system/timer/TimerTaskInitListener.java

@@ -0,0 +1,55 @@
+
+package com.njcn.system.timer;
+
+import cn.hutool.cron.CronUtil;
+import cn.hutool.extra.spring.SpringUtil;
+import com.baomidou.mybatisplus.core.conditions.query.LambdaQueryWrapper;
+import com.baomidou.mybatisplus.extension.conditions.query.LambdaQueryChainWrapper;
+import com.njcn.common.pojo.enums.common.DataStateEnum;
+import com.njcn.system.pojo.enums.TimerJobStatusEnum;
+import com.njcn.system.pojo.param.TimersParam;
+import com.njcn.system.pojo.po.Timers;
+import com.njcn.system.service.ITimersService;
+import org.springframework.boot.ApplicationArguments;
+import org.springframework.boot.ApplicationRunner;
+import org.springframework.core.Ordered;
+import org.springframework.stereotype.Component;
+
+import java.util.List;
+
+/**
+ * @author : hongawen
+ */
+@Component
+public class TimerTaskInitListener implements ApplicationRunner, Ordered {
+
+    /**
+     *
+     * @param args incoming application arguments
+     */
+    @Override
+    public void run(ApplicationArguments args) {
+        ITimersService sysTimersService = SpringUtil.getBean(ITimersService.class);
+        TimerExeService timerExeService = SpringUtil.getBean(TimerExeService.class);
+        // 获取所有开启状态的任务
+        LambdaQueryWrapper<Timers> lambdaQueryChainWrapper = new LambdaQueryWrapper<>();
+        lambdaQueryChainWrapper.eq(Timers::getJobStatus,TimerJobStatusEnum.RUNNING.getCode())
+                .ne(Timers::getState, DataStateEnum.DELETED.getCode());
+        List<Timers> list = sysTimersService.list(lambdaQueryChainWrapper);
+        // 添加定时任务到调度器
+        for (Timers sysTimers : list) {
+            timerExeService.startTimer(String.valueOf(sysTimers.getId()), sysTimers.getCron(), sysTimers.getActionClass());
+        }
+
+        // 设置秒级别的启用
+        CronUtil.setMatchSecond(true);
+
+        // 启动定时器执行器
+        CronUtil.start();
+    }
+
+    @Override
+    public int getOrder() {
+        return LOWEST_PRECEDENCE-10;
+    }
+}

pqs-system/system-boot/src/main/java/com/njcn/system/timer/TimerTaskRunner.java

@@ -0,0 +1,19 @@
+
+package com.njcn.system.timer;
+
+/**
+ * 定时器执行者
+ * <p>
+ * 定时器都要实现本接口，并需要把实现类加入到spring容器中
+ *
+ */
+public interface TimerTaskRunner {
+
+    /**
+     * 任务执行的具体内容
+     *
+     * @author hongawen
+     */
+    void action();
+
+}

pqs-system/system-boot/src/main/java/com/njcn/system/timer/impl/HutoolTimerExeServiceImpl.java

@@ -0,0 +1,59 @@
+
+package com.njcn.system.timer.impl;
+
+import cn.hutool.core.util.ObjectUtil;
+import cn.hutool.cron.CronUtil;
+import cn.hutool.cron.task.Task;
+import cn.hutool.extra.spring.SpringUtil;
+import cn.hutool.log.Log;
+import cn.hutool.setting.Setting;
+import com.njcn.common.pojo.exception.BusinessException;
+import com.njcn.system.enums.SystemResponseEnum;
+import com.njcn.system.timer.TimerExeService;
+import com.njcn.system.timer.TimerTaskRunner;
+import org.springframework.stereotype.Service;
+
+/**
+ * hutool方式的定时任务执行
+ *
+ * @author hongawen
+ */
+@Service
+public class HutoolTimerExeServiceImpl implements TimerExeService {
+
+    private static final Log log = Log.get();
+
+    @Override
+    public void startTimer(String taskId, String cron, String className) {
+
+        if (ObjectUtil.hasEmpty(taskId, cron, className)) {
+            throw new BusinessException(SystemResponseEnum.EXE_EMPTY_PARAM);
+        }
+
+        // 预加载类看是否存在此定时任务类
+        try {
+            Class.forName(className);
+        } catch (ClassNotFoundException e) {
+            throw new BusinessException(SystemResponseEnum.TIMER_NOT_EXISTED);
+        }
+
+        // 定义hutool的任务
+        Task task = () -> {
+            try {
+                TimerTaskRunner timerTaskRunner = (TimerTaskRunner) SpringUtil.getBean(Class.forName(className));
+                timerTaskRunner.action();
+            } catch (ClassNotFoundException e) {
+                log.error(">>> 任务执行异常：{}", e.getMessage());
+            }
+        };
+
+        // 开始执行任务
+        CronUtil.schedule(taskId, cron, task);
+    }
+
+    @Override
+    public void stopTimer(String taskId) {
+        CronUtil.remove(taskId);
+    }
+
+}

pqs-system/system-boot/src/main/java/com/njcn/system/timer/tasks/DemoTaskRunner.java

@@ -0,0 +1,28 @@
+
+package com.njcn.system.timer.tasks;
+
+import com.njcn.system.timer.TimerTaskRunner;
+import org.springframework.stereotype.Component;
+
+
+/**
+ * 定时同步用户数据
+ *
+ * @author hongawen
+ * @date 2020/6/30 22:09
+ */
+@Component
+public class DemoTaskRunner implements TimerTaskRunner {
+
+
+
+
+    @Override
+    public void action() {
+
+        //定时同步用户数据
+        System.out.println("定时输出一段文字");
+
+    }
+
+}